Latinum Sales Tax Code API Resources

GET

/v2/salestaxcode/{sales_tax_code_id}

(billing)

Get One Sales Tax Code

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
sales_tax_code_id	url	string	Sales Tax Code 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
code_string	body	string	Code String.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "code_string": "XXXX"
}

GET

/v2/salestaxcode/codestring/{sales_tax_code_string}

(billing)

Get One Sales Tax Code By Code String

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
sales_tax_code_string	url	string	Sales Tax Code String.	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
code_string	body	string	Code String.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "code_string": "XXXX"
}

GET

/v2/salestaxcode/all

(billing)

Get All Sales Tax Codes

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
l	query	integer	Paginate Limit / Entities per Page. (1-50, -1 for streaming)
legal_entity_id	query	string	Filter by legal_entity_id. (can suffix with wildcard )*
p	query	integer	Paginate Current Page. (default 1)
sc	query	string	Sort by Property/Column. (legal_entity_id)
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
code_string	body	string	Code String.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal 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)

Response Example

{
    "payload": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "code_string": "XXXX"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "domain": "domain.com",
            "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "code_string": "XXXX"
        }
    ],
    "metadata": {
        "records": 2,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

GET

/v2/salestaxcode/{sales_tax_code_id}/version/{sales_tax_code_version_id}

(billing)

Get One Sales Tax Code Version

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
sales_tax_code_id	url	string	Sales Tax Code Id.	X
sales_tax_code_version_id	url	string	Sales Tax Code Version 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
active_from	body	string	Active From.
id	body	string	Unique Entity ID.
sales_tax_account_id	body	string	Sales Tax Account Id.
sales_tax_code_id	body	string	Sales Tax Code Id.
tax_percent	body	decimal	Tax Percent.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

GET

/v2/salestaxcode/{sales_tax_code_id}/version

(billing)

Get Active Sales Tax Code Version

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
sales_tax_code_id	url	string	Sales Tax Code Id.	X
date	query	string	Date.	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
active_from	body	string	Active From.
id	body	string	Unique Entity ID.
sales_tax_account_id	body	string	Sales Tax Account Id.
sales_tax_code_id	body	string	Sales Tax Code Id.
tax_percent	body	decimal	Tax Percent.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

GET

/v2/salestaxcode/{sales_tax_code_id}/version/all

(billing)

Get All Sales Tax Code Versions

Service
billing

Accepted Roles (RBAC)

AdministratorBilling AccountantBilling AdministratorStaff 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)
sales_tax_code_id	url	string	Sales Tax Code 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
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)

Response Example

{
    "payload": [
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "tax_percent": 50.00,
            "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active_from": "2024-01-01T12:00:00+00:00"
        },
        {
            "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "tax_percent": 50.00,
            "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "active_from": "2024-02-01T12:00:00+00:00"
        }
    ],
    "metadata": {
        "records": 2,
        "page": 1,
        "pages": 1,
        "per_page": 10
    }
}

POST

/v2/salestaxcode

(billing)

Create a Sales Tax Code

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)
code_string	body	string	Code String.	X
legal_entity_id	body	string	Legal Entity Id.	X

Request Example

{
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "code_string": "XXXX"
}

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
code_string	body	string	Code String.
domain	body	string	Entity Domain.
id	body	string	Unique Entity ID.
legal_entity_id	body	string	Legal Entity Id.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "legal_entity_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "code_string": "XXXX"
}

POST

/v2/salestaxcode/{sales_tax_code_id}/version

(billing)

Create a Sales Tax Code Version

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)
sales_tax_code_id	url	string	Sales Tax Code Id.	X
active_from	body	string	Active From.
sales_tax_account_id	body	string	Sales Tax Account Id.
tax_percent	body	decimal	Tax Percent.

Request Example

{
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

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
active_from	body	string	Active From.
id	body	string	Unique Entity ID.
sales_tax_account_id	body	string	Sales Tax Account Id.
sales_tax_code_id	body	string	Sales Tax Code Id.
tax_percent	body	decimal	Tax Percent.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

POST

/v2/salestaxcode/{sales_tax_code_id}/version

(billing)

Create a Sales Tax Code Version

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)
sales_tax_code_id	url	string	Sales Tax Code Id.	X
active_from	body	string	Active From.
sales_tax_account_id	body	string	Sales Tax Account Id.
tax_percent	body	decimal	Tax Percent.

Request Example

{
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

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
active_from	body	string	Active From.
id	body	string	Unique Entity ID.
sales_tax_account_id	body	string	Sales Tax Account Id.
sales_tax_code_id	body	string	Sales Tax Code Id.
tax_percent	body	decimal	Tax Percent.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "sales_tax_code_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "tax_percent": 50.00,
    "sales_tax_account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "active_from": "2024-01-01T12:00:00+00:00"
}

Navigation

Latinum Sales Tax Code API Resources