read
The fiscal years and periods of one entity, with their open or closed status.
Periods by start date, each with its fiscal year. A closed period accepts no posting. Keyset-paged: pass page.next_cursor back as cursor while page.has_more is true. page.truncated is true only when a server-side bound cut this page short of what was asked; it is never a silent cut.
The GET form of finance_periods_list: the same arguments as query parameters.
get/api/v1/finance/periods
Request
- Base URL: https://app.magistry.io
- URL: https://app.magistry.io/api/v1/finance/periods
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://app.magistry.io/api/oauth/authorize, token URL https://app.magistry.io/api/oauth/token, scopes: finance:read)
Query parameters
entity_idstring uuid required
The entity, one of those this app was granted (GET /api/v1/finance/entities lists them). In a GET query string entity is accepted too.
period_idstring uuid
Only this period.
cursorstring
The next_cursor of the previous page. Opaque.
limitinteger
Items per page.
entitystring uuid
Alias of entity_id; give one of the two.
Response
Result
Changes
No recorded changes to this operation across all 2 revisions of this API.