group-reports

← All modules

3 endpoints.

GET /api/v1/group-reports/trial-balance

Trial Balance

Closing balance per account per business, as at to.

The totals row is the report's proof of itself — a consolidated trial balance that doesn't come to zero is telling you something, so it is shown rather than asserted.

Parameters

Name	In	Required	Type	Description
from	query	yes	string
to	query	yes	string

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Trial Balance Api V1 Group Reports Trial Balance Get"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

GET /api/v1/group-reports/profit-loss

Profit Loss

Income and expense for the period, per business, and the group's net profit.

Parameters

Name	In	Required	Type	Description
from	query	yes	string
to	query	yes	string

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Profit Loss Api V1 Group Reports Profit Loss Get"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}

---

GET /api/v1/group-reports/balance-sheet

Balance Sheet

Assets, liabilities and equity per business as at a date, with the current period's earnings closing into equity — the same treatment the per-site Balance Sheet gives them, so the two agree business by business.

Parameters

Name	In	Required	Type	Description
as_on	query	yes	string

200 — Successful Response

{
  "type": "object",
  "additionalProperties": true,
  "title": "Response Balance Sheet Api V1 Group Reports Balance Sheet Get"
}

422 — Validation Error

{
  "properties": {
    "detail": {
      "items": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "type": "array",
      "title": "Detail"
    }
  },
  "type": "object",
  "title": "HTTPValidationError"
}