Combined P&L Across Stores
get_combined_pnlCombined profit and loss across every linked store for a date range (default: last 30 days), converted into one reporting currency. Set per_store to also get the per-store breakdown. Requires a plan covering more than one store.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | End of the date range, in YYYY-MM-DD format, resolved in the tenant's timezone. Defaults to today. | |
| per_store | No | Include the per-store breakdown alongside the combined totals. | |
| start_date | No | Start of the date range, in YYYY-MM-DD format, resolved in the tenant's timezone. Defaults to 30 days before end_date. | |
| reporting_currency | No | ISO 4217 code to convert every store into. Defaults to the primary store currency. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _meta | No | ||
| reason | No | ||
| totals | No | ||
| message | No | Present on the plan-boundary and no-linked-stores responses, in place of totals. | |
| partial | No | True when unconverted_store_count is non-zero. Say the total is partial rather than presenting it as complete. | |
| _message | No | ||
| available | No | Present, and always false, when the plan covers a single store. Its absence is the success case. | |
| per_store | No | Omitted entirely unless a per-store breakdown was requested. | |
| _truncated | No | ||
| date_range | No | ||
| store_count | No | ||
| _tenant_context | No | ||
| reporting_currency | No | The single currency every total below was converted into. | |
| unconverted_store_count | No | Stores dropped for a missing FX rate. Non-zero means every total is PARTIAL. |