API Reference
Start typing to search…

Update Supplier

put https://api.finexio-stage.com/v2/counterparties/suppliers//

Update An Existing Supplier

Log in to see full request history

Suppliers can be updated via a PUT operation through the Suppliers endpoint, using the buyer id: /counterparties/suppliers/id

For a full definition of the Supplier object and its attributes, please refer to this page. Mandatory attributes will also be indicated.

Example Request

{
    "name": "Dev Supplier 2",
    "care_of": "null2",
    "remit_address_1": "sdsf",
    "remit_city": "test_remit_city",
    "remit_state": "CA",
    "remit_zipcode": "test_",
    "remit_country": "USA",
    "corporate_address_1": "test_corp_ad_1",
    "corporate_address_2": "test_corp_ad_2",
    "corporate_city": "test_corp_cty",
    "corporate_state": "TX",
    "corporate_zipcode": "test",
    "corporate_country": "USA",
    "corporate_phone_number": "test_corp_ph",
    "external_reference_id": "DEVSUPPLIER-77",
    "tax_id": "333-44-88",
    "contacts": [
        {
            "contact_id": "b4bca3da-7bd0-4d9b-ae29-d3094972a093",
            "reference_id": "asdf",
            "contact_name": "aboutf aboutl",
            "contact_email": "about@gmail.com",
            "contact_phone": "333-333-4444",
            "primary": true,
            "payment_notfication": true
        },
        {
            "contact_id": "33331238-6b82-42d3-b5eb-2c698f455274",
            "reference_id": "asdff",
            "contact_name": "aboutf aboutl",
            "contact_email": "er@r.cd",
            "contact_phone": "333-333-4444",
            "primary": false,
            "payment_notfication": false
        }
    ],
    "remit_email": "vgfcv@ghjb.com,bg@nhj.com",
    "bank_account_number": "12000012",
    "bank_routing_number": "121000358",
    "payment_method": "FinexioExpress",
    "delivery_method": "Mail",
    "notification_method": "Email",
    "payment_terms": 25,
    "ineligible_for_conversion": false,
    "payee_type": "Student",
    "twelve_month_payment_count": 12,
    "twelve_month_spend": 23,
    "notes": "gfg",
    "metadata": "{\"a\":\"b\", \"aaaaaaaaaaaaa\":\"hhhhhhhhhhhhhhhh\"}",
    "enabled": true,
    "internal_payments": true
}

Please note that external_reference_id must be provided during the PUT operation, even if the value remains the same.

Example Response

{
    "id": "57cf3cbc-655d-4b41-9764-d0feababf7bc",
    "name": "Dev Supplier 2",
    "care_of": "null2",
    "remit_address_1": "sdsf",
    "remit_address_2": "",
    "remit_city": "test_remit_city",
    "remit_state": "CA",
    "remit_zipcode": "test_",
    "remit_country": "USA",
    "corporate_address_1": "test_corp_ad_1",
    "corporate_address_2": "test_corp_ad_2",
    "corporate_city": "test_corp_cty",
    "corporate_state": "TX",
    "corporate_zipcode": "test",
    "corporate_country": "USA",
    "corporate_phone_number": "03012314561",
    "external_reference_id": "DEVSUPPLIER-77",
    "tax_id": "333-44-88",
    "contacts": [
        {
            "payment_notification": false,
            "id": null,
            "external_reference_id": null,
            "name": null,
            "email": null,
            "phone": null,
            "primary": true
        },
        {
            "payment_notification": false,
            "id": null,
            "external_reference_id": null,
            "name": null,
            "email": null,
            "phone": null,
            "primary": false
        }
    ],
    "remit_email": "vgfcv@ghjb.com,bg@nhj.com",
    "bank_account_number": "0012",
    "bank_routing_number": "121000358",
    "payment_method": "FinexioExpress",
    "delivery_method": null,
    "notification_method": "Email",
    "created": "2024-04-24T16:56:55.241000",
    "updated": "2024-04-24T17:00:38.294000",
    "payment_terms": 25,
    "ineligible_for_conversion": false,
    "payee_type": "Business",
    "twelve_month_payment_count": 12,
    "twelve_month_spend": 23,
    "notes": "test",
    "metadata": null,
    "enabled": true,
    "processing_fee": 0.015,
    "internal_payments": true
}
Path Params
string
required

uuid of supplier

Body Params
string
length ≤ 100

max length = 100

string
length ≤ 36

max length = 36

string
length ≤ 40

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

string
length ≤ 40

max length = 40

string
length ≤ 40

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

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'

string
length ≤ 10

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

string
Defaults to USA

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

string
length ≤ 40

max length = 40

string
length ≤ 40

max length = 40

string
length ≤ 40

max length = 40

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' ]

string
length ≤ 10

max length = 10

string
Defaults to USA

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

string
length ≤ 16

max length = 16

string
length ≤ 200

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

string
length ≤ 11

max length = 11

contacts
array of objects
contacts
string

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

string
length ≤ 17

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

string
length ≤ 9

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

string

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

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.

string

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

integer

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

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.

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.

string

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

integer

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

integer

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

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.

boolean
Defaults to true

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

boolean
Defaults to false

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

Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
:
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?