Get submitted declaration search task status

GET

str

submitted-declarations

{taskId}

curl --request GET \
  --url https://str.keroshospitality.com/api/v1/str/submitted-declarations/{taskId} \
  --header 'Authorization: Bearer <token>'

{
  "taskId": 123,
  "status": "IN_PROGRESS",
  "submittedDeclarations": [
    {
      "serialNumber": "1234567890",
      "fromDate": "2022-01-01",
      "toDate": "2022-01-01",
      "rent": 100,
      "cancellationAmount": 10,
      "submissionDate": "2022-01-01",
      "isOverdue": false
    }
  ],
  "lastUpdated": "2022-01-01T00:00:00Z"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

taskId

string

required

The task ID

Response

200 - application/json

Search task status retrieved successfully

taskId

integer

Example:

123

status

enum<string>

Available options:

IN_PROGRESS,

COMPLETED,

FAILED

Example:

"IN_PROGRESS"

submittedDeclarations

object[]

Show child attributes

lastUpdated

string<date-time>

Example:

"2022-01-01T00:00:00Z"

Upload a TAKK taskCreate a new TAKK upload task for climate fee statements. ### Allowed Roles: `admin`, `takk-uploader`

Get submitted declaration search task status

curl --request GET \
  --url https://str.keroshospitality.com/api/v1/str/submitted-declarations/{taskId} \
  --header 'Authorization: Bearer <token>'

{
  "taskId": 123,
  "status": "IN_PROGRESS",
  "submittedDeclarations": [
    {
      "serialNumber": "1234567890",
      "fromDate": "2022-01-01",
      "toDate": "2022-01-01",
      "rent": 100,
      "cancellationAmount": 10,
      "submissionDate": "2022-01-01",
      "isOverdue": false
    }
  ],
  "lastUpdated": "2022-01-01T00:00:00Z"
}