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.
| Field | Description | |
|---|---|---|
| id | Unique identifier for the counterparty. | This field will be created by Finexio when counterparty created. |
| name | Name of the counterparty. | required type: string max length = 40 |
| type | Type 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_1 | Primary remittance address of the counterparty. | required type: string max length = 40 |
| address_2 | Secondary remittance address of the counterparty. | optional type: string max length = 40 |
| city | City of the counterparty. | required type: string max length = 40 |
| state | State of the counterparty. 2 letter state abbreviation. | required type: string length = 2 |
| zipcode | Zipcode of the counterparty. | required type: string max length = 10 |
| country | Country of the counterparty. | required type: string accepts values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value specified. |
| primary_contact_email | Email of primary contact person representing the counterparty. | optional type: string max length = 50 |
| remit_email | Email to be used for remit notifications. | optional 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 |
| bank_account_number | Bank account number of counterparty. | optional type: string max length = 17 |
| bank_routing_number | Bank routing number of counterparty. | optional type: string max length = 9 |
| payment_method | This is how the payment will be made to the Supplier. | type: string values: ACH, Card, PrintedCheck, and Wire. |
| internal_id | Secondary identifier for this counterparty This value must be unique for counterparty type. | required type: string |
| payment_terms | The agreed upon timing of the payment with your supplier. Represents No. of days. | optional type: integer Allowed values: min = 0, max = 365 |
| tax_id | The supplier's tax id number. | optional type: string max length = 12 |
| 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. "false" (Can Contact) or "true" (Do Not Contact) | type: boolean values: true/false |
| 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: number |
| business_type | Indicates the business type of the counterparties; and identifies if a supplier is an Individual, Employee, or Business. | required type: string values: 'Employee', 'Business', 'Individual' |
| notes | Any additional information Finexio should know about this supplier. | optional type: string max length = 1000 |