--- title: "Create Suppliers in batch" method: POST path: "/accounting/suppliers/batch" tags: ["Suppliers"] --- # Create Suppliers in batch `POST /accounting/suppliers/batch` ## Request - Base URL: `https://unify.apideck.com` - URL: `https://unify.apideck.com/accounting/suppliers/batch` - Auth: API key in header `Authorization` Create multiple suppliers in a single request. Each item is processed independently, so some may be created while others fail; the response returns `200` with one result per item, in the order the items were sent. The maximum number of items accepted per request depends on the connector. ## Query parameters - `raw` boolean ## Headers - `x-apideck-consumer-id` string, required - `x-apideck-app-id` string, required - `x-apideck-service-id` string - `x-apideck-company-id` string ## Request body - BatchSuppliersRequest: A batch of suppliers to write in a single request. Each item is processed independently: some may succeed while others fail, and the response carries one result per item in the order they were sent. - `items` object[], required: The records to write. The per-connector limit is the real cap and is usually lower than the ceiling here: read `batch_support.resources[].max_items` on the Connector API for the connector you are calling, or the resource gotchas. This ceiling exists so an oversized array is rejected by request validation before any per-item work runs, rather than after it. - `_ref` string: A caller-supplied reference for this item, echoed back on the matching result so each outcome can be tied to the record it came from. Must be unique within the request. Never sent to the connector. - `data` SupplierCreateInput, required: The writable shape of Supplier for a batch create. Identical to [Supplier](the model returned on reads) with the read-only properties removed — the same properties the single-record create endpoint rejects, so a batched record and a single-record create accept exactly the same body. - `display_id` string, nullable: Display ID - `display_name` string, nullable: Display name - `company_name` string, nullable: The name of the company. - `company_id` string, nullable: The company ID the transaction belongs to - `subsidiary` LinkedSubsidiary, nullable - `id` string: A unique identifier for an object. - `display_id` string, nullable: Id to be displayed. - `name` string, nullable: The name of the resource. - `supplier_category` string, nullable: The category/type of the supplier - `title` string, nullable: The job title of the person. - `first_name` string, nullable: The first name of the person. - `middle_name` string, nullable: Middle name of the person. - `last_name` string, nullable: The last name of the person. - `suffix` string, nullable - `individual` boolean, nullable: Is this an individual or business supplier - `addresses` Address[] - `id` string, nullable: Unique identifier for the address. - `type` 'primary' | 'secondary' | 'home' | 'office' | 'shipping' | 'billing' | 'work' | 'other', nullable: The type of address. - `string` string, nullable: The address string. Some APIs don't provide structured address data. - `name` string, nullable: The name of the address. - `line1` string, nullable: Line 1 of the address e.g. number, street, suite, apt #, etc. - `line2` string, nullable: Line 2 of the address - `line3` string, nullable: Line 3 of the address - `line4` string, nullable: Line 4 of the address - `line5` string, nullable: Line 5 of the address - `street_number` string, nullable: Street number - `city` string, nullable: Name of city. - `state` string, nullable: Name of state - `postal_code` string, nullable: Zip code or equivalent. - `country` string, nullable: country code according to ISO 3166-1 alpha-2. - `latitude` string, nullable: Latitude of the address - `longitude` string, nullable: Longitude of the address - `county` string, nullable: Address field that holds a sublocality, such as a county - `contact_name` string, nullable: Name of the contact person at the address - `salutation` string, nullable: Salutation of the contact person at the address - `phone_number` string, nullable: Phone number of the address - `fax` string, nullable: Fax number of the address - `email` string, nullable: Email address of the address - `website` string, nullable: Website of the address - `notes` string, nullable: Additional notes - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `phone_numbers` PhoneNumber[] - `id` string, nullable: Unique identifier of the phone number - `country_code` string, nullable: The country code of the phone number, e.g. +1 - `area_code` string, nullable: The area code of the phone number, e.g. 323 - `number` string, required: The phone number - `extension` string, nullable: The extension of the phone number - `type` 'primary' | 'secondary' | 'home' | 'work' | 'office' | 'mobile' | 'assistant' | 'fax' | 'direct-dial-in' | 'personal' | 'billing' | 'other', nullable: The type of phone number - `emails` Email[] - `id` string, nullable: Unique identifier for the email address - `email` string, email, nullable, required: Email address - `type` 'primary' | 'secondary' | 'work' | 'personal' | 'billing' | 'other', nullable: Email type - `websites` Website[] - `id` string, nullable: Unique identifier for the website - `url` string, required: The website URL - `type` 'primary' | 'secondary' | 'work' | 'personal' | 'other', nullable: The type of website - `bank_accounts` BankAccount[] - `bank_name` string, nullable: The name of the bank or financial institution - `account_number` string, nullable: The bank account number - `account_name` string, nullable: The name of the bank account - `account_type` 'bank_account' | 'credit_card' | 'other', nullable: The type of bank account. - `iban` string, nullable: International Bank Account Number - `bic` string, nullable: Bank Identifier Code / SWIFT Code - `routing_number` string, nullable: Bank routing number (US) - `bsb_number` string, nullable: Bank State Branch number (Australia/New Zealand) - `branch_identifier` string, nullable: Bank branch identifier - `bank_code` string, nullable: Bank code assigned by central bank - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `country` string, nullable: Country code according to ISO 3166-1 alpha-2. - `notes` string, nullable: Some notes about this supplier - `tax_rate` LinkedTaxRate - `id` string, nullable: The ID of the object. - `code` string, nullable: Tax rate code - `name` string, nullable: Name of the tax rate - `rate` number, nullable: Rate of the tax rate - `tax_number` string, nullable - `taxable` boolean, nullable: Whether the entity is subject to taxation - `currency` 'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH', nullable: Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). - `account` LinkedLedgerAccount, nullable - `id` string: The unique identifier for the account. - `name` string, nullable: The name of the account. - `nominal_code` string, nullable: The nominal code of the account. - `code` string, nullable: The code assigned to the account. - `parent_id` string, nullable: The parent ID of the account. - `display_id` string, nullable: The display ID of the account. - `status` 'active' | 'inactive' | 'archived' | 'gdpr-erasure-request' | 'unknown', nullable: Supplier status - `payment_method` string, nullable: Payment method used for the transaction, such as cash, credit card, bank transfer, or check - `terms` string, nullable: Terms of payment. - `terms_id` string, nullable: The ID of the payment terms - `channel` string, nullable: The channel through which the transaction is processed. - `issued_method` string, nullable: Method of issuance of the purchase order for the supplier - `issued_email` string, nullable: Email address of the person who issued the purchase order for the supplier - `custom_fields` CustomField[] - union - object - `id` string, nullable, required: Unique identifier for the custom field. - `name` string, nullable: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - … - object - `id` string, nullable: Unique identifier for the custom field. - `name` string, nullable, required: Name of the custom field. - `ref_name` string, nullable: Display name of the record a reference-type custom field points at. `value` carries that record's id; this carries its human-readable name, so a consumer does not need a second lookup to render it. - `description` string, nullable: More information about the custom field - `value` union - … - `tax_details` LinkedTaxDetail[] - `type` string: The type of tax. - `number` string, nullable: The number of the tax. - `is_transaction_tax` boolean: Whether the tax is a transaction tax. - `is_primary_tax` boolean: Whether the tax is a primary tax. - `tax_status_details` LinkedTaxStatusDetail[] - `country` string: The country of the tax status. - `transaction_tax_status` string, nullable: The transaction tax status. - `row_version` string, nullable: A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object. - `pass_through` object[]: The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. - `service_id` string, required: Identifier for the service to which this pass_through should be applied. - `operation_id` string: Optional identifier for a workflow operation to which this pass_through should be applied. This is useful for Unify calls that are making more than one downstream request. - `extend_object` object: Simple object allowing any properties for direct extension. - `extend_paths` object[]: Array of objects for structured data modifications via paths. - `path` string, required: JSONPath string specifying where to apply the value. - `value` unknown, required - `subsidiary_id` string: The subsidiary the supplier belongs to. - `integration_system_id` string: The integration system the supplier belongs to. ## Response `200` Suppliers batch processed - BatchSuppliersResponse - `status_code` integer, required: HTTP Response Status Code - `status` string, required: HTTP Response Status - `service` string, required: Apideck ID of service provider - `resource` string, required: Unified API resource name - `operation` string, required: Operation performed - `data` BatchItemResult[], required: One result per item in the request, in the order the items were sent. - `_ref` string: A caller-supplied reference for this item, echoed back on the matching result so each outcome can be tied to the record it came from. Must be unique within the request. Never sent to the connector. - `id` string: A unique identifier for an object. - `downstream_id` string, nullable: The third-party API ID of original entity - `status` 'created' | 'updated' | 'failed' | 'uncertain', required: The outcome for this item. - `created` / `updated` — the record was written. - `failed` — it was not written, and `error` says why. - `uncertain` — the request to the connector did not complete (typically a timeout), so whether this record was written is genuinely unknown. Do not blindly retry: list the resource to find what exists first, or a retry may duplicate it. A `created` or `updated` result can also carry an `error`: the record was written, but work that runs after the write did not complete. Read this rather than `id` to decide what happened. `id` is present when the identifier could also be read back, which is not the same question — a written record whose id could not be parsed still reports `created`. - `error` object: Why this item did not complete. Present when `status` is `failed`, meaning the record was not written, and when `status` is `uncertain`, meaning it is unknown whether it was. Also present, more rarely, alongside `created`/`updated`: the record WAS written and post-write processing failed, so the item reports the error beside its success status. Per-item failures are independent — one item's rejection says nothing about the others. The exception is a failure of the request itself, such as a timeout: where a connector writes the whole batch in one call, every item shares that outcome and carries the same error. - `status_code` number: HTTP status code - `error` string: Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231) - `type_name` string: The type of error returned - `message` string: A human-readable message providing more details about the error. - `detail` union: Contains parameter or domain specific information related to the error and why it occurred. - string - object - `ref` string: Link to documentation of error type - `warnings` object[]: Non-fatal problems with THIS item — a currency the connector could not match, for example, which is sent without it. Present per item rather than per request, because a caller with twenty records needs to know which one was affected. A warning does not imply the record was written: some are raised while preparing the item, before the write is attempted, so they can appear on a `failed` item too. Read `status` for what happened. - `type` string - `operation` string - `message` string - `status_code` number - `error` string - `_raw` Raw, nullable: Raw response from the integration when raw=true query param is provided ## Other responses - `400`: Bad Request - `401`: Unauthorized - `402`: Payment Required - `404`: The specified resource was not found - `422`: Unprocessable - `default`: Unexpected error ## Changes - **2026-10-01** `4d9d527eb7ce`: 1 info - endpoint added [Operation history](https://skmtc.dev/apideck-libraries/apis/accounting-api/changes/accounting/suppliers/batch/post.md) --- [API](https://skmtc.dev/apideck-libraries/apis/accounting-api.md) · [All operations](https://skmtc.dev/apideck-libraries/apis/accounting-api/llms.txt) · [OpenAPI document](https://skmtc.dev/apideck-libraries/apis/accounting-api/revisions/d02fc67b26ca?raw)