CompuDime API docs

Reference / Schemas

AccountingLine

Type: object.

NameTypeDescription
kind requiredstringWhat the line is. Kinds starting with info_ are informational and never mapped: info_returns, info_discounts, info_group_sales, info_paid_out_tenders, info_account_tenders, info_other_tenders, info_billed_to_account, info_change, info_paper_bags, info_order_deposits, info_non_revenue.
amountnumberThe amount with the register's sign (a net return is negative). Dollars, exact to the cent.
changeDeductednumberThe change given, taken off this tender's total (the store's change tender). Dollars, exact to the cent.
costnumberThe group's cost of goods sold. Dollars, exact to the cent.
countnumberHow many payments made a tender's total.
departmentstringThe department of a department line, upper-cased (<Undefined> for a blank one).
grossnumberThe group's gross sales. Dollars, exact to the cent.
groupintegerThe register group (0-9) of an info_group_sales line.
keyAccountingKey
netnumberNon-revenue net. Dollars, exact to the cent.
returnsnumberNon-revenue returns. Dollars, exact to the cent.
revenueViewstringOn a revenue line: the view it belongs to. The four views describe the same money; a journal entry uses exactly one. One of: total_incl_tax, tax_status, department, department_tax_status.
sidestringThe natural accounting side, a suggestion; the mapping decides in the journal entries. One of: debit, credit.
sourcestringThe tender source: C payments on tickets, O paid-outs, A payments on the account screen.
tenderCodestringThe tender's PayList code(s) on a tender line.
tenderNamestringThe tender's name on an informational tender line.

No other fields appear.