Latinum Report API Resources

GET

/v2/report/customer/transaction

(billing)

Get Customer Transaction Report CSV

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	query	string	Customer Account Id.	X
include_currency	query	boolean	Include Currency.	X
legal_entity_id	query	string	Legal Entity Id.	X
report_end	query	string	Report End.	X
report_start	query	string	Report Start.	X

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
Balance	body	decimal	Balance.
Credit	body	decimal	Credit.
Date	body	string	Date.
Debit	body	decimal	Debit.
Description	body	string	Description.

GET

/v2/report/account/transaction

(billing)

Get Account Transaction Report CSV

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)
account_id	query	string	Account Id.	X
include_currency	query	boolean	Include Currency.	X
legal_entity_id	query	string	Legal Entity Id.	X
report_end	query	string	Report End.	X
report_start	query	string	Report Start.	X

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
Balance	body	decimal	Balance.
Credit	body	decimal	Credit.
Date	body	string	Date.
Debit	body	decimal	Debit.
Description	body	string	Description.

GET

/v2/report/legalentity/trialbalance

(billing)

Get Legal Entity Trial Balance

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)
legal_entity_id	query	string	Legal Entity Id.	X
report_end	query	string	Report End.	X
report_start	query	string	Report Start.	X

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
accounts	body	array	Accounts.
closing_balance	body	decimal	Closing Balance.

Response Example

{
    "accounts": [
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "account_name": "Receivable Account",
            "account_code": "RCV-001",
            "account_type": "ACC_RECEIVABLE",
            "account_category": "CURRENT_ASSETS",
            "debit": "100",
            "credit": "100",
        },
        {
            "account_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "account_name": "Sales Account",
            "account_code": "SALE-001",
            "account_type": "SALES_ACC",
            "account_category": "REVENUE",
            "debit": "100",
            "credit": "100",
        }
    ],
    "closing_balance": "0"
}

GET

/v2/report/account/balance

(billing)

Get Account Balance Report

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)
account_id	query	string	Account Id.	X
legal_entity_id	query	string	Legal Entity Id.	X
report_aggregate	query	string	Report Aggregate.	X
report_end	query	string	Report End.	X
report_start	query	string	Report Start.	X

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
closing_balance	body	decimal	Closing Balance.
lines	body	array	Lines.
opening_balance	body	decimal	Opening Balance.

Response Example

{
    "opening_balance": "R0.00",
    "closing_balance": "R100.00",
    "lines": [
        {
            "date": "2020-01-01",
            "balance": "R0.00"
        },
        {
            "date": "2020-02-01",
            "balance": "R50.00"
        },
        {
            "date": "2020-03-01",
            "balance": "R100.00"
        }
    ]
}

GET

/v2/report/customer/balance

(billing)

Get Customer Account Balance Report

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	query	string	Customer Account Id.	X
legal_entity_id	query	string	Legal Entity Id.	X
report_aggregate	query	string	Report Aggregate.	X
report_end	query	string	Report End.	X
report_start	query	string	Report Start.	X

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
closing_balance	body	decimal	Closing Balance.
lines	body	array	Lines.
opening_balance	body	decimal	Opening Balance.

Response Example

{
    "opening_balance": "R0.00",
    "closing_balance": "R100.00",
    "lines": [
        {
            "date": "2020-01-01",
            "balance": "R0.00"
        },
        {
            "date": "2020-02-01",
            "balance": "R50.00"
        },
        {
            "date": "2020-03-01",
            "balance": "R100.00"
        }
    ]
}

GET

/v2/report/document/invoice/csv

(billing)

Get Customer Invoice Report CSV

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)
customer_account_id	query	string	Customer Account Id.
format_identifier	query	string	Format Identifier.
include_currency	query	boolean	Include Currency.	X
include_headings	query	boolean	Include Headings.	X
legal_entity_id	query	string	Legal Entity Id.	X
range_end	query	string	Range End.	X
range_start	query	string	Range Start.	X

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
Customer Name	body	string	Customer Name.
Date	body	string	Date.
Document Number	body	string	Document Number.
Total (excl.)	body	string	Total Excl.
Total (incl.)	body	string	Total Incl.
Total (tax)	body	string	Total Tax.

GET

/v2/report/document/creditnote/csv

(billing)

Get Customer Credit Note Report CSV

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)
customer_account_id	query	string	Customer Account Id.
format_identifier	query	string	Format Identifier.
include_currency	query	boolean	Include Currency.
include_headings	query	boolean	Include Headings.
legal_entity_id	query	string	Legal Entity Id.
range_end	query	string	Range End.
range_start	query	string	Range Start.

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
Customer Name	body	string	Customer Name.
Date	body	string	Date.
Document Number	body	string	Document Number.
Total (excl.)	body	string	Total Excl.
Total (incl.)	body	string	Total Incl.
Total (tax)	body	string	Total Tax.

GET

/v2/report/document/debitnote/csv

(billing)

Get Customer Debit Note Report CSV

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)
customer_account_id	query	string	Customer Account Id.
format_identifier	query	string	Format Identifier.
include_currency	query	boolean	Include Currency.	X
include_headings	query	boolean	Include Headings.	X
legal_entity_id	query	string	Legal Entity Id.	X
range_end	query	string	Range End.	X
range_start	query	string	Range Start.	X

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
Customer Name	body	string	Customer Name.
Date	body	string	Date.
Document Number	body	string	Document Number.
Total (excl.)	body	string	Total Excl.
Total (incl.)	body	string	Total Incl.
Total (tax)	body	string	Total Tax.

GET

/v2/report/document/receipt/csv

(billing)

Get Customer Receipt Report CSV

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)
customer_account_id	query	string	Customer Account Id.
format_identifier	query	string	Format Identifier.
include_currency	query	boolean	Include Currency.	X
include_headings	query	boolean	Include Headings.	X
legal_entity_id	query	string	Legal Entity Id.	X
range_end	query	string	Range End.	X
range_start	query	string	Range Start.	X

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
Customer Name	body	string	Customer Name.
Date	body	string	Date.
Document Number	body	string	Document Number.
Total (excl.)	body	string	Total Excl.
Total (incl.)	body	string	Total Incl.
Total (tax)	body	string	Total Tax.

GET

/v2/report/document/reversalreceipt/csv

(billing)

Get Customer Reversal Receipt Report CSV

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)
customer_account_id	query	string	Customer Account Id.
format_identifier	query	string	Format Identifier.
include_currency	query	boolean	Include Currency.	X
include_headings	query	boolean	Include Headings.	X
legal_entity_id	query	string	Legal Entity Id.	X
range_end	query	string	Range End.	X
range_start	query	string	Range Start.	X

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
Customer Name	body	string	Customer Name.
Date	body	string	Date.
Document Number	body	string	Document Number.
Total (excl.)	body	string	Total Excl.
Total (incl.)	body	string	Total Incl.
Total (tax)	body	string	Total Tax.

POST

/v2/report/format

(billing)

Create new Report Format

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)
format	body	object	Format.
identifier	body	string	Identifier.
report_type	body	string	Report Type.

Request Example

{
    "identifier": "XXXXXX",
    "report_type": "document_with_line_items",
    "format": {
        "fields": [
        {
            "order": 1,
            "title": "Date",
            "content_type": "dynamic",
            "content": "date"
        },
        {
            "order": 2,
            "title": "Document Number",
            "content_type": "dynamic",
            "content": "document_number"
        },
        {
            "order": 3,
            "title": "Customer",
            "content_type": "dynamic",
            "content": "customer_name"
        },
        {
            "order": 4,
            "title": "Total (excl.)",
            "content_type": "dynamic",
            "content": "excluding_total"
        },
        {
            "order": 5,
            "title": "Total (incl.)",
            "content_type": "dynamic",
            "content": "including_total"
        },
        {
            "order": 6,
            "title": "Tax",
            "content_type": "dynamic",
            "content": "tax_total"
        }
        ]
    }
}

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
domain	body	string	Entity Domain.
format	body	string	Format.
id	body	string	Unique Entity ID.
identifier	body	string	Identifier.
report_type	body	string	Report Type.

Response Example

{
    [
        "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "domain": "domain.com",
        "identifier": "XXXXXX",
        "report_type": "document_with_line_items",
        "format": {
            "fields": [
                {
                    "order": 0,
                    "title": "Date",
                    "content_type": "dynamic",
                    "content": "date"
                },
                {
                    "order": 1,
                    "title": "Document Number",
                    "content_type": "dynamic",
                    "content": "document_number"
                },
                {
                    "order": 2,
                    "title": "Customer",
                    "content_type": "dynamic",
                    "content": "customer_name"
                },
                {
                    "order": 3,
                    "title": "Total (excl.)",
                    "content_type": "dynamic",
                    "content": "excluding_total"
                },
                {
                    "order": 4,
                    "title": "Total (incl.)",
                    "content_type": "dynamic",
                    "content": "including_total"
                },
                {
                    "order": 5,
                    "title": "Tax",
                    "content_type": "dynamic",
                    "content": "tax_total"
                }
            ]
        }
    ]
}

GET

/v2/report/format

(billing)

Get One Report Format

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)
identifier	query	string	Identifier.	X
report_type	query	string	Report Type.	X

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
domain	body	string	Entity Domain.
format	body	string	Format.
id	body	string	Unique Entity ID.
identifier	body	string	Identifier.
report_type	body	string	Report Type.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "identifier": "XXXXXX",
    "report_type": "document_with_line_items",
    "format": {
        "fields": [
            {
                "order": 1,
                "title": "Date",
                "content_type": "dynamic",
                "content": "date"
            },
            {
                "order": 2,
                "title": "Document Number",
                "content_type": "dynamic",
                "content": "document_number"
            },
            {
                "order": 3,
                "title": "Customer",
                "content_type": "dynamic",
                "content": "customer_name"
            },
            {
                "order": 4,
                "title": "Total (excl.)",
                "content_type": "dynamic",
                "content": "excluding_total"
            },
            {
                "order": 5,
                "title": "Total (incl.)",
                "content_type": "dynamic",
                "content": "including_total"
            },
            {
                "order": 6,
                "title": "Tax",
                "content_type": "dynamic",
                "content": "tax_total"
            }
        ]
    }
}

GET

/v2/report/format/{report_format_id}

(billing)

Get One Report Format By ID

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)
report_format_id	url	string	Report Format 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
domain	body	string	Entity Domain.
format	body	string	Format.
id	body	string	Unique Entity ID.
identifier	body	string	Identifier.
report_type	body	string	Report Type.

Response Example

{
    "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "domain": "domain.com",
    "identifier": "XXXXXX",
    "report_type": "document_with_line_items",
    "format": {
        "fields": [
            {
                "order": 1,
                "title": "Date",
                "content_type": "dynamic",
                "content": "date"
            },
            {
                "order": 2,
                "title": "Document Number",
                "content_type": "dynamic",
                "content": "document_number"
            },
            {
                "order": 3,
                "title": "Customer",
                "content_type": "dynamic",
                "content": "customer_name"
            },
            {
                "order": 4,
                "title": "Total (excl.)",
                "content_type": "dynamic",
                "content": "excluding_total"
            },
            {
                "order": 5,
                "title": "Total (incl.)",
                "content_type": "dynamic",
                "content": "including_total"
            },
            {
                "order": 6,
                "title": "Tax",
                "content_type": "dynamic",
                "content": "tax_total"
            }
        ]
    }
}

DELETE

/v2/report/format/{report_format_id}

(billing)

Remove Report Format

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
report_format_id	url	string	Report Format 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 Report API Resources