Statement

Statements list

This operation returns a list of statements for the authenticated user

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

List of statements returned

post/v1/statements
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "statements": [
    ]
}

User statements list

Returns a list of all user statements in a paginated format.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
object (ExternalBusinessRequestDto)
object (ExternalListStatementsQueryParams)
Responses
200

Statements returned

post/v1/statements/paginated
Request samples
application/json
{
  • "businessRequest": {
    },
  • "queryParams": {
    }
}
Response samples
application/json
{
  • "statements": [
    ],
  • "currentPage": 0,
  • "pageSize": 0,
  • "totalPages": 0,
  • "totalItems": 0
}

Overall statements penalty summary

Returns a summary of all penalties or compensation assessed on all statements.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Statement penalty summary returned

post/v1/statements/penalty/summary
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "compensationToBeCollected": {
    },
  • "penaltyToBePaid": {
    },
  • "closedStatements": {
    }
}