Latinum Customer Account API Resources

GET

/v2/customer/{customer_id}

(billing)

Get One Customer

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
customer_id	url	string	Customer Id.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_code	body	string	Account Code.
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
address_type	body	string	Address Type.
country	body	string	Country.
customer_name	body	string	Customer Name.
customer_type	body	string	Customer Type.
domain	body	string	Entity Domain.
email	body	string	Email.
id	body	string	Unique Entity ID.
phone_no	body	string	Phone No.
postal_code	body	string	Postal Code.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
state	body	string	State.
tax_rate	body	string	Tax Rate.
user_id	body	string	User Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "user_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "customer_type": "INDIVIDUAL",
    "registration_no": null,
    "sales_tax_no": null,
    "customer_name": "John Smith",
    "address_type": "PHYSICAL",
    "address_line1": "123 Street Road",
    "address_line2": "Suburb",
    "address_line3": "City",
    "address_line4": "",
    "postal_code": "00001",
    "country": "ZA",
    "state": "Gauteng",
    "phone_no": "0123456789",
    "email": "user@domain.com",
    "account_code": "CUST-001",
    "tax_rate": "SR"
}

GET

/v2/customer/accountcode/{customer_account_code}

(billing)

Get One Customer (by account code)

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
customer_account_code	url	string	Customer Account Code.	X

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_code	body	string	Account Code.
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
address_type	body	string	Address Type.
country	body	string	Country.
customer_name	body	string	Customer Name.
customer_type	body	string	Customer Type.
domain	body	string	Entity Domain.
email	body	string	Email.
id	body	string	Unique Entity ID.
phone_no	body	string	Phone No.
postal_code	body	string	Postal Code.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
state	body	string	State.
tax_rate	body	string	Tax Rate.
user_id	body	string	User Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "user_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "customer_type": "INDIVIDUAL",
    "registration_no": null,
    "sales_tax_no": null,
    "customer_name": "John Smith",
    "address_type": "PHYSICAL",
    "address_line1": "123 Street Road",
    "address_line2": "Suburb",
    "address_line3": "City",
    "address_line4": "",
    "postal_code": "00001",
    "country": "ZA",
    "state": "Gauteng",
    "phone_no": "0123456789",
    "email": "user@domain.com",
    "account_code": "CUST-001",
    "tax_rate": "SR"
}

GET

/v2/customer/{customer_account_id}/balance

(billing)

Get Customer Balance

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
customer_account_id	url	string	Customer Account Id.	X
legal_entity_id	query	string	Legal Entity Id.

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
balance	body	string	Balance.

Response Example

{
    "balance": "100.00"
}

GET

/v2/customer/all

(billing)

Get All Customers

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorCustomerStaff MemberSupport

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
account_code	query	string	Filter by account_code. (can suffix with wildcard )*
customer_name	query	string	Filter by customer_name. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (customer_name, account_code)
sd	query	string	Sort direction. asc for Ascending or desc for Descending

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_code	body	string	Account Code.
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
address_type	body	string	Address Type.
country	body	string	Country.
customer_name	body	string	Customer Name.
customer_type	body	string	Customer Type.
domain	body	string	Entity Domain.
email	body	string	Email.
id	body	string	Unique Entity ID.
metadata.page	body	integer	Current Page. (always 1 for infinite)
metadata.pages	body	integer	Total Pages. (always 1 for infinite)
metadata.per_page	body	integer	Equeal to the entities per page limit or always equal to total records for infinite queries.
metadata.records	body	integer	Total entities found. (always max 250 unless infinite is accepted query parameter)
phone_no	body	string	Phone No.
postal_code	body	string	Postal Code.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
state	body	string	State.
tax_rate	body	string	Tax Rate.
user_id	body	string	User Id.

Response Example

{
    "payload": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "user_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "customer_type": "INDIVIDUAL",
            "registration_no": null,
            "sales_tax_no": null,
            "customer_name": "John Smith",
            "address_type": "PHYSICAL",
            "address_line1": "123 Street Road",
            "address_line2": "Suburb",
            "address_line3": "City",
            "address_line4": "",
            "postal_code": "00001",
            "country": "ZA",
            "state": "Gauteng",
            "phone_no": "0123456789",
            "email": "user@domain.com",
            "account_code": "CUST-001",
            "tax_rate": "SR"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "user_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "customer_type": "INDIVIDUAL",
            "registration_no": null,
            "sales_tax_no": null,
            "customer_name": "Jane Smith",
            "address_type": "PHYSICAL",
            "address_line1": "456 Street Road",
            "address_line2": "Suburb",
            "address_line3": "City",
            "address_line4": "",
            "postal_code": "00001",
            "country": "ZA",
            "state": "Gauteng",
            "phone_no": "0123456789",
            "email": "user@domain.com",
            "account_code": "CUST-002",
            "tax_rate": "SR"
        }
    ],
    "metadata": {
        "records": 2,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

PATCH

/v2/customer/{customer_id}

(billing)

Update Customer

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
X-Timezone	header	string	Timezone for response datetime property values. (default UTC)
customer_id	url	string	Customer Id.	X
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
address_type	body	string	Address Type.
country	body	string	Country.
customer_name	body	string	Customer Name.
email	body	string	Email.
phone_no	body	string	Phone No.
postal_code	body	string	Postal Code.
state	body	string	State.

Response Status Codes

Code	Meaning
200	OK
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Response Properties

Name	In	Type	Description
account_code	body	string	Account Code.
address_line1	body	string	Address Line1.
address_line2	body	string	Address Line2.
address_line3	body	string	Address Line3.
address_line4	body	string	Address Line4.
address_type	body	string	Address Type.
country	body	string	Country.
customer_name	body	string	Customer Name.
customer_type	body	string	Customer Type.
domain	body	string	Entity Domain.
email	body	string	Email.
id	body	string	Unique Entity ID.
phone_no	body	string	Phone No.
postal_code	body	string	Postal Code.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
state	body	string	State.
tax_rate	body	string	Tax Rate.
user_id	body	string	User Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "user_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "customer_type": "INDIVIDUAL",
    "registration_no": null,
    "sales_tax_no": null,
    "customer_name": "Jane Smith",
    "address_type": "PHYSICAL",
    "address_line1": "456 Street Road",
    "address_line2": "Suburb",
    "address_line3": "City",
    "address_line4": "",
    "postal_code": "00001",
    "country": "ZA",
    "state": "Gauteng",
    "phone_no": "0123456789",
    "email": "user@domain.com",
    "account_code": "CUST-002",
    "tax_rate": "SR"
}

DELETE

/v2/customer/{customer_id}

(billing)

Remove One Customer

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
customer_id	url	string	Customer Id.	X

Response Status Codes

Code	Meaning
204	OK - No Content
400	Bad Request
401	Unauthorized / Require Authentication
403	Forbidden / Access Denied
404	Not Found
429	Too Many Requests / Your Rate Limited
500, 501, 502, 503, 504	Service Unavailable

Navigation

Latinum Customer Account API Resources