Suppliers can be created with a POST operation through the Suppliers endpoint: /counterparties/suppliers.

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": "MyAPISupplier",
    "care_of": "DEV",
    "remit_address_1": "123 Street Address",
    "remit_address_2": "",
    "remit_city": "Atlanta",
    "remit_state": "GA",
    "remit_zipcode": "30339",
    "remit_country": "USA",
    "corporate_address_1": "123 Street Address",
    "corporate_address_2": "",
    "corporate_city": "Atlanta",
    "corporate__state": "GA",
    "corporate__zipcode": "30339",
    "corporate__country": "USA",
    "corporate_phone_number": "03012314561",
    "external_reference_id": "03012314561",
    "tax_id": "123-12-1234",
    "payment_method": "Card",
    "delivery_method":"Email",
    "remit_email": "test@finexio.com",
    "payment_terms": "45",
    "inelagible_for_conversion": false,
    "payee_type": "Business",
    "twelve_month_payment_count": "10",
    "twelve_month_spend": "10000",
    "notes": "test",
    "enabled": true,
    "visible": true,
    "contacts": [
        {
            "funding_notification": true,
            "refund_notification": true,
            "external_reference_id": "239200585p",
            "name": "Dev contact",
            "email": "test@finexio.com",
            "phone": "0301234567",
            "primary": false
        }
    ]
}

Example Response

{
    "id": "57cf3cbc-655d-4b41-9764-d0feababf7bc",
    "name": "MyAPISupplier",
    "care_of": "DEV",
    "remit_address_1": "123 Street Address",
    "remit_address_2": "",
    "remit_city": "Atlanta",
    "remit_state": "GA",
    "remit_zipcode": "30339",
    "remit_country": "USA",
    "corporate_address_1": "123 Street Address",
    "corporate_address_2": "",
    "corporate_city": "Atlanta",
    "corporate_state": "",
    "corporate_zipcode": "",
    "corporate_country": "USA",
    "corporate_phone_number": "03012314561",
    "external_reference_id": "03012314561",
    "tax_id": "123-12-1234",
    "contacts": [
        {
            "payment_notification": false,
            "id": "32a8c548-e645-4a69-99a2-b557463f8f2d",
            "external_reference_id": "239200585p",
            "name": "Dev contact",
            "email": "test@finexio.com",
            "phone": "0301234567",
            "primary": false
        }
    ],
    "remit_email": "test@finexio.com",
    "bank_account_number": null,
    "bank_routing_number": null,
    "payment_method": "Card",
    "delivery_method": "Email",
    "notification_method": null,
    "created": "2024-04-24T16:56:55.241623",
    "updated": "2024-04-24T16:56:55.241623",
    "payment_terms": 45,
    "ineligible_for_conversion": false,
    "payee_type": "Business",
    "twelve_month_payment_count": 10,
    "twelve_month_spend": 10000,
    "notes": "test",
    "metadata": null,
    "enabled": true,
    "processing_fee": 0,
    "internal_payments": false
}