Extrato
GET
https://api.eduzz.com/myeduzz/v2/financial/statement
Required scopes:myeduzz_financial_read
Retorna o extrato financeiro com base nos filtros fornecidos.
Query params
page
number
Página atual
itemsPerPage
number
Número de itens por página
startDate
datetime
Data de início do período
endDate
datetime
Data de término do período
saleId
number
Id da venda
Response params (200)
pages
number
Número de páginas
page
number
Página atual
itemsPerPage
number
Número máximo de itens por página
totalItems
number
Número total de items
items
array of object
items[n].id
string
Id do extrato
items[n].creditDate
datetime
Data da crédito no extrato
items[n].description
string
Descrição do extrato
items[n].saleId
string
Id da venda
items[n].type
enum
Tipo do extrato
affiliante_sale
sale
refund
bonus
fee
product_payment
anticipation
anticipation_direct
chargeback_blocked
chargerback_success
recurrence_credit
conciliation
items[n].value
object
Valor do extrato
items[n].value.currency
string
Moeda
items[n].value.value
number
Valor
Status codes
| Status | Descrição |
| 200 | Success |
Exemplos
1curl --request GET \
2 --url https://api.eduzz.com/myeduzz/v2/financial/statement \
3 --header 'Accept: application/json' \
4 --header 'Content-Type: application/json' \
5 --header 'authorization: Bearer {{YOUR_ACCESS_TOKEN}}'Response
1{
2 "pages": 1,
3 "page": 1,
4 "itemsPerPage": 10,
5 "totalItems": 1,
6 "items": [
7 {
8 "id": "1",
9 "creditDate": "2021-08-01T00:00:00.000Z",
10 "description": "Venda de produto 1 referente ao pedido 123456",
11 "saleId": "123456",
12 "type": "sale",
13 "value": {
14 "currency": "BRL",
15 "value": 100
16 }
17 }
18 ]
19}