CompuDime API docs

Reference / Schemas

AccountingJournalResponse

Type: object.

NameTypeDescription
entries requiredarray of AccountingJournalEntryOne journal entry per store-day, in day order. One row is one store-day. Any range may be asked for (no limit on its span); one answer holds at most limit store-days (default 100) and a nextCursor for the rest. The store is read in several jobs for a long range, and an answer that reaches the request's reading budget holds the days read so far and a nextCursor, so a long range never turns into a timeout. A day after the store's own today is never returned. Every day of the range is a row, a day without a register log included (status no_activity): a missing day is never confused with a failed read.
from requiredstring (date)
generatedAt requiredstring (date-time)When the store agent read the data from the POS.
maxAdjustment requirednumberThe adjustment limit applied. Dollars, exact to the cent.
nextCursor requiredstringPass as cursor (with the same from and to) to read the next days; empty when the range is done.
requestId requiredstring
source requiredstringAlways live: read from the store at request time. One of: live.
to requiredstring (date)
billingBillingMeta

Other fields can appear later. Ignore the ones you do not know.

Used by