13. Supplier

9.1 Overview

A supplier refers to an organization that is owed payment by a buyer, and the buyer can independently bring on board a supplier. However, if the buyer desires a greater rebate and seeks assistance in transitioning the supplier to a payment method that would be more advantageous, the supplier's information is shared with the supplier enablement team.

9.2 Attributes

Fields	Sub Fields	Type	Description	Additional Information
id		String	Id of the supplier
acl		Array	access control list for the supplier
name		string	Name of the Supplier
address	street1	string	street address of the Supplier
	street2	string	street address of the Supplier
	city	string	City of the Supplier
	state	string	State of the Supplier
	country	string	Country of the Supplier
	postalCode	string	Postal Code of the Supplier
mcc	code	int	Merchant country code
	description	string	Name of the Mcc
Status		String	Internal Status of the Supplier	Approved Awaiting KYC KYC Failed Canceled Closed Declined Received Suspended Under Review
externalStatus		string	External Status of the Supplier	Active Inactive
payeeType		String	Type of the Supplier. It can be of two types 1. Supplier2. Consumer
contacts	primary	boolean	to set a contact as primary
	name	string	Name of the contact
	title	string	Position of the contact in the respective organisation
	email	string	Email of the Contact
	phone	int	Phone Number of the Contact
addedRelationshipBuyerIds	id	string	Internal id of the buyer to which supplier is associated
	sid	string	the unique id between a respected buyer and a supplier
isSupplierEnablement		boolean	Is supplier enabled to be contacted for virtual card program
aceeptsCheck		boolean	Enable Supplier to accept Check Payment
acceptsCard		boolean	Enable Supplier to accept VCN Payment
requiresLodged		boolean	Enable Supplier to accept LDG Payment
acceptsACH		boolean	Enable Supplier to accept ACH Payment
acceptsWire		boolean	Enable Supplier to accept Wire Payment
merchantId		string	Merchant ID associated with the supplier
variance	type	string	Increases payment amount as per the value set (Only for lodge payment)
	amount		Amount of variance
paymentTypes	id type enabled payableToaddress street1 street2 city state county postalCode additionalPayable To payableToLine3	id: String type : string enabled : boolean payable to : string street 1 : string city : string state : string country : string postalCode : string additionalPayableTo : string payableToLine3 : string	id: Check Issuing type : Check enabled : to enable or disable the payment method payableTo : the name of the entity on which the check will be issued street1 : street1 of the entity where the check needs to be delivered city : city of the entity where the check needs to be delivered state : state of the entity where the check needs to be delivered country : country of the entity where the check needs to be delivered postalCode : postalCode of the entity where the check needs to be delivered Additional Payable To fields are only applicable for EFG additionalPayable payableToLine3	type: Direct V Card ACH ACH+ Dynamic Discounting Check Issuing Prepaid Debit Virtual Wallet Payment Thresholds Dollar Splits Fax
	id type enabledbankAccountNumber routingNumber accountType address street1 street2 city state county postalCode phone	id: String type : string enabled : boolean bankAccountNumber: string routingNumber : string accounType : string street 1 : string city : string state : string country : string postalCode : string phone: string	id: Wire type : Wire enabled : to enable or disable the payment method bankAccountNumber- The account to which wire is to be transferred routingNumber- The routing number of account to which wire is to be transferred accountType : Type of account street1 : street1 of the supplier street2 : street2 of the supplier city : city of the supplier state : state of the supplier country : country of the supplier postalCode : postalCode of the supplier Phone : Phone number of supplier	Direct V Card ACH ACH+ Dynamic Discounting Check Issuing Prepaid Debit Virtual Wallet Payment Thresholds Dollar Splits Fax
	type id enabled deliveryMethod emails fax proxyPayment requirePin noNotification	type : string id : string enabled : boolean deliveryMethod : string emails : string fax : string proxyPayment : boolean requirePin : boolean noNotification : boolean	type : V Card it determines the payment method which the user accepts id : V Card it determines the payment method which the user accept enabled : to enable or disabled the payment method deliveryMethod :Email how supplier want to receive the card emails : email id of the supplier on which it wants to receive the card fax : fax number of the supplier on which it wants to receive the card proxyPayment : provides a false email in the email textbox requirePin : if the user needs to enter a PIN when opening a card noNotification : Determines whether the user wants to receive the email w.r.t. card information or not.	delivery method : Email Fax
	id type enabledroutingNumber bankAccountNumber accountType	type : id type : string enabled : boolean routingNumber : string bankAccountNumber : string accountType : String	id : ACH type : ACH enabled : to enable or disable the payment method routingNumber : supplier bank routing number bankAccountNumber : account number of supplier’s bank accountType : type of the supplier’s bank account i.e. checking or savings
	id type enabled routingNumberbank AccountNumber accountType discountRate flatFee netFees	type : string enabled : boolean routingNumber : string bankAccountNumber : string accountType : String discountRate : String flatFee : integer netFees : boolean	Id : ACH+ type : ACH+ enabled : to enable or disable the payment method routingNumber : supplier bank routing number bankAccountNumber : account number of supplier’s bank accountType : type of the supplier’s bank account i.e. checking or savings discountRate : to determine how much fees CPX will be charging from the supplier flatFee : to determine how much fees CPX will be charging from the supplier netFees : to determine how the fees will be taken from the supplier
	id type enabled	id: string type : string enabled : boolean	id : Direct type : Direct enabled : to enable or disable the payment method	Must be passed along with merchantID node
	id type Enabled routingNumber bankAccountNumber accountType discountRatelowTermDays highTermDays netFees	type : string enabled :boolean routingNumber : string bankAccountNumber : string accountType : String discountRate: String lowTermDays : integer highTermDays : integer netFees : boolean	id : Dynamic Discounting type : Dynamic Discounting enabled : to enable or disable the payment method routingNumber : supplier bank routing number bankAccountNumber : account number of supplier’s bank accountType : type of the supplier’s bank account i.e. checking or savings discountRate : to determine how much fees CPX will be charging from the supplier lowTermDays : the number of days from the invoice date to which a supplier will be charged with maximum amount of fees for using this payment method highTermDays : the number of days from invoice date to which a supplier will be charged with least amount of fees for using this payment method netFees : to determine how the fees will be taken from the supplier	low term days : min - 0 max - 90 high term days : min - 0 max - 90
	id type enabled dollarsSplits id threshold	id : string (enum) type : string (enum) enabled : boolean id : string threshold :	id : Dollar Splits type : Dollar Splits to split the payments once it has reached a threshold provided by the buyer enabled : to enabled or disable the payment method id: to specify payment method to be used above a certain threshold limit for a payment Threshold : amount limit for the payment method for the supplier	id : CHK ACH VCN
	id type enabled thresholds id threshold paymentType	id: string type : string enabled : boolean id : string threshold : paymentType : string	id : Payment Thresholds type : Payment Thresholds enabled : to enable or disable the payment method	paymentType: V card ACH ACH+ Check Dynamic Discounting
	id type enabled prepaidDebitBalance	id : string type : string enabled : boolean	id : Prepaid Debit type : Prepaid Debit enabled : to enable or disable the payment method
	id type enabled	id : string type : string enabled : boolean	id : Virtual Wallet type : Virtual Wallet enabled : to enable or disable the payment method
expirePreAuths		Boolean	Pre auth on the card are expired automatically
achRemittanceEmails		object	Multiple Email ids that should receive ACH remittance email
	enabled	boolean	Whether ACH remittance emails has been enabled
	emails	string	Email ids to which email has to be sent
checkRemittanceEmails		object	Multiple Email ids that should receive Check remittance email
	enabled	boolean	Whether check remittance emails has been enabled
	emails	string	Email ids to which email has to be sent
sid
	id	String	Id of the SID
	name	String	Name/SID value
created		string	Date and time of creation of Supplier
creator	id	string	Id of user creating the supplier
	username	string	Username of user creating the supplier
modified		string	Date and time of last modification of supplier
modifier	id	string	Id of user who has last modified the supplier
	username	string	Username of user who has last modified the supplier
deleted			Whether supplier is deleted or not
allowPinReset			Allow user to reset PIN
hasPin			Has PIN been set for supplier
totalRecords		Integer	Total number of records available
totalType		String	Whether the records returned are an exact or in range
recordCount			Number of records fetched
records		Array of objects	Details of the records fetched
fileInfo		Object
	fileId	string	Id of the file uploaded to CPX
	fileName	string	Name of the file uploaded to CPX
newSupplierData		Object	Data of suppliers created via CSV file
	id	string	Id of the supplier getting created
	sid	string	SID of the supplier getting created
updatedSupplierData		Object	Data of suppliers updated via CSV file
	id	string	Id of the supplier getting updated
	sid	string	SID of the supplier getting updated
newPayees		Integer	number of suppliers getting created
updatedPayees		Integer	number of suppliers getting updated
pin		Integer	Pin set for the supplier
cpa		object	CPA sync node to capture information from CPA
	id	string	Id of supplier on CPA
	syncError	string	Sync error if any

9.3 Statuses

Internal Status
Received Under Review Closed Approved Declined Canceled Suspended

External Status
Active Inactive

9.4 Operations

9.4.1. Create Supplier
9.4.2. Update Supplier
9.4.3. Retrieve Supplier By Id
9.4.4. Retrieve Supplier for Export
9.4.5. Retrieve Supplier by Custom Field
9.4.6. Retrieve Supplier Autocomplete
9.4.8. Delete Supplier
9.4.9. Create Suppliers from CSV
9.4.10. Read Suppliers from CSV
9.4.11. Send PIN for Suppliers
9.4.12. Resend PIN for Suppliers
9.4.13. Update PIN for Suppliers