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. |
name | Name of the supplier (Business Legal Name) | required |
care_of | This will be used in mailing address of checks in lieu of the company name. | optional |
remit_address_1 | Primary remittance address of the supplier. | required only if payment_method=Check |
remit_address_2 | Secondary remittance address of the supplier. | optional |
remit_city | Remit city of the supplier. | required only if payment_method=Check |
remit_state | Remit state of the supplier. 2 letter state abbreviation. | required only if payment_method=Check |
remit_zipcode | Remit zipcode of the supplier. | required only if payment_method=Check |
remit_country | Remit country of the supplier. | required only if payment_method=Check |
corporate_address_1 | Primary corporate address of the supplier. | optional |
corporate_address_2 | Secondary corporate address of the supplier. | optional |
corporate_city | Corporate city of the supplier. | optional |
corporate_state | Corporate state of the supplier. 2 letter state abbreviation. | optional |
corporate_zipcode | Corporate zipcode of the supplier. | optional |
corporate_country | Corporate country of the supplier. | optional |
corporate_phone_number | Corporate phone number of the supplier. | optional |
external_reference_id | A secondary identifier for this supplier. | required |
tax_id | The supplier's tax id number. | optional |
contacts | Supplier's contact list. | optional |
remit_email | This is the email address to which card payments or eCheck payments will be sent. | required if payment_method is |
bank_account_number | Bank account number of the supplier. | required if payment_method is |
bank_routing_number | Bank routing number of the supplier. | required if payment_method is |
payment_method | This is how the payment will be made to the Supplier. | required |
processing_fee | Reflects the processing fee of payments made to that supplier. This applies to FinexioExpress suppliers only. | Read-only |
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 |
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 |
payment_terms | The agreed-upon timing of the payment with your supplier. Represents No. of days. | optional |
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 |
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 |
payee_type | Reflects the supplier type. | optional |
twelve_month_payment_count | The total number of times the buyer (property) sent a payment to the supplier within the last 12 months. | optional |
twelve_month_spend | The total spend amount the buyer (property) has paid to this particular supplier within the last 12 months. | optional |
notes | Any additional information Finexio should know about this supplier? | optional |
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 |
internal_payments | Payments will be made by Finexio staff using the Phone or Portal delivery method. | optional |
created | Date the Supplier was created on. | read-only |
updated | Date the Supplier was created on. | read-only |
category | Category name for supplier. Must be a valid category from the list of available categories. | optional |
sub_category | Subcategory name for supplier. Must be a valid subcategory from the list of available subcategories, available subcategories depend on the provided category value. | optional |
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 |
name | Name of the contact. | Optional |
Email of the contact. | Optional | |
phone | Phone number of the contact. | Optional |
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. | Mandatory |
payment_notification | Indicates whether notifications of payments need to be sent using the email value. | Optional |