Accounting API

Action	Endpoint
Fetch an Accounting Transaction	GET/billing/{tenantLocator}/accounting/faTransactions/{locator}
Fetch a Ledger Account	GET/billing/{tenantLocator}/accounting/ledgerAccounts/{refType}/{refLocator}
Fetch Multiple Ledger Cash Accounts	GET/billing/{tenantLocator}/accounting/ledgerAccounts/cash/list
Fetch Tenant Level Cash Balance	GET/billing/{tenantLocator}/accounting/ledgerAccounts/cash

Accounting Transactions

Fetch an Accounting Transaction

Fetch an Accounting TransactionfetchAccountingTransaction

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AccountingTransactionResponse

Security Group:accounting

Permission:

read

AccountingTransactionResponse

Required properties

Property	Type	Description
`faTransactionLocator`	`ulid`
`currency`	`string`
`faTransactionNote`	`string`
`faTransactionTime`	`datetime`
`accountLines`	`AccountLineItem[]`

AccountLineItem

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`accountingType`	`Enum credit \| debit`
`amount`	`number`
`referenceType`	`Enum accountCreditBalance \| invoiceCreditBalance \| cash \| creditCash \| charge \| credit \| installmentItem \| invoiceItem \| account \| policy \| accountExpenseBalance`

Accounting T-Accounts

Fetch a Ledger Account

Fetch a Ledger AccountfetchLedgerAccount

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`refType`	path	`Enum accountCreditBalance \| invoiceCreditBalance \| cash \| creditCash \| charge \| credit \| installmentItem \| invoiceItem \| account \| policy \| accountExpenseBalance`	Yes
`refLocator`	path	`ulid`	Yes
`currency`	query	`string?`	No
`size`	query	`integer?`	No

Response:LedgerAccountResponse

Security Group:accounting

Permission:

read

LedgerAccountResponse

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`currency`	`string`
`balance`	`number`
`referenceType`	`Enum accountCreditBalance \| invoiceCreditBalance \| cash \| creditCash \| charge \| credit \| installmentItem \| invoiceItem \| account \| policy \| accountExpenseBalance`
`lineItems`	`LedgerAccountLineItem[]`

LedgerAccountLineItem

Required properties

Property	Type	Description
`faTransactionLocator`	`ulid`
`accountingType`	`Enum credit \| debit`
`amount`	`number`
`faTransactionNote`	`string`
`faTransactionTime`	`datetime`

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 Multiple Ledger Cash Accounts

Fetch Multiple Ledger Cash AccountsfetchMultipleLedgerCashAccounts

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`currency`	query	`string?`	No
`size`	query	`integer?`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:LedgerAccountListResponse

Security Group:accounting

Permission:

read

LedgerAccountListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`LedgerAccountResponse[]`

Fetch Tenant Level Cash Balance

Fetch Tenant Level Cash BalancefetchTenantLevelCashBalance

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`currency`	query	`string?`	No

Response:TenantCashBalance

Security Group:accounting

Permission:

read

TenantCashBalance

Required properties

Property	Type	Description
`currency`	`string`
`balance`	`number`

Accounting API

Accounting Transactions

Fetch an Accounting Transaction

Accounting T-Accounts

Fetch a Ledger Account

Cash Accounts

Fetch Multiple Ledger Cash Accounts

Fetch Tenant Level Cash Balance

On this page