Skip to main content

Customer

Full customer detail, including contacts and addresses.

idstring

Unique identifier for the customer.

Example: 4021
namestring

Display name of the customer.

Example: Sunrise Craft Beverages
codestring

Short alphanumeric code for quick reference (e.g., on printed documents or internal lookups).

Example: SUNRISE
companyNamestring

Legal company name, if different from the display name.

emailstring<email>

Primary email address for the customer account.

phonestring

Primary phone number for the customer account.

paymentTermsstring

Default payment terms for this customer (e.g., "Net 30", "Due on receipt"). Applied to new sales orders unless overridden.

Example: Net 30
notesstring

Internal notes about this customer. Not visible to the customer.

contacts object[]

All contact persons on file for this customer. One contact is flagged as primary.

  • Array [
  • namestring

    Full name of the contact.

    emailstring<email>

    Email address of the contact.

    phonestring

    Phone number including country code.

    isPrimaryboolean

    Whether this is the primary contact for the customer.

  • ]
  • addresses object[]

    All addresses on file for this customer (billing, shipping, or both). One address is flagged as primary.

  • Array [
  • addressTypestring

    Whether this address is used for billing, shipping, or both.

    Possible values: [billing, shipping, both]

    streetstring

    Street address line.

    citystring
    statestring

    State or province code.

    zipCodestring

    Postal or ZIP code.

    countrystring

    Two-letter country code (ISO 3166-1 alpha-2).

    isPrimaryboolean

    Whether this is the default address for the customer.

  • ]
  • Customer
    {
    "id": "4021",
    "name": "Sunrise Craft Beverages",
    "code": "SUNRISE",
    "companyName": "string",
    "email": "user@example.com",
    "phone": "string",
    "paymentTerms": "Net 30",
    "notes": "string",
    "contacts": [
    {
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "isPrimary": true
    }
    ],
    "addresses": [
    {
    "addressType": "billing",
    "street": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "country": "string",
    "isPrimary": true
    }
    ]
    }