Get Supplier Detail

get https://api.finexio-stage.com/v2/counterparties/suppliers/{id}/

Get Information Of A Single Supplier

Individual Suppliers can be retrieved using the Suppliers endpoint with a GET operation, using their id: /counterparties/suppliers/id

Example Response

{
    "id": "689cedfc-6711-4020-ba69-91fa2c1f614c",
    "name": "Dev Supplier 1X",
    "care_of": null,
    "remit_address_1": "Dev address 1",
    "remit_address_2": "",
    "remit_city": "Dev city",
    "remit_state": "IL",
    "remit_zipcode": "01111",
    "remit_country": "USA",
    "corporate_address_1": "Dev address 1",
    "corporate_address_2": "",
    "corporate_city": "Dev city",
    "corporate_state": "IL",
    "corporate_zipcode": "01111",
    "corporate_country": "USA",
    "corporate_phone_number": "",
    "external_reference_id": "UPDATED ID DEV",
    "tax_id": "",
    "contacts": [
        {
            "payment_notification": false,
            "id": null,
            "external_reference_id": null,
            "name": "Dev Contact",
            "email": "test@finexio.com",
            "phone": "000111110",
            "primary": true
        }
    ],
    "remit_email": "test@finexio.com",
    "bank_account_number": null,
    "bank_routing_number": null,
    "payment_method": "Check",
    "delivery_method": "Mail",
    "notification_method": null,
    "created": "2024-04-24T16:09:05.030000",
    "updated": "2024-04-24T16:13:34.909000",
    "payment_terms": 10,
    "ineligible_for_conversion": false,
    "payee_type": null,
    "twelve_month_payment_count": null,
    "twelve_month_spend": null,
    "notes": null,
    "metadata": null,
    "enabled": true,
    "processing_fee": 0,
    "internal_payments": false
}

Responses

Response body

object

string

name

string

length ≤ 100

max length = 100

care_of

string

length ≤ 36

max length = 36

remit_address_1

string

length ≤ 40

max length = 40
required only if payment_method is 'Check'

remit_address_2

string

length ≤ 40

max length = 40

remit_city

string

length ≤ 40

max length = 40
required only if payment_method is 'Check'

remit_state

string

length ≤ 2

accepts one of these 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' ].
required only if payment_method is 'Check'

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

string

length ≤ 10

max length = 10
required only if payment_method is 'Check'

remit_country

string

Defaults to USA

accepts one of these values: [ 'CAN', 'UMI', 'USA' ].
required only if payment_method is 'Check'

CAN UMI USA

corporate_address_1

string

length ≤ 40

max length = 40

corporate_address_2

string

length ≤ 40

max length = 40

corporate_city

string

length ≤ 40

max length = 40

corporate_state

string

length ≤ 2

corporate_zipcode

string

length ≤ 10

max length = 10

corporate_country

string

Defaults to USA

accepts one of these values: [ 'CAN', 'UMI', 'USA' ]. Default USA if no value specified.

CAN UMI USA

corporate_phone_number

string

length ≤ 16

max length = 16

external_reference_id

string

length ≤ 200

max length = 200. Secondary identifier. This value must be unique.

tax_id

string

length ≤ 11

max length = 11

contacts

array of objects

contacts

object

string

This will be generated by Finexio.

external_reference_id

string

length ≤ 100

max length = 100
This value must be unique.

name

string

length ≤ 40

max length = 40

string

length ≤ 50

max length = 50

phone

string

length ≤ 17

max length = 17

primary

boolean

required

Indicates whether the contact is the primary contact.

payment_notification

boolean

Defaults to false

Indicates whether notifications of payments need to be sent using the email value.

remit_email

string

required only if payment_method is 'Card' and delivery_method is 'Email'.

bank_account_number

string

length ≤ 17

max length = 17
required only if payment_method is 'ACH' or 'Wire' or 'FinexioExpress'.
It can't contain non-numeric characters.

bank_routing_number

string

length ≤ 9

max length = 9
required only if payment_method is 'ACH' or 'Wire' or 'FinexioExpress'.

payment_method

string

accepts one of these values: [ 'ACH', 'Card', 'Check','Wire' ].

ACH Card Check Wire

delivery_method

string

accepts one of these values: [ 'Mail', 'Email', 'Portal','Phone' ] and can be null.
Required only if payment_method is other than ACH and Wire.

notification_method

string

accepts one of these values: [ 'Mail', 'Email' ].

Mail Email

created

date-time

updated

date-time

payment_terms

integer

Allowed values: min = 0, max = 365. Payment terms is optional field. This is an integer field and represents No. of days.

ineligible_for_conversion

boolean

Defaults to false

Supplier conversion eligibility determines if Finexio SHOULD NOT reach out to this supplier due to high sensitivity or special payment arrangements or contracted terms.

ineligible_for_cbm

boolean

Defaults to false

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.

payee_type

string

Accepts one of these values: [ 'Employee', 'Business', 'Individual', 'InternalTransfer', 'Student', 'BankingInstitution', 'Insurance', 'Government', 'Unknown' ]

Employee Business Individual InternalTransfer Student BankingInstitution Insurance Government Unknown

twelve_month_payment_count

integer

This is related to spend data and indicates the number of payments made to that supplier over the last 12 months.

twelve_month_spend

integer

This is related to spend data and indicates the total dollar amount paid to that supplier over the last 12 months.

notes

string

length ≤ 1000

max length = 1000
Optional information about supplier.

metadata

object

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.

Has additional fields

enabled

boolean

Defaults to true

For internal use only. Defaults to true if not passed. If passed, you should always set it to true.

internal_payments

boolean

Defaults to false

Payments will be made by Finexio staff using the Phone or Portal delivery method.

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.finexio-stage.com/v2/counterparties/suppliers/id/ \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Example Response

200Success

400Bad Request

404Not Found