Reporting and Reconciliation

Choose a reporting contract, supply the required records, and verify what a report actually establishes.

Choose the reporting surface by the system that owns the data. Commerce computation endpoints and ResponseCX analytics have different inputs and outputs. This page replaces legacy analytics links that led into an unlisted StateSet One reference.

Commerce HTTP reports require a provisioned deployment. Check the host report and Commerce overview. A report endpoint in the reference is not a promise of a public reporting service.

Choose a report

Question	Contract	What to inspect
Are supplied cost and valuation records ready for close?	Close readiness	is_ready and zero-cost / zero-valuation items
What is the transaction cost of goods?	Transaction COGS	Required line inputs and returned calculations
How do sales break down by channel?	Sales by channel	Input records and returned grouping
How old is supplied inventory?	Inventory aging	Date inputs and bucket definitions
What was consumed?	Consumption	Required quantities and returned totals
How is customer-support automation performing?	ResponseCX analytics	Workspace scope, reporting window, and response fields

Understand close readiness

Despite the route name, POST /api/v1/reports/close-the-books computes readiness from supplied lines and inventory. Its response identifies zero-cost and zero-valuation entries. Do not interpret that response as a command that closes or locks an accounting period.

This illustrative request body follows the checked-in schema:

{
  "lines": [{ "sku": "MUG-001", "cost": "12.50" }],
  "inventory": [{ "sku": "MUG-001", "quantity": "10", "valuation": "125.00" }]
}

Use the endpoint reference for the request and response contract. Supply your own complete record set; a readiness result for a subset does not establish readiness for the whole organization.

For actual period transitions, follow the period-close workflow and verify the period state and ledger balances independently.

Build a reproducible reporting job

Record the source system, extraction boundary, timezone, currency, included statuses, and input record count. Interpret date boundaries according to the specific endpoint rather than assuming all reports use inclusive dates or the same timezone.

Keep decimal monetary values as decimal strings or exact decimal types. Compare a small fixture with an independently calculated result before processing production records.

Report run: [unique run ID]
Source snapshot: [system, extraction time, and record count]
Contract: [service, endpoint, and version]
Filters: [window, timezone, currency, and statuses]
Verification: [expected fixture result and reconciliation total]
Output: [artifact location and reviewer]

Verify completion

An HTTP success means the request completed according to that endpoint. Inspect the report body and reconcile it with the input set. Separately verify delivery to a destination system; posting an export to another service is a second operation with its own failure handling.

If a scheduled run fails, retain its input identity and inspect any prior output before retrying. See error handling and the integration test plan for recovery checks.

Next steps

• Period close — accounting workflow and independent checks.
• API directory — service hosts and credentials.
• Support checklist — report a mismatch with redacted inputs.