Customers

Overview

From the Customers endpoint, you can retrieve a list of all customers for a specified business. See Customers endpoint for more details

Data Model

Field	Type	Description
id	string	Identifier for the customer, unique to the business in the accounting service provider.
customerName sortable, filterable	string	Name of the customer as recorded in the accounting service provider, typically the company name.
contactName sortable, filterable	string	Name of the main contact for the customer.
emailAddress	string	Customer's primary email address.
website	string	Customer's website
defaultCurrency	Reference Types	Customer's default currency. Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.
phone	string	Customer's phone number.
addresses	array	An array of Addresses.
contacts	array	An array of Contacts.
taxNumber	string	Customer's tax number.
balance sortable, filterable	decimal	Customer's current balance.
status sortable, filterable	string	Customer current status, either: `unknown` `active` `archived`
subsidiaryRefs	Reference Types	An array of subsidiaries the customer refers to.
sourceModifiedData sortable, filterable	string See Date	Date the record was last changed in the accounting service provider.

Customer Reference

Data types that reference a customer, for example, invoice and invoice credit notes, use a customerRef that includes the id and name of the linked customer.

📘
Using Currency Reference in Push
For convenience, when pushing data customerRef can be used alone with the id as a value instead of nesting it within.

Example Data

{
  "id": "1",
  "customerName": "ACME Inc.",
  "contactName": "Jane Smith",
  "emailAddress": "[email protected]",
  "website": "www.acme.com",
  "defaultCurrency":
  {
    "id": "CAD",
    "name": "Canadian Dollar"
  },
  "phone": "8889990000",
  "addresses":
  [
    {
      "line1": "1234 Park Street",
      "line2": "Suite 1000",
      "city": "Toronto",
      "region": "ON",
      "country": "CAN",
      "postalCode": "A0B1C2",
      "type": "billing"
    }
  ],
  "contacts":
  [
    {
      "name": "John Smith",
      "email": "[email protected]",
      "phone": "8887779999",
      "address":
      {
        "line1": "1234 Park Street",
        "line2": "Suite 1000",
        "city": "Toronto",
        "region": "ON",
        "country": "CAN",
        "postalCode": "A0B1C2",
        "type": "billing"
      },
      "status": "unknown",
      "modifiedDate": "2021-03-09T08:49:36.035Z"
    }
  ],
  "taxNumber": "987654321",
  "balance": 0,
  "status": "unknown",
  "subsidiaryRefs":
  [
    {
      "id": "1",
      "name": "Railz Financial"
    }
  ],
  "sourceModifiedDate": "2021-03-09T08:49:36.035Z"
}

Overview

Data Model

Customer Reference

📘Using Currency Reference in Push

Example Data

📘
Using Currency Reference in Push