Suppliers can be managed via the /counterparties/suppliers endpoint.
| Field | Description | |
|---|---|---|
| id | Unique identifier for the supplier. | This field will be created by Finexio when a supplier is created. Read-only. |
| name | Name of the supplier. | required type: string max length = 100 |
| care_of | This will be used in mailing address of checks in lieu of the company name. | optional type: string max length = 36 |
| remit_address_1 | Primary remittance address of the supplier. | required only if payment_method=Check type: string max length = 40 |
| remit_address_2 | Secondary remittance address of the supplier. | optional type: string max length = 40 |
| remit_city | Remit city of the supplier. | required only if payment_method=Check type: string max length = 40 |
| remit_state | Remit state of the supplier. 2 letter state abbreviation. | required only if payment_method=Check type: string Acceptable values: [ 'AL', 'AK', 'AS', 'AZ', 'AR', 'AA', 'AE', 'AP', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'GU', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'MP', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VI', 'VA', 'WA', 'WV', 'WI', 'WY', 'AB', 'BC', 'MB', 'NB', 'NL', 'NT', 'NS', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT' ] |
| remit_zipcode | Remit zipcode of the supplier. | required only if payment_method=Check type: string max length = 10 |
| remit_country | Remit country of the supplier. | required only if payment_method=Check type: string Acceptable values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value is specified. |
| corporate_address_1 | Primary corporate address of the supplier. | optional type: string max length = 40 |
| corporate_address_2 | Secondary corporate address of the supplier. | optional type: string max length = 40 |
| corporate_city | Corporate city of the supplier. | optional type: string max length = 40 |
| corporate_state | Corporate state of the supplier. 2 letter state abbreviation. | optional type: string Acceptable values: [ 'AL', 'AK', 'AS', 'AZ', 'AR', 'AA', 'AE', 'AP', 'CA', 'CO', 'CT', 'DE', 'DC', 'FL', 'GA', 'GU', 'HI', 'ID', 'IL', 'IN', 'IA', 'KS', 'KY', 'LA', 'ME', 'MD', 'MA', 'MI', 'MN', 'MS', 'MO', 'MT', 'NE', 'NV', 'NH', 'NJ', 'NM', 'NY', 'NC', 'ND', 'MP', 'OH', 'OK', 'OR', 'PA', 'PR', 'RI', 'SC', 'SD', 'TN', 'TX', 'UT', 'VT', 'VI', 'VA', 'WA', 'WV', 'WI', 'WY', 'AB', 'BC', 'MB', 'NB', 'NL', 'NT', 'NS', 'NU', 'ON', 'PE', 'QC', 'SK', 'YT' ] |
| corporate_zipcode | Corporate zipcode of the supplier. | optional type: string max length = 10 |
| corporate_country | Corporate country of the supplier. | optional type: string Acceptable values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value is specified. |
| corporate_phone_number | Corporate phone number of the supplier. | optional type: string max length = 16 |
| external_reference_id | A secondary identifier for this supplier. This value must be unique. Valid characters for this field are [ _-. 0123456789ABCDEFGHIJKL MNOPQRSTUVWXYZabcdefghijkl mnopqrstuvwxyz ] | required type: string max length = 200 Square brackets are not allowed. For example [supplier_123] is not valid. |
| tax_id | The supplier's tax id number. | optional type: string max length = 11 |
| contacts | Supplier's contact list. | optional type: array |
| remit_email | This is the email address to which card payments or eCheck payments will be sent. | required if payment_method is Card/Check and delivery_method is Email. type: string Can be multi-valued. |
| bank_account_number | Bank account number of the supplier. It can't contain non-numeric characters. | required if payment_method is ACH/Wire/FinexioExpress type: string max length = 17 |
| bank_routing_number | Bank routing number of the supplier. | required if payment_method is ACH/Wire/FinexioExpress type: string max length = 9 |
| payment_method | This is how the payment will be made to the Supplier. | required type: string Acceptable values: [ 'ACH', 'Card', 'Check', 'Wire', 'FinexioExpress']. |
| processing_fee | Reflects the processing fee of payments made to that supplier. This applies to FinexioExpress suppliers only. | Read-only Can be between 0 and 1, with 4 decimals. For example, 0.0115 for 1.15%. |
| delivery_method | Reflects the delivery method used for the payments made to the supplier. It defaults to null if payment_method is ACH/Wire. If payment_method is set to Card it defaults to Email if a value other than Email, Portal, and Phone is provided. | required only if payment_method is other than ACH and Wire type: string Acceptable values: [ 'Mail', 'Email', 'Phone', 'Portal']. |
| notification_method | Reflects how ACH and Wire suppliers are notified of a payment. When set to Email, the supplier will receive a remittance email for any ACH and Wire payment that is sent. | optional type: string Acceptable values: ['Email']. |
| 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 |
| 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. | optional type: boolean default: false |
| ineligible_for_cbm | Indicates if the supplier is ineligible to receive payments using Card by Mail. If true the supplier will not be offered the Card by Mail program. Defaults to false if not passed. | optional type: boolean default: false |
| payee_type | Reflects the supplier type. | optional type: string Acceptable values: [ 'Employee', 'Business', 'Individual', 'InternalTransfer', 'Student', 'BankingInstitution', 'Insurance', 'Government', 'Unknown' ] |
| 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: integer |
| notes | Any additional information Finexio should know about this supplier? | optional type: string max length = 1000 |
| metadata | An array of name/value pairs. The name can be any character string not beginning with _ with a max length of 25 characters, The value can have a max length of 100 chars and can be null. | optional type: string |
| internal_payments | Payments will be made by Finexio staff using the Phone or Portal delivery method. | optional type: boolean default: false |
| created | Date the Supplier was created on. | read-only type: timestamp (ISO-8601) |
| updated | Date the Supplier was created on. | read-only type: timestamp (ISO-8601) |
Suppliers' contacts can be provided in the initial payload that is used to create the Supplier itself.
They can then be managed via /counterparties/suppliers/supplier_id/contacts. Operations that are available via this endpoint are GET, POST, PUT, PATCH, and DELETE.
| Field | Description | Details |
|---|---|---|
| id | Internal id of the contact. This is generated by Finexio. | |
| external_reference_id | External reference id of the contact. | Optional Type: String Max length = 100 |
| name | Name of the contact. | Optional Type: String Max length = 40 |
| Email of the contact. | Optional Type: String Max length = 50 | |
| phone | Phone number of the contact. | Optional Type: String Max length = 17 |
| primary | Indicates that the contact is the primary one. There can only be one primary contact for a given Supplier. When a contact gets its primary flag updated to true, the current primary contact will automatically get its flagged set to false. When creating or updating a Supplier with multiple contacts in the payload, if multiple contacts are provided with a primary flag set to true, the following error will be returned: "Only one contact can be set as primary.". | Mandatory Type: Boolean |
| payment_notification | Indicates whether notifications of payments need to be sent using the email value. | Optional Type: Boolean False by default |