Accounting API

Accounting Transactions

Fetch an Accounting Transaction
fetchAccountingTransaction
GET /billing/{tenantLocator}/accounting/faTransactions/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathlocatorrequired
    Security Group:accounting   Permission:read
AccountingTransactionResponse
required
faTransactionLocator locator
currency string
faTransactionNote string
faTransactionTime datetime
accountLines AccountLineItem[]

Accounting T-Accounts

Fetch a Ledger Account
fetchLedgerAccount
GET /billing/{tenantLocator}/accounting/ledgerAccounts/{refType}/{refLocator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    refTypepathEnum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalancerequired
    refLocatorpathlocatorrequired
    currencyquerystring?optional
    sizequeryint?optional
    Security Group:accounting   Permission:read
LedgerAccountListResponse
required
listCompleted boolean
LedgerAccountResponse
required
referenceLocator locator
currency string
balance number
referenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalance
AccountLineItem
required
referenceLocator locator
accountingType Enum credit | debit
amount number
referenceType Enum accountCreditBalance | cash | charge | credit | installmentItem | invoiceItem | quote | policy | transaction | accountExpenseBalance
LedgerAccountLineItem
required
faTransactionLocator locator
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    accountLocatorpathlocatorrequired
    currencyquerystring?optional
    sizequeryint?optional
    Security Group:accounting   Permission:read
Fetch Multiple Ledger Cash Accounts
fetchMultipleLedgerCashAccounts
GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    currencyquerystring?optional
    sizequeryint?optional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:accounting   Permission:read
Fetch Tenant Level Cash Balance
fetchTenantLevelCashBalance
GET /billing/{tenantLocator}/accounting/ledgerAccounts/cash
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    currencyquerystring?optional
    Security Group:accounting   Permission:read
TenantCashBalance
required
currency string
balance number