Browse the extensions reference

periodCloseStatus

returns PeriodCloseStatus

Close status for all schedules in a fiscal period.

Arguments

NameTypeDescription
periodStartDate!First day of the fiscal period, as YYYY-MM-DD.
periodEndDate!Last day of the fiscal period, as YYYY-MM-DD.

Returns PeriodCloseStatus

Period-close dashboard view — every schedule in scope for the period plus drafted/posted entry totals. Use to drive the close-period UI: schedules with status='draft' are pending close; periodStatus reflects the calendar's lock state for the period.

FieldTypeDescription
fiscalPeriodStartDate!
fiscalPeriodEndDate!
periodStatusString!
schedules[PeriodCloseItem!]!
totalDraftInt!
totalPostedInt!
closeReceiptCloseReceiptReceipt stamped by the close that locked this period: entries_posted, the entries_published_to_qb / entries_posted_locally split, statement stamping and rule summaries, closed_at/closed_by. Null while the period is open, and null for periods closed before receipts shipped (a closed period without a receipt is not a failed close). This is the authoritative record of what a close did — read it rather than retrying when a close's response was lost in transport.

Example

query
{ periodCloseStatus(periodStart: "2026-01-31", periodEnd: "2026-01-31") { fiscalPeriodStart fiscalPeriodEnd periodStatus totalDraft } }
curl
curl -X POST "https://api.robosystems.ai/extensions/$GRAPH_ID/graphql" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "{ periodCloseStatus(periodStart: \"2026-01-31\", periodEnd: \"2026-01-31\") { fiscalPeriodStart fiscalPeriodEnd periodStatus totalDraft } }"}'