Listar movimentações financeiras (MaaS)
Lista as movimentações financeiras do parceiro (faturas pagas de vendas MaaS), da mais recente para a mais antiga. Os filtros de data usam o formato `AAAA-MM-DD` e só valem com as duas pontas (inicial e final). `courseIds` e `paymentMethod` podem ser repetidos; `paymentMethod` só é aplicado quando enviado como lista (repetido ou `paymentMethod[]=`).
Autorização
apiToken Token do parceiro. Gere no painel do parceiro: Configurações > Integrações > API Token (perfil Admin ou Superadmin). Envie só este header: se Authorization também for enviado, ele tem prioridade e a requisição é recusada com 401.
Local: header
Parâmetros de Query
Página (começa em 1).
Itens por página.
ID da venda.
CPF do aluno.
E-mail do aluno.
Nome do aluno.
ID do curso.
Forma de pagamento.
Repasse realizado, data inicial.
Repasse realizado, data final.
Repasse previsto, data inicial.
Repasse previsto, data final.
Corpo da Resposta
application/json
application/json
curl -X GET "https://example.com/financial/maas?page=2&limit=10"{ "paging": { "itemsPerPage": 1, "nextPage": 3, "currentPage": 2, "previousPage": 1, "totalPages": 10, "totalItems": 10 }, "content": [ { "crid": 123, "partnerId": 123, "productType": "MAAS", "status": "paid", "cpf": "12312312312", "phone": "11912341234", "name": "Student name", "email": "123@123.com", "courses": [ { "id": 123, "name": "Course name", "isFullTime": false, "modality": "remoto", "price": 198000 } ], "installmentType": "4 / 12", "paidWith": "Boleto", "installmentValue": 15676, "studentPaidValue": 16302, "commission": { "value": 815, "percentage": 5 }, "receivedValue": 15495, "dueDate": "2021-11-09", "paidAt": "2022-01-22", "transferType": null, "madeEffectiveDate": "2021-07-03", "expectedTransferDate": "2022-01-24", "transferDate": null, "installmentData": { "4": "false" }, "address": { "street": "Rua do aluno", "number": "1", "complement": "casa ou apartamento", "district": "Bairro", "zipCode": "12312312", "city": "São Paulo", "state": "SP" } } ]}