Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Customers

Creates a customer

Creates a new customer in the Accounts Receivable catalog. Required fields: name. When providing an address, all of these fields are required: line1, city, state (2-letter code e.g. 'TN', 'CA'), zip_code, country.

post/customers

Request body

namestring required
name_on_invoicestring
payment_termsinteger
send_invoices_automaticallyboolean

When set to true, invoices for this customer will be automatically sent via email on the invoice date.

send_payment_remindersboolean

When set to true, an email will be sent to customers periodically if they have not paid an invoice.

Example request

{
  "name": "Bob",
  "name_on_invoice": "Bob Johnson",
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "shipping_address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "emails": [
    {
      "email": "bobjohnson@somedomain.com"
    }
  ],
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}

Response

OK

idstring uuid required
updated_atstring date-time required

ISO 8601 timestamp in UTC timezone (must end with 'Z')

namestring required
name_on_invoicestring
payment_termsinteger
send_invoices_automaticallyboolean

When set to true, invoices for this customer will be automatically sent via email on the invoice date.

send_payment_remindersboolean

When set to true, an email will be sent to customers periodically if they have not paid an invoice.

Example response

{
  "name": "Bob",
  "name_on_invoice": "Bob Johnson",
  "address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "shipping_address": {
    "line1": "123 Main St",
    "line2": "Apt 4B",
    "city": "Nashville",
    "state": "TN",
    "zip_code": "37201",
    "country": "US"
  },
  "emails": [
    {
      "email": "bobjohnson@somedomain.com"
    }
  ],
  "external_references": [
    {
      "type": "xyzSystemId",
      "id": "234",
      "url": "https://xyzsystempage.com/ids/234"
    }
  ]
}