get
https://southamerica-east1-lepapptest.cloudfunctions.net/lepApi/v1/invoices
Escopo: invoices:read — Cobranças do estabelecimento: valores, líquido, split, forma de pagamento e nome/e-mail do pagador.
Cobranças do estabelecimento, paginadas por cursor. Todos os parâmetros vão na query string e são opcionais.
| parâmetro | |
|---|---|
bizId | uid do estabelecimento. Dispensável com chave exclusiva de um estabelecimento; obrigatório nas demais |
status | separados por vírgula: WAITING (em aberto), PAID, EXPIRED, CANCELLED, REFUNDED. Sem ele, todos |
paymentMethod | separados por vírgula: PIX, CREDIT, BANK_SLIP, LOCAL, TED, BALANCE, FREE_PASS, LOYALTY, LEP_GIFT. Sem ele, todas — inclusive cobrança ainda sem forma de pagamento |
dateField | dueDate (padrão) ou paymentDate — campo do intervalo e da ordenação. Com paymentDate, só vêm cobranças pagas |
from, to | ISO 8601; sem offset é horário do negócio. from inclusivo, to exclusivo |
limit | 1 a 200, padrão 50 |
cursor | pagination.nextCursor da página anterior |
status × paymentMethod pode ter no máximo 30 combinações (ex.: os 5 status com as 9 formas não passa); acima disso, 400.
Paginação
- Ordem:
dateFieldcrescente, desempate pelo id. Paginando atéhasMore: falsevêm todas, sem repetir nem pular. - Lançamentos da plataforma (saques, taxas, repasses, pacote de créditos, demonstração) não são cobrança e ficam de fora. Por isso uma página pode vir com menos de
limititens, até vazia, e ainda terhasMore: true— continue pelo cursor. - O cursor só vale com os mesmos filtros; trocar algum responde 400. O
limitpode mudar entre páginas.
Campos — os mesmos de invoices em Detalhar assinatura, mais:
itemPaidId: o que a cobrança paga — o id da assinatura em mensalidades (abra em Detalhar assinatura).payer: nome e e-mail de quem paga.
id é o id da cobrança no Asaas (pay_…); valueCents, o valor cheio; netAfterSplitCents, o que fica para o estabelecimento depois de taxas e split; paymentDate e receiptUrl (comprovante) só vêm quando pago; em paymentMethod: LOCAL (registrado à mão), localPaymentMethod diz como.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…