Reference
Queries#
cashflowReport#
Historical cashflow for a company: opening/closing liquid balance, inflow/outflow by month and category. Amounts are minor units. Not a forecast — use forecastReport for expected/estimated future cash and profit.
Requires: scope reports:read · feature advanced_reports.
cashflowReport(profileId: ID!, start: DateTime, end: DateTime): CashflowReport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
start | DateTime | |
end | DateTime |
forecastReport#
Forward cash and profit forecast for months ahead (includes the current month). Expected lines come from open invoices, recurring, and loan installments; estimated lines are a history run-rate with mid/low/high bands. enoughHistory is false when estimates are zero. Plan-gated. Not historical cashflow (cashflowReport) and not the booked P&L (financialStatement).
Requires: scope reports:read · feature forecasts.
forecastReport(profileId: ID!, months: Int!): ForecastReport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
months | Int! |
debtorReport#
Accounts receivable aging: who owes the company, invoices, and days overdue as of end. Amounts are minor units.
Requires: scope reports:read · feature advanced_reports.
debtorReport(profileId: ID!, end: DateTime): DebtorCreditorReport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
end | DateTime |
creditorReport#
Accounts payable aging: who the company owes, bills, and days overdue as of end. Amounts are minor units.
Requires: scope reports:read · feature advanced_reports.
creditorReport(profileId: ID!, end: DateTime): DebtorCreditorReport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
end | DateTime |
profileUsageReport#
Counts of processed documents and booked/draft invoices in a period. Usage metrics, not money.
Requires: scope reports:read.
profileUsageReport(profileId: ID!, start: DateTime, end: DateTime): ProfileUsageReport!
| Argument | Type | |
|---|---|---|
profileId | ID! | |
start | DateTime | |
end | DateTime |
reportTemplates#
Requires: scope reports:read.
reportTemplates(bookkeeperId: ID, profileId: ID): [ReportTemplate!]!
| Argument | Type | |
|---|---|---|
bookkeeperId | ID | |
profileId | ID |
reportTemplatePreview#
HTML preview of a template layer on a dossier’s live data.
Requires: scope reports:read.
reportTemplatePreview(dossierId: ID!, layer: JSONObject!, package: String!): String!
| Argument | Type | |
|---|---|---|
dossierId | ID! | |
layer | JSONObject! | |
package | String! |
Mutations#
saveReportTemplate#
Requires: scope reports:write.
saveReportTemplate(input: SaveReportTemplateInput!): ReportTemplate!
| Argument | Type | |
|---|---|---|
input | SaveReportTemplateInput! |
deleteReportTemplate#
Requires: scope reports:write.
deleteReportTemplate(id: ID!): Boolean!
| Argument | Type | |
|---|---|---|
id | ID! |