Sign in
latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Vendors

Batch Create Vendors

Supported for:

freshbooks quickbooks xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral

post/v2/accounting/vendors/batch

Request body

connectionUuidstring required

Unique connection identifier.

Example request

{
  "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
  "batch": [
    {
      "contactFirstName": "Jane",
      "contactLastName": "Smith",
      "emailAddress": "email@acme.com",
      "phone": "8889990000",
      "website": "www.acme.com",
      "vendorName": "ACME Inc.",
      "contactName": "Jane Smith",
      "parentRef": {
        "id": "32"
      },
      "currency": "CAD",
      "paymentMethodRef": {
        "id": "1",
        "name": "Harmonized sales tax",
        "type": "creditCard"
      },
      "billingAddress": {
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      },
      "shippingAddress": {
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2"
      },
      "subsidiaryRefs": [
        {
          "id": "4"
        }
      ],
      "contacts": [
        {
          "name": "John Smith",
          "email": "jsmith@company.com",
          "phone": "8887779999",
          "address": {
            "line1": "1234 Park Street",
            "line2": "Suite 1000",
            "city": "Toronto",
            "region": "ON",
            "country": "CAN",
            "postalCode": "A0B1C2",
            "type": "billing"
          }
        }
      ],
      "taxNumber": "987654321",
      "passThrough": {
        "CustomField": [
          {
            "DefinitionId": "1",
            "StringValue": "my custom value",
            "Name": "Field One"
          }
        ]
      }
    }
  ]
}

Response

connectionUuidstring required
businessNamestring required
serviceName'freshbooks' | 'quickbooks' | 'quickbooksDesktop' | 'xero' | 'oracleNetsuite' | 'sageBusinessCloud' | 'sageIntacct' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'myob' | 'zohoBooks' | 'byod' required
batchIdstring required

Example response

{
  "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
  "businessName": "Railz",
  "serviceName": "xero",
  "batchId": "60473b57f0cdd1683ca71f60",
  "batch": [
    {
      "pushCommunicationId": "60473b57f0cdd1683ca71f60",
      "requestedOn": "2021-03-09T08:15:22.035Z",
      "status": "pending",
      "data": {
        "contactFirstName": "Jane",
        "contactLastName": "Smith",
        "emailAddress": "email@acme.com",
        "phone": "8889990000",
        "website": "www.acme.com",
        "vendorName": "ACME Inc.",
        "contactName": "Jane Smith",
        "parentRef": {
          "id": "32"
        },
        "currency": "CAD",
        "paymentMethodRef": {
          "id": "1",
          "name": "Harmonized sales tax",
          "type": "creditCard"
        },
        "billingAddress": {
          "line1": "1234 Park Street",
          "line2": "Suite 1000",
          "city": "Toronto",
          "region": "ON",
          "country": "CAN",
          "postalCode": "A0B1C2"
        },
        "shippingAddress": {
          "line1": "1234 Park Street",
          "line2": "Suite 1000",
          "city": "Toronto",
          "region": "ON",
          "country": "CAN",
          "postalCode": "A0B1C2"
        },
        "subsidiaryRefs": [
          {
            "id": "4"
          }
        ],
        "contacts": [
          {
            "name": "John Smith",
            "email": "jsmith@company.com",
            "phone": "8887779999",
            "address": {
              "line1": "1234 Park Street",
              "line2": "Suite 1000",
              "city": "Toronto",
              "region": "ON",
              "country": "CAN",
              "postalCode": "A0B1C2",
              "type": "billing"
            }
          }
        ],
        "taxNumber": "987654321",
        "passThrough": {
          "CustomField": [
            {
              "DefinitionId": "1",
              "StringValue": "my custom value",
              "Name": "Field One"
            }
          ]
        }
      }
    }
  ]
}