THthredfi
v1

GET /v1/platform/accounting-periods/{period_id}/

ViewSet for Accounting Period operations.

Provides:

  • List: GET /accounting-periods/
  • Create: POST /accounting-periods/
  • Close: POST /accounting-periods/{period_id}/close/
  • Reopen: POST /accounting-periods/{period_id}/reopen/
  • Checklist: GET /accounting-periods/{period_id}/close-checklist/

Request

  • Base URL
    https://docs.thredfi.com (the document declares no server; this is the origin it was published from)
  • Auth
    • HTTP bearer
    • or HTTP bearer
    • or HTTP basic
    • or HTTP bearer
    • or HTTP bearer

Path parameters

period_idstring uuid required

A UUID string identifying this accounting period.

Response

idstring uuid required
business_idstring uuid required
yearinteger required
monthinteger required
period_namestring required
statusstring required
start_datestring date required
end_datestring date required
is_lockedboolean required
allows_changesboolean required
requires_overrideboolean required
closed_atstring date-time nullable required
closed_bystring required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.