ReportTransactionYear POST
permite visualizar relatório de transações por ano
/report-transaction-year
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| year | string | Formato yyyy |
YES |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/json |
| Content-Type | application/json |
| Authorization | Bearer token |
Request Body
{
"year": "2021"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
| Header | Value |
|---|---|
| Content-Type | application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Response Body
{
"reference": "2023",
"data": {
"qty_total": {
"code": "qty_total",
"value": "42",
"label": "Quantidade de transações"
},
"amount_total": {
"code": "amount_total",
"value": "9696.08",
"label": "Valor total das transações"
},
"qty_paid": {
"code": "qty_paid",
"value": "37",
"label": "Quantidade de transações pagas"
},
"amount_paid": {
"code": "amount_paid",
"value": "8418.27",
"label": "Valor das transações pagas"
},
"qty_notpaid": {
"code": "qty_notpaid",
"value": "5",
"label": "Quantidade de transações não pagas"
},
"amount_notpaid": {
"code": "amount_notpaid",
"value": "1277.81",
"label": "Valor das transações não pagas"
},
"qty_refunded": {
"code": "qty_refunded",
"value": "0",
"label": "Quantidade de transações estornadas"
},
"amount_refunded": {
"code": "amount_refunded",
"value": 0,
"label": "Valor das transações estornadas"
},
"qty_chargeback": {
"code": "qty_chargeback",
"value": "0",
"label": "Quantidade de transações de chargeback"
},
"amount_chargeback": {
"code": "amount_chargeback",
"value": 0,
"label": "Valor de chargeback"
},
"paid_pix": {
"code": "paid_pix",
"value": "8418.27",
"label": "Total Recebido em Pix"
},
"paid_boleto": {
"code": "paid_boleto",
"value": 0,
"label": "Total Recebido em Boleto"
},
"total_fee": {
"code": "total_fee",
"value": "42.10",
"label": "Valor total das tarifas"
},
"total_amount": {
"code": "total_amount",
"value": "8376.17",
"label": "Valor Líquido"
}
}
}