The CustomerData object is used for /api/Customer/ endpoints. It contains many of the same fields as PayorData, but includes fields for managing the user in Payabli.

Data pertaining to single customer. See customerData Object Model for a complete reference.

additionalFields
object | null

Additional Custom fields in format "key":"value".

address
string | null

Customer address

address1
string | null

Additional customer address

balance
number | null

Customer balance.

city
string | null

Customer city

company
string | null

Company name

country
string | null

Customer country in ISO-3166-1 alpha 2 format
See https://en.wikipedia.org/wiki/ISO_3166-1 for reference.

createdAt
string

Timestamp of when record was created, in UTC.

customerNumber
string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250
customerPsw
string | null

Customer password for customer portal

customerStatus
integer | null

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
customerUsername
string | null

Customer username for customer portal

email
string | null

Customer email address

firstname
string | null

Customer first name

identifierFields
(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

lastname
string | null

Customer last name

phone
string | null

Customer phone number

shippingAddress
string | null

The shipping address.

Maximum length: 250
shippingAddress1
string | null

Additional line for shipping address.

Maximum length: 100
shippingCity
string | null

Shipping city.

Maximum length: 250
shippingCountry
string | null

Shipping address country.

shippingState
string | null

Shipping state or province.

shippingZip
string | null

Shipping ZIP code.

Maximum length: 50
state
string | null

Customer State

timeZone
integer | null
default:
0

Timezone, in UTC offset. For example, -5 is Eastern time.

zip
string | null

Customer zip code

Was this page helpful?