|
3 | 3 |
|
4 | 4 | ## Fields |
5 | 5 |
|
6 | | -| Field | Type | Required | Description | Example | |
7 | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | |
8 | | -| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | |
9 | | -| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | |
10 | | -| `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | |
11 | | -| `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter, however Codat will limit the number of periods to request to 12 periods. | | |
12 | | -| `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | |
13 | | -| `period_unit` | [shared.PeriodUnit](../../models/shared/periodunit.md) | :heavy_check_mark: | The period unit of time returned. | | |
14 | | -| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | |
15 | | -| `show_input_values` | *Optional[bool]* | :heavy_minus_sign: | If set to true, then the system includes the input values within the response. | | |
| 6 | +| Field | Type | Required | Description | Example | |
| 7 | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | |
| 8 | +| `company_id` | *str* | :heavy_check_mark: | N/A | 8a210b68-6988-11ed-a1eb-0242ac120002 | |
| 9 | +| `connection_id` | *str* | :heavy_check_mark: | N/A | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | |
| 10 | +| `include_display_names` | *Optional[bool]* | :heavy_minus_sign: | Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. | | |
| 11 | +| `number_of_periods` | *int* | :heavy_check_mark: | The number of periods to return. There will be no pagination as a query parameter. | | |
| 12 | +| `period_length` | *int* | :heavy_check_mark: | The number of months per period. E.g. 2 = 2 months per period. | | |
| 13 | +| `period_unit` | [shared.PeriodUnit](../../models/shared/periodunit.md) | :heavy_check_mark: | The period unit of time returned. | | |
| 14 | +| `report_date` | *str* | :heavy_check_mark: | The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month. | 29-09-2020 | |
| 15 | +| `show_input_values` | *Optional[bool]* | :heavy_minus_sign: | If set to true, then the system includes the input values within the response. | | |
0 commit comments