Customer

The customer resource.

Base/customer

GET/customer

List customers

Retrieve a paginated list of customers. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/customer

curl --request GET \
  --url '<your-host>/customer?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "name": "Example",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "taxPercent": 0,
    "readableId": "xyz789",
    "onHold": true
  }
]

GET/customer

Retrieve a customer

Fetch a single customer by filtering on `id`.

Query parameters

idstring

Match on the customer's `id`, e.g. `eq.{id}`.

GET/customer

curl --request GET \
  --url '<your-host>/customer?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "readableId": "xyz789",
  "onHold": true
}

POST/customer

Create a customer

Create a new customer.

Body parameters

namestringrequired

customerTypeIdstring

customerStatusIdstring

References customerStatus.id

accountManagerIdstring

References user.id

logostring

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

currencyCodestring

References currencyCode.code

phonestring

faxstring

websitestring

taxPercentnumberrequired

tagsarray

salesContactIdstring

References customerContact.id

defaultCcarray

intercompanyCompanyIdstring

References company.id

readableIdstringrequired

customerSincedate

The day the business acquired the account. Null is unknown.

depositBalancenumber

Deposit the business holds against the account, in the company currency.

autopayEnabledboolean

An automatic payment schedule stands on the account. Null is unknown.

onHoldbooleanrequired

A credit hold stands on the account; deliveries and service are refused while it does.

holdReasonstring

accountKindcustomerAccountKindrequired

What this account is to the business. Set by an importer from the source system's own fields or an explicit reviewed list, never from a pattern in a name. A question about customers reads only accountKind = customer.

POST/customer

curl --request POST \
  --url <your-host>/customer \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","companyId":"xyz789","taxPercent":0,"readableId":"xyz789","onHold":true,"accountKind":"string"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "readableId": "xyz789",
  "onHold": true
}

PATCH/customer

Update a customer

Update an existing customer, matched on `id`.

Body parameters

namestringrequired

customerTypeIdstring

customerStatusIdstring

References customerStatus.id

accountManagerIdstring

References user.id

logostring

assigneestring

References user.id

companyIdstringrequired

References company.id

customFieldsobject

currencyCodestring

References currencyCode.code

phonestring

faxstring

websitestring

taxPercentnumberrequired

tagsarray

salesContactIdstring

References customerContact.id

defaultCcarray

intercompanyCompanyIdstring

References company.id

readableIdstringrequired

customerSincedate

The day the business acquired the account. Null is unknown.

depositBalancenumber

Deposit the business holds against the account, in the company currency.

autopayEnabledboolean

An automatic payment schedule stands on the account. Null is unknown.

onHoldbooleanrequired

A credit hold stands on the account; deliveries and service are refused while it does.

holdReasonstring

accountKindcustomerAccountKindrequired

PATCH/customer

curl --request PATCH \
  --url '<your-host>/customer?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "id": "abc123def456",
  "name": "Example",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "taxPercent": 0,
  "readableId": "xyz789",
  "onHold": true
}

DELETE/customer

Delete a customer

Delete a customer, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the customer to delete, e.g. `eq.{id}`.

DELETE/customer

curl --request DELETE \
  --url '<your-host>/customer?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content