CompuDime API docs

Reference / Schemas

AccountingJournalEntry

Type: object.

NameTypeDescription
adjustment requiredobject
adjustment.account requiredAccountingAccount or nullWhere the difference was posted (Sales/Adjustment); null when nothing was posted.
adjustment.amount requirednumberThe difference between debits and credits before the adjustment. Dollars, exact to the cent.
adjustment.sidestring One of: debit, credit.
businessDay requiredstring (date)
externalId requiredstringThe store-day's stable id (as on the summary); upsert by it.
lines requiredarray of AccountingJournalLine
logs requiredarray of AccountingLog
mapping requiredobject
mapping.version requiredstringA hash of the mapping's items.
mapping.updatedAtstring (date-time)
memo requiredstringRegister sales <day>, logs <numbers>.
revision requiredstring16 hex characters over the posted lines, the entity, the class, the status and the mapping version.
skipped requiredarray of AccountingSkippedNon-zero lines no mapping posts; never dropped silently.
status requiredstringPost ready entries only. provisional: the day is not final; needs_attention: a blocking warning; no_activity: no register log that day. One of: ready, provisional, needs_attention, no_activity.
store requiredAccountingStore
totals requiredobject
totals.credit requirednumberTotal credits. Dollars, exact to the cent.
totals.debit requirednumberTotal debits. Dollars, exact to the cent.
warnings requiredarray of AccountingWarning
classstringThe mapping's Info/ItemClassName value.
entitystringThe mapping's Info/CustomerName value.
revenueViewstring One of: total_incl_tax, tax_status, department, department_tax_status.

No other fields appear.