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
Field | Sub-field | Type | Description | Additional Information |
---|---|---|---|---|
totalRecords | Integer | Total number of records available | ||
totalType | String | Whether the records returned are an exact or in range | ||
acl | Array | access control list for the buyer supplier association | ||
recordCount | Number of records fetched | |||
records | Array of objects | Details of the records fetched | ||
id | string | Id of the buyer supplier association | ||
buyerId | string | ID of buyer assigned by CPX | ||
supplierID | string | ID of supplier assigned by CPX | ||
sid | string | Unique buyer supplier association identifier | ||
paymentType | Object | Details of default payment type set for buyer supplier association | ||
id | Enum | The id of the payment type to be set as the default payment type for the buyer supplier association
| ||
lodgePaymentCardId | String | Id of the lodge card product to be used as the default when paymentType is Lodge Payment or Lodged / Exact Match Payment | ||
cardRuleId | String | Id of the card product to be used as the default when paymentType is V Card | ||
isSupplierEnablement | Boolean | Whther supplier enablement has to be turned on for the supplier. | ||
buyer | id | String | ID of buyer assigned by CPX | |
name | String | Name of thebuyer | ||
supplier | id | String | ID of supplier assigned by CPX | |
name | String | Name of the supplier | ||
paymentType | id | String | Id of Payment type | |
type | String | Payment method type | ||
createdNotificationSent | String | Date and time when the notification was sent to the supplier | ||
deleted | Boolean | Whether the association is deleted | ||
disabled | Boolean | Whether the association is disabled | ||
created | string | Date and time of creation of Buyer Supplier association | ||
creator | id | string | Id of user creating the buyer Supplier association | |
username | string | Username of user creating the Buyer Supplier association | ||
modified | string | Date and time of last modification of Buyer Supplier association | ||
modifier | id | string | Id of user who has last modified the buyer Supplier association | |
username | string | Username 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
Updated 3 days ago