CompuDime API docs

Reference / Schemas

AccountingDay

Type: object.

NameTypeDescription
businessDay requiredstring (date)
departmentTotals requiredstringavailable: every log that sold has department totals; partial: some do; not_enabled: none (the store has not turned on department totals at its registers). One of: available, partial, not_enabled.
externalId requiredstringThe store-day's stable id: ENTERPRISE-STORE-YYYYMMDD from the POS's own codes. It never changes.
lines requiredarray of AccountingLineThe day's totals as labeled lines; a zero line is omitted.
logs requiredarray of AccountingLog
revision requiredstring16 hex characters that change whenever any number behind the day changes. Upsert by externalId when (externalId, revision) is new.
status requiredstringfinal: every log of the day is closed and the day is over at the store. provisional: a log is still open, or the day is not over. no_activity: no register log that day. One of: final, provisional, no_activity.
store requiredAccountingStore
checksAccountingChecks
cogsSourcestringWhere COGS comes from: the department totals when available, else the register's group totals. One of: departments, groups.

No other fields appear.