BalanceSheetFilter

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BalanceSheetFilter",
  "title": "BalanceSheetFilter",
  "type": "object",
  "x-apideck-schema-id": "BalanceSheetFilter",
  "example": {
    "start_date": "2021-01-01",
    "end_date": "2021-12-31",
    "period_count": 3,
    "period_type": "month",
    "location_id": "123",
    "accounting_method": "accrual"
  },
  "properties": {
    "start_date": {
      "type": "string",
      "title": "Start date",
      "description": "The start date of the period to include in the resource.",
      "example": "2021-01-01",
      "deprecated": true
    },
    "end_date": {
      "type": "string",
      "title": "End date",
      "description": "The end date of the period to include in the resource.",
      "example": "2021-12-31"
    },
    "period_count": {
      "type": "integer",
      "title": "Period count",
      "description": "The number of periods to include in the resource.",
      "example": 3
    },
    "period_type": {
      "x-apideck-enum-id": "balance-sheet.period-type",
      "type": "string",
      "title": "Period type",
      "description": "The type of period to include in the resource: month, quarter, year.",
      "example": "month",
      "enum": [
        "month",
        "quarter",
        "year"
      ]
    },
    "location_id": {
      "type": "string",
      "title": "Location ID",
      "description": "The ID of the location to include in the resource.",
      "example": "123"
    },
    "accounting_method": {
      "x-apideck-enum-id": "balance-sheet.accounting-method",
      "type": "string",
      "title": "Accounting Method",
      "description": "The accounting method used for the report: cash or accrual.",
      "example": "accrual",
      "enum": [
        "cash",
        "accrual"
      ]
    }
  },
  "additionalProperties": false
}