latestOpenAPI 3.0.02026-08-10233809957.8 KB

5cdfae3fa1fa

Vendors

List Vendors

Supported for:

freshbooks quickbooks quickbooksDesktop xero oracleNetsuite sageBusinessCloud sageIntacct dynamicsBusinessCentral dynamics365Finance wave myob zohoBooks

get/v2/accounting/vendors

Query parameters

connectionUuidstring required

Unique connection identifier.

offsetnumber

The offset is the position in the dataset of a particular record.

limitnumber

This is the size of the results set you would like (default: 100).

orderBystring

Response

Example response

{
  "meta": {
    "connectionUuid": "CON-396d5daa-26b2-4979-89b6-cafb2c298155",
    "businessName": "Railz",
    "serviceName": "xero",
    "reportId": [
      "5fad8a342a88364234392fb5",
      "5fad8a342a88364234392fb6"
    ],
    "createdAt": "2020-11-25T01:02:03Z",
    "updatedAt": "2020-11-30T01:02:03Z"
  },
  "data": [
    {
      "id": "1",
      "vendorName": "ACME Inc.",
      "contactName": "Jane Smith",
      "emailAddress": "email@acme.com",
      "website": "www.acme.com",
      "phone": "8889990000",
      "taxNumber": "987654321",
      "subsidiaryRefs": [
        {
          "id": "1",
          "name": "Railz Financial"
        }
      ],
      "sourceModifiedDate": "2021-03-09T08:49:36.035Z",
      "parentRef": {
        "id": "434",
        "name": "Region"
      },
      "contactFirstName": "Jane",
      "contactLastName": "Smith",
      "currency": "USD",
      "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"
      },
      "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"
          }
        }
      ],
      "paymentMethodRef": {
        "id": "3",
        "name": "Harmonized sales tax",
        "type": "creditCard"
      }
    }
  ]
}