Accounting API

Accounting Transactions

Fetch an Accounting Transaction

fetchAccountingTransaction

GET /billing/{tenantLocator}/accounting/faTransactions/{locator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:AccountingTransactionResponse

Security Group:accounting Permission:read

AccountingTransactionResponse

¶

required
faTransactionLocator string
currency string
faTransactionNote string
faTransactionTime datetime
accountLines AccountLineItem[]

AccountLineItem

¶

required
referenceLocator string
accountingType Enum credit | debit
amount number
referenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalance

Accounting T-Accounts

Fetch a Ledger Account

¶

fetchLedgerAccount

GET /billing/{tenantLocator}/accounting/ledgerAccounts/{refType}/{refLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
refType	path	Enum accountCreditBalance \| cash \| charge \| credit \| installmentItem \| invoiceItem \| quote \| policy \| transaction \| accountExpenseBalance	required
refLocator	path	string	required
currency	query	string?	optional
size	query	int?	optional

Response:LedgerAccountResponse

Security Group:accounting Permission:read

LedgerAccountListResponse

¶

required
listCompleted boolean
items LedgerAccountResponse[]

LedgerAccountResponse

¶

required
referenceLocator string
currency string
balance number
referenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalance
lineItems LedgerAccountLineItem[]

LedgerAccountLineItem

¶

required
faTransactionLocator string
accountingType Enum credit | debit
amount number
faTransactionNote string
faTransactionTime datetime

Cash Accounts

Cash accounts record inflows and outflows of cash from the system. For example, if a payment is received, the payment itself records the credit, and the customer account’s cash t-account records the debit.

Fetch a Ledger Cash Account

¶

fetchALedgerCashAccount

GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash/{accountLocator}

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
accountLocator	path	string	required
currency	query	string?	optional
size	query	int?	optional

Response:LedgerAccountResponse

Security Group:accounting Permission:read

Fetch Multiple Ledger Cash Accounts

¶

fetchMultipleLedgerCashAccounts

GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash/list

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
currency	query	string?	optional
size	query	int?	optional
offset	query	int?	optional
count	query	int?	optional
extended	query	boolean?	optional

Response:LedgerAccountListResponse

Security Group:accounting Permission:read

Fetch Tenant Level Cash Balance

¶

fetchTenantLevelCashBalance

GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
currency	query	string?	optional

Response:TenantCashBalance

Security Group:accounting Permission:read

TenantCashBalance

¶

required
currency string
balance number