Accounting API
Accounting Transactions
GET /billing/{tenantLocator}/accounting/faTransactions/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:AccountingTransactionResponse
Security Group:accounting  Permission:read
AccountingTransactionResponse
¶requiredfaTransactionLocator locatorcurrency stringfaTransactionNote stringfaTransactionTime datetimeaccountLines AccountLineItem[]
Accounting T-Accounts
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 | locator | required |
currency | query | string? | optional |
size | query | int? | optional |
Response:LedgerAccountResponse
Security Group:accounting  Permission:read
LedgerAccountListResponse
¶requiredlistCompleted booleanitems LedgerAccountResponse[]
LedgerAccountResponse
¶requiredreferenceLocator locatorcurrency stringbalance numberreferenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalancelineItems LedgerAccountLineItem[]
AccountLineItem
¶requiredreferenceLocator locatoraccountingType Enum credit | debitamount numberreferenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalance
LedgerAccountLineItem
¶requiredfaTransactionLocator locatoraccountingType Enum credit | debitamount numberfaTransactionNote stringfaTransactionTime 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.
GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash/{accountLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
accountLocator | path | locator | required |
currency | query | string? | optional |
size | query | int? | optional |
Response:LedgerAccountResponse
Security Group:accounting  Permission:read
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
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
¶requiredcurrency stringbalance number