Get Periods based on Identifier

GET /periods/{id}
Oauth2

Obtain precise period information by specifying the ID provided. This allows for targeted retrieval of the desired period's details.

Path parameters

  • id integer Required

    Filters periods by their unique identifier.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • name string
    • year string
    • status string

      Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.

    • startDate string(date)
    • endDate string(date)
    • closeDayStartDate string(date)
    • closeDayEndDate string(date)
    • completionDate string(date-time)
GET /periods/{id} 
curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/periods/{id}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
    "id": 37,
    "name": "Sep",
    "year": "2018",
    "status": "IN_PROGRESS",
    "startDate": "2017-09-01",
    "endDate": "2017-09-30",
    "closeDayStartDate": "2017-09-01",
    "closeDayEndDate": "2017-09-30,
    "completionDate": null
}