Latinum Legal Entity API Resources

GET

/v2/legalentity/{legal_entity_id}

(billing)

Get One Legal Entity

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)
legal_entity_id	url	string	Legal Entity 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
address	body	string	Address.
billing_email	body	string	Billing Email.
default_sales_tax_code	body	string	Default Sales Tax Code.
doc_prefix_credit_note	body	string	Credit Note Document Prefix
doc_prefix_debit_note	body	string	Debit Note Document Prefix
doc_prefix_invoice	body	string	Invoice Document Prefix
doc_prefix_receipt	body	string	Receipt Document Prefix
doc_prefix_reversal_receipt	body	string	Reversal Receipt Document Prefix
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
logo_ref	body	string	Logo Ref.
name	body	string	Name of Entity.
phone_no	body	string	Phone No.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
support_email	body	string	Support Email.
timezone	body	string	Timezone.
website	body	string	Website.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "interstellio.io",
    "registration_no": "XXX",
    "sales_tax_no": "XXX",
    "currency": "ZAR",
    "name": "Company Name",
    "timezone": "Africa/Johannesburg",
    "default_sales_tax_code": "TAX-001",
    "doc_prefix_invoice": "INV-",
    "doc_prefix_credit_note": "CRD-NT-",
    "doc_prefix_debit_note": "DBT-NT-",
    "doc_prefix_receipt": "RCT-",
    "doc_prefix_reversal_receipt": "RVS-RCT-",
    "address": "123 Street Road, Suburb, City",
    "phone_no": "0123456789",
    "billing_email": "user@interstellio.io",
    "support_email": "user@interstellio.io",
    "website": "www.interstellio.io",
    "logo_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

GET

/v2/legalentity/all

(billing)

Get All Legal Entities

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)
id	query	string	Filter by id. (can suffix with wildcard )*
l	query	integer	Paginate Limit / Entities per Page. (1-50, 0 for infinite, -1 for streaming)
name	query	string	Filter by name. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (id, name)
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
address	body	string	Address.
billing_email	body	string	Billing Email.
default_sales_tax_code	body	string	Default Sales Tax Code.
doc_prefix_credit_note	body	string	Credit Note Document Prefix
doc_prefix_debit_note	body	string	Debit Note Document Prefix
doc_prefix_invoice	body	string	Invoice Document Prefix
doc_prefix_receipt	body	string	Receipt Document Prefix
doc_prefix_reversal_receipt	body	string	Reversal Receipt Document Prefix
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
logo_ref	body	string	Logo Ref.
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)
name	body	string	Name of Entity.
phone_no	body	string	Phone No.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
support_email	body	string	Support Email.
timezone	body	string	Timezone.
website	body	string	Website.

Response Example

{
    "payload": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "interstellio.io",
            "registration_no": "XXX",
            "sales_tax_no": "XXX",
            "currency": "ZAR",
            "name": "Company Name",
            "timezone": "Africa/Johannesburg",
            "default_sales_tax_code": "TAX-001",
            "doc_prefix_invoice": "INV-",
            "doc_prefix_credit_note": "CRD-NT-",
            "doc_prefix_debit_note": "DBT-NT-",
            "doc_prefix_receipt": "RCT-",
            "doc_prefix_reversal_receipt": "RVS-RCT-",
            "address": "123 Street Road, Suburb, City",
            "phone_no": "0123456789",
            "billing_email": "user@interstellio.io",
            "support_email": "user@interstellio.io",
            "website": "www.interstellio.io",
            "logo_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
        }
    ],
    "metadata": {
        "records": 1,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

POST

/v2/legalentity

(billing)

Create A Legal Entity

Service
billing

Accepted Roles (RBAC)

AdministratorBilling 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)
address	body	string	Address.	X
billing_email	body	string	Billing Email.
currency	body	string	Currency.	X
default_sales_tax_code	body	string	Default Sales Tax Code.
doc_prefix_credit_note	body	string	Doc Prefix Credit Note.
doc_prefix_debit_note	body	string	Doc Prefix Debit Note.
doc_prefix_invoice	body	string	Doc Prefix Invoice.
doc_prefix_receipt	body	string	Doc Prefix Receipt.
doc_prefix_reversal_receipt	body	string	Doc Prefix Reversal Receipt.
name	body	string	Name of Entity.	X
phone_no	body	string	Phone No.
registration_no	body	string	Registration No.	X
sales_tax_no	body	string	Sales Tax No.	X
support_email	body	string	Support Email.
timezone	body	string	Timezone.	X
website	body	string	Website.

Request Example

{
    "registration_no": "XXX",
    "sales_tax_no": "XXX",
    "currency": "ZAR",
    "name": "Company Name",
    "timezone": "Africa/Johannesburg",
    "default_sales_tax_code": "TAX-001",
    "doc_prefix_invoice": "INV-",
    "doc_prefix_credit_note": "CRD-NT-",
    "doc_prefix_debit_note": "DBT-NT-",
    "doc_prefix_receipt": "RCT-",
    "doc_prefix_reversal_receipt": "RVS-RCT-",
    "address": "123 Street Road, Suburb, City",
    "phone_no": "0123456789",
    "billing_email": "user@interstellio.io",
    "support_email": "user@interstellio.io",
    "website": "www.interstellio.io"
}

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
address	body	string	Address.
billing_email	body	string	Billing Email.
currency	body	string	Currency.
default_sales_tax_code	body	string	Default Sales Tax Code.
doc_prefix_credit_note	body	string	Doc Prefix Credit Note.
doc_prefix_debit_note	body	string	Doc Prefix Debit Note.
doc_prefix_invoice	body	string	Doc Prefix Invoice.
doc_prefix_receipt	body	string	Doc Prefix Receipt.
doc_prefix_reversal_receipt	body	string	Doc Prefix Reversal Receipt.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
logo_ref	body	string	Logo Ref.
name	body	string	Name of Entity.
phone_no	body	string	Phone No.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
support_email	body	string	Support Email.
timezone	body	string	Timezone.
website	body	string	Website.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "interstellio.io",
    "registration_no": "XXX",
    "sales_tax_no": "XXX",
    "currency": "ZAR",
    "name": "Company Name",
    "timezone": "Africa/Johannesburg",
    "default_sales_tax_code": "TAX-001",
    "doc_prefix_invoice": "INV-",
    "doc_prefix_credit_note": "CRD-NT-",
    "doc_prefix_debit_note": "DBT-NT-",
    "doc_prefix_receipt": "RCT-",
    "doc_prefix_reversal_receipt": "RVS-RCT-",
    "address": "123 Street Road, Suburb, City",
    "phone_no": "0123456789",
    "billing_email": "user@interstellio.io",
    "support_email": "user@interstellio.io",
    "website": "www.interstellio.io",
    "logo_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

PATCH

/v2/legalentity/{legal_entity_id}

(billing)

Update A Legal Entity

Service
billing

Accepted Roles (RBAC)

AdministratorBilling 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)
legal_entity_id	url	string	Legal Entity Id.	X
address	body	string	Address.
billing_email	body	string	Billing Email.
default_sales_tax_code	body	string	Default Sales Tax Code.
phone_no	body	string	Phone No.
support_email	body	string	Support Email.
website	body	string	Website.

Request Example

{
    "domain": "interstellio.io",
    "name": "Company Name",
    "default_sales_tax_code": "TAX-001",
    "address": "123 Street Road, Suburb, City",
    "phone_no": "0123456789",
    "billing_email": "user@interstellio.io",
    "support_email": "user@interstellio.io",
    "website": "www.interstellio.io",
}

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
address	body	string	Address.
billing_email	body	string	Billing Email.
currency	body	string	Currency.
default_sales_tax_code	body	string	Default Sales Tax Code.
doc_prefix_credit_note	body	string	Doc Prefix Credit Note.
doc_prefix_debit_note	body	string	Doc Prefix Debit Note.
doc_prefix_invoice	body	string	Doc Prefix Invoice.
doc_prefix_receipt	body	string	Doc Prefix Receipt.
doc_prefix_reversal_receipt	body	string	Doc Prefix Reversal Receipt.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
logo_ref	body	string	Logo Ref.
name	body	string	Name of Entity.
phone_no	body	string	Phone No.
registration_no	body	string	Registration No.
sales_tax_no	body	string	Sales Tax No.
support_email	body	string	Support Email.
timezone	body	string	Timezone.
website	body	string	Website.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "interstellio.io",
    "registration_no": "XXX",
    "sales_tax_no": "XXX",
    "currency": "ZAR",
    "name": "Company Name",
    "timezone": "Africa/Johannesburg",
    "default_sales_tax_code": "TAX-001",
    "doc_prefix_invoice": "INV-",
    "doc_prefix_credit_note": "CRD-NT-",
    "doc_prefix_debit_note": "DBT-NT-",
    "doc_prefix_receipt": "RCT-",
    "doc_prefix_reversal_receipt": "RVS-RCT-",
    "address": "123 Street Road, Suburb, City",
    "phone_no": "0123456789",
    "billing_email": "user@interstellio.io",
    "support_email": "user@interstellio.io",
    "website": "www.interstellio.io",
    "logo_ref": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

DELETE

/v2/legalentity/{legal_entity_id}

(billing)

Remove One Legal Entity

Service
billing

Accepted Roles (RBAC)

AdministratorBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
legal_entity_id	url	string	Legal Entity 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

GET

/v2/legalentity/{legal_entity_id}/logo

(billing)

Get A Legal Entity's Logo

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)
legal_entity_id	url	string	Legal Entity 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
upload	body	string	Upload.

Response Example

{
    "upload": {
        "name": "logo.png",
        "type": "image/png",
        "base64": "...",
    }
}

POST

/v2/legalentity/{legal_entity_id}/logo

(billing)

Update A Legal Entity's Logo

Service
billing

Accepted Roles (RBAC)

AdministratorBilling 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)
legal_entity_id	url	string	Legal Entity Id.	X
upload	body	string	Upload.	X

Request Example

{
    "upload": {
        "name": "logo.png",
        "type": "image/png",
        "base64": "...",
    }
}

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

DELETE

/v2/legalentity/{legal_entity_id}/logo

(billing)

Remove A Legal Entity's Logo

Service
billing

Accepted Roles (RBAC)

AdministratorBilling Administrator

Request Parameters

Name	In	Type	Description	MUST include
X-Auth-Token	header	string	Valid Authentication Token. Please see developers documentation/identity.	X
legal_entity_id	url	string	Legal Entity 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 Legal Entity API Resources