Update An Existing Supplier

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": "[email protected]",
            "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": "[email protected]",
            "contact_phone": "333-333-4444",
            "primary": false,
            "payment_notfication": false
        }
    ],
    "remit_email": "[email protected],[email protected]",
    "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": "[email protected],[email protected]",
    "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
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!