7. Buyer Supplier Association

6.1 Overview

A buyer supplier association is a relation between the buyer and supplier to signify that the buyer can process payments to the supplier.
A buyer can be linked to many suppliers and each supplier can be linked to multiple buyers. A buyer may or may not be linked to any supplier at the time of creation but the supplier should be linked to at least one buyer at the time of creation.

6.2 Attributes

FieldSub-fieldTypeDescriptionAdditional Information
totalRecordsIntegerTotal number of records available
totalTypeStringWhether the records returned are an exact or in range
aclArrayaccess control list for the buyer supplier association
recordCountNumber of records fetched
recordsArray of objectsDetails of the records fetched
idstringId of the buyer supplier association
buyerIdstringID of buyer assigned by CPX
supplierIDstringID of supplier assigned by CPX
sidstringUnique buyer supplier association identifier
paymentTypeObjectDetails of default payment type set for buyer supplier association
idEnumThe id of  the payment type to be set as the default payment type for the buyer supplier association
  • V Card
  • ACH
  • Check Issuing
  • Managed Check
  • Lodge Payment
  • Lodged / Exact Match Payment
lodgePaymentCardIdStringId of the lodge card product to be used as the default when paymentType is Lodge Payment or Lodged / Exact Match Payment
cardRuleIdStringId of the card product to be used as the default when paymentType is V Card
isSupplierEnablementBooleanWhther supplier enablement has to be turned on for the supplier. 
buyeridStringID of buyer assigned by CPX
nameStringName of thebuyer 
supplieridStringID of supplier assigned by CPX
nameStringName of the supplier 
paymentTypeidStringId of Payment  type
typeStringPayment method type
createdNotificationSentStringDate and time when the notification was sent to the supplier
deletedBooleanWhether the association is deleted
disabledBooleanWhether the association is disabled
createdstringDate and time of creation of Buyer Supplier association
creatoridstringId of user creating the buyer Supplier association
usernamestringUsername of user creating the Buyer Supplier association
modifiedstringDate and time of last modification of Buyer Supplier association
modifieridstringId of user who has last modified the buyer Supplier association
usernamestringUsername of user who has last modified the buyer Supplier association

6.3 Operations

6.3.1. Create Buyer Supplier Association
6.3.2. Update Buyer Supplier Association
6.3.3. Retrieve Buyer Supplier Associations by Custom Fields
6.3.4. Retrieve Buyer Supplier Associations For Export
6.3.5. Delete Buyer Supplier Associations


Priority Technology Holdings Logo