Get All Periods

GET /cs-close-api/periods

Retrieve all periods according to the specified pagination parameters, with the option to apply filters on fields such as id, fiscalYearId, status, and name.

The "status" field can have values like "NOT_STARTED," "IN_PROGRESS," "COMPLETE," "DELETED", or "DISABLED" for more refined data selection if needed.

Query parameters

page integer(int32)

The page define the current page number. It should be positive integer number and should start with minimum value 1.

Minimum value is 1.
size integer(int32)

The size define number of records on each page. It should be positive integer number between 1 to 10000.

Minimum value is 1, maximum value is 10000.
sort array[string]

The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.
name string

The name parameter is an optional filter that allows you to narrow down the results based on specific name content.
id string

id for filter the period details.
fiscalYearId string

fiscalYearId for filter the period details for fetch the period of the specific fiscalYear.
status string

Status for filter the period details. status values can be "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "DELETED", or "DISABLED".

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- result array[object]
  
  Hide result attributes Show result 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)
- metadata object
  
  Paging metadata dto.
  
  Hide metadata attributes Show metadata attributes object
  
  totalElements integer(int64)
  
  The total number of rows in the result set.
  
  totalPages integer(int32)
  
  The total number of pages in the result set, should = totalElements / size
  
  first boolean
  
  True if this is the first page.
  
  last boolean
  
  True if this is the last page.
  
  empty boolean
  
  True if the result is empty.
  
  numberOfElements integer(int32)
  
  The number of results in this page. Will be <= size.
  
  size integer(int32)
  
  The page size.
  
  sorted boolean
  
  True if the results are sorted.

GET /cs-close-api/periods

curl \
 --request GET 'http://close-service:8082/cs-close-api/periods'

Response examples (200)

{
  "result": [
    "{\n    \"id\": 37,\n    \"name\": \"Sep\",\n    \"year\": \"2018\",\n    \"status\": \"IN_PROGRESS\",\n    \"startDate\": \"2017-09-01\",\n    \"endDate\": \"2017-09-30\",\n    \"closeDayStartDate\": \"2017-09-01\",\n    \"closeDayEndDate\": \"2017-09-30,\n    \"completionDate\": null\n}\n"
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}