Counterparties

A counterparty is a Buyer or Supplier in Finexio. This can be an individual or a business. You can only create Supplier counterparties using the API.

Field	Description
id	Unique identifier for the counterparty.	This field will be created by Finexio when a counterparty is created.
name	Name of the counterparty.	required type: string max length = 100
type	Type of counterparty: Buyer or Supplier. NOTE: Only a type of Supplier is allowed when creating a new counterparty using the API. Buyers are created by Finexio.	required type: string Acceptable value: 'Supplier'
address_1	Primary remittance address of the counterparty.	required only if payment_method=PrintedCheck type: string max length = 40
address_2	Secondary remittance address of the counterparty.	optional type: string max length = 40
city	Counterparty's city.	required only if payment_method=PrintedCheck type: string max length = 40
state	Counterparty's state. Two letter state abbreviation. Acceptable values: l or a business. You can only create Supplier counterparties using the API.	required only if payment_method=PrintedCheck type: string length = 2
zipcode	Counterparty's zip code.	required only if payment_method=PrintedCheck type: string max length = 10
country	Counterparty's country.	required only if payment_method=PrintedCheck type: string Acceptable values: business. You can only . Default USA if no value specified.
primary_contact_email	Email address of the primary contact person representing the counterparty.	type: string max length = 50
remit_email	Email address to be used for remit notifications.	required if payment_method=Card/ACH type: string max length = 50
primary_contact_name	Name of primary contact person.	optional type: string max length = 40
primary_contact_phone	Phone of primary contact person.	optional type: string max length = 16 accepts only numbers
bank_account_number	Bank account number of counterparty.	required when payment_method is ACH or Wire type: string max length = 17
bank_routing_number	Bank routing number of counterparty.	required when payment_method is ACH or Wire type: string max length = 9
payment_method	The method used to make payments to the Supplier.	type: string values: ACH, Card, PrintedCheck, and Wire.
internal_id	Secondary identifier for this counterparty This value must be unique for each counterparty type. Valid characters for this field are: using the API.	required type: string max length = 100 Square brackets not allowed. For example ess. You can o is not valid.
payment_terms	The agreed upon timing of the payment with your supplier. Represents number of days.	optional type: integer Allowed values: min = 0, max = 365
tax_id	The supplier's tax id number.	optional type: string max length = 11
ineligible_for_conversion	Supplier conversion eligibility determines if Finexio SHOULD NOT reach out to this supplier due to high sensitivity or special payment arrangements or contracted terms.	type: boolean
twelve_month_payment_count	The 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: decimal
business_type	Indicates the business type of the counterparties.	required type: string values: 'Employee', 'Business', 'Individual', 'InternalTransfer', 'Student', 'BankingInstitution', 'Insurance', 'Government', 'Unknown'
notes	Any additional information Finexio should know about this supplier.	optional type: string max length = 1000
remit_data	Remit data for buyer.	optional type: string max length = 70
created	Date the Counterparty was created.	read-only type: timestamp (ISO-8601)
updated	Date the Counterparty was last updated.	read-only type: timestamp (ISO-8601)