Skip to main content

Get Settlement

GET 

/v1/profitability/settlements/:settlementId

Read one visible channel statement with its declared amount and the transactions captured against it. An out-of-scope statement reads as 404.

Requires profitability.read.

Request and response fields at a glance
  • Path parameters: settlementId (integer, required).
  • 200 response (application/json): groups (array, required), settlementId (number, required), saleChannelAccountId (number, required), saleChannelId (number, required), brandId (number, required), externalContractId (mixed, required), externalStatementId (string, required), statementDate (string, required), periodStart (mixed, required), periodEnd (mixed, required), declaredTotal (mixed, required), transactionsTotal (mixed, required), currency (string, required).

Request​