Customers

A customer is an individual or company that buys goods or services from a business. Customers relate to a corresponding invoice for a business. You can retrieve a list of all the customers of a company.

For customers from a commerce platform, see Customers.

The Customer Object

Property

Type

Description

id

string

Unique identifier for a customer object.

name

string

Name of the customer as recorded in the accounting system

contact_name

string

Name of the main contact for the customer

email

string

Email of the customer.

currency

string

The ISO-4217 currency code

phone

string

Phone number for the customer

addresses

object[]

Array of any addresses stored for the customer

contacts

object[]

Array of contacts stored for the customer.

registration_number

string

Official company registration/business number.

tax_number

string

Company tax number

updated_at

string

The last ISO 8601 updated date

{
      "id": "2ab4d4e8-eb85-4d82-afde-9a47cda3a37b",
      "name": "Lang API",
      "contact_name": "John Smith",
      "email": "[email protected]",
      "currency": "USD",
      "phone": "+1281283921",
      "addresses": [
        {
          "address1": "123 Amoebobacterieae St",
          "address2": "",
          "city": "Ottawa",
          "first_name": "Bob",
          "last_name": "Bobsen",
          "phone": "555-625-1199",
          "postal_code": "K2P0V6",
          "country_code": "CA",
          "region": "ON"
        }
      ],
      "contacts": [
        {
          "name": "John Smith",
          "email": "[email protected]",
          "phone": "+1281283921",
          "address": {
            "address1": "123 Amoebobacterieae St",
            "address2": "",
            "city": "Ottawa",
            "first_name": "Bob",
            "last_name": "Bobsen",
            "phone": "555-625-1199",
            "postal_code": "K2P0V6",
            "country_code": "CA",
            "region": "ON"
          },
          "updated_at": "2020-01-26T05:17:23.323Z"
        }
      ],
      "registration_number": "12345",
      "tax_number": "1357924680123456",
      "updated_at": "2020-01-26T05:17:23.323Z"
    }