One customer

GET

/receivables/customers/{id}

curl --request GET \
  --url https://example.com/v1/receivables/customers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Requires receivables.customer.read.

Authorizations

• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

The customer

Media typeapplication/json

object

address

required

object

city

string

line1

string

line2

string

postcode

string

state

string

code

required

string

country_code

required

string

currency

required

string

custom_fields

The organization’s user-defined field values by key (GET /org/custom-fields); {} when none.

object

key

additional properties

string

default_revenue_account_id

string format: uuid

nullable

default_tax_code_id

string format: uuid

nullable

email

string

nullable

id

required

string format: uuid

is_active

required

boolean

is_group_company

required

True when this party is currently mapped to another company of a group the organization belongs to (its own map; see /consolidation/counterparties). Dealings with it are group transactions and are eliminated in a consolidation run.

boolean

legal_name

required

string

party_kind

required

string

Allowed values: organization individual

payment_terms_days

required

integer

<= 365

phone

string

nullable

registration_no

string

nullable

registration_type

string

nullable

Allowed values: brn nric passport army

revision

required

integer

sst_registration_no

string

nullable

tin

string

nullable

Example

{
  "party_kind": "organization",
  "registration_type": "brn"
}

Headers

ETag

string

The record’s revision, quoted.

401

Not authenticated, or the session is no longer valid.

Media typeapplication/problem+json

object

code

A stable refusal code the client branches on, where the status alone is not enough: owner_role_manage_required and self_lockout on the role editor’s 409s; revision_mismatch (a stale If-Match) and document_bound_elsewhere (the document backs another record) on an expense claim’s 409s.

string

detail

string

instance

string

status

required

integer

title

required

string

type

required

string

Example ^generated

{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

The caller does not hold the permission this operation requires.

Media typeapplication/problem+json

object

code

A stable refusal code the client branches on, where the status alone is not enough: owner_role_manage_required and self_lockout on the role editor’s 409s; revision_mismatch (a stale If-Match) and document_bound_elsewhere (the document backs another record) on an expense claim’s 409s.

string

detail

string

instance

string

status

required

integer

title

required

string

type

required

string

Example ^generated

{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

No such record in this organization.

Media typeapplication/problem+json

object

code

A stable refusal code the client branches on, where the status alone is not enough: owner_role_manage_required and self_lockout on the role editor’s 409s; revision_mismatch (a stale If-Match) and document_bound_elsewhere (the document backs another record) on an expense claim’s 409s.

string

detail

string

instance

string

status

required

integer

title

required

string

type

required

string

Example ^generated

{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

A rate limit was reached: per API key, per organization across its keys, or per source address for repeated failed key authentication. Retry after the number of seconds in Retry-After. Every answer on a key carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset.

Media typeapplication/problem+json

object

code

A stable refusal code the client branches on, where the status alone is not enough: owner_role_manage_required and self_lockout on the role editor’s 409s; revision_mismatch (a stale If-Match) and document_bound_elsewhere (the document backs another record) on an expense claim’s 409s.

string

detail

string

instance

string

status

required

integer

title

required

string

type

required

string

Example ^generated

{
  "code": "example",
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Retry-After

integer

Seconds until a retry may succeed.