A counterparty is a Buyer or a Supplier in Finexio system. This can be an individual or a business. Only Type = Supplier can be created on the API.

FieldDescription
idUnique identifier for the counterparty.This field will be created by Finexio when counterparty created.
nameName of the counterparty.required
type: string
max length = 40
typeType of counterparty: Buyer or Supplier. NOTE: Only supplier type is allowed in case of creating a new counterparty on API. Finexio will enter Buyers. into the system.required
type: string
Acceptable values 'buyer', 'supplier'
address_1Primary remittance address of the counterparty.required
type: string
max length = 40
address_2Secondary remittance address of the counterparty.optional
type: string
max length = 40
cityCity of the counterparty.required
type: string
max length = 40
stateState of the counterparty. 2 letter state abbreviation.required
type: string
length = 2
zipcodeZipcode of the counterparty.required
type: string
max length = 10
countryCountry of the counterparty.required
type: string
accepts values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value specified.
primary_contact_emailEmail of primary contact person representing the counterparty.optional
type: string
max length = 50
remit_emailEmail to be used for remit notifications.optional
type: string
max length = 50
primary_contact_nameName of primary contact person.optional
type: string
max length = 40
primary_contact_phonePhone of primary contact person.optional
type: string
max length = 16
bank_account_numberBank account number of counterparty.optional
type: string
max length = 17
bank_routing_numberBank routing number of counterparty.optional
type: string
max length = 9
payment_methodThis is how the payment will be made to the Supplier.type: string
values: ACH, Card, PrintedCheck, and Wire.
internal_idSecondary identifier for this counterparty This value must be unique for counterparty type.required
type: string
payment_termsThe agreed upon timing of the payment with your supplier. Represents No. of days.optional
type: integer
Allowed values: min = 0, max = 365
tax_idThe supplier's tax id number.optional
type: string
max length = 12
ineligible_for_conversionSupplier conversion eligibility determines if Finexio SHOULD NOT reach out to this supplier due to high sensitivity or special payment arrangements
or contracted terms.
"false" (Can Contact) or "true" (Do Not Contact)
type: boolean
values: true/false
twelve_month_payment_countThe total number of times the buyer (property) sent a payment to the supplier within the last 12 months.optional
type: integer
*twelve_month_spend**The total spend amount the buyer (property) has paid to this particular supplier within the last 12 months.optional
type: number
business_typeIndicates the business type of the counterparties; and
identifies if a supplier is an Individual, Employee, or Business.
required
type: string
values: 'Employee', 'Business', 'Individual'
notesAny additional information Finexio should know about this supplier.optional
type: string
max length = 1000