Check status

GET /closeAPI/api/close/period/{id}/check-status
Oidc Oauth2

Path parameters

  • id integer Required

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • result object
      Hide result attributes Show result attributes object
      • message string
      • taskRunning boolean
      • error boolean
    • periodStatus object
      Hide periodStatus attribute Show periodStatus attribute object
      • periodStatus string

        Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.
GET /closeAPI/api/close/period/{id}/check-status 
curl \
 --request GET 'https://customer.trintech.com/closeAPI/api/close/period/{id}/check-status'
Response examples (200) 
{
  "result": {
    "message": "string",
    "taskRunning": true,
    "error": true
  },
  "periodStatus": {
    "periodStatus": "NOT_STARTED"
  }
}