Notas Fiscais

Resumo de Notas Fiscais

Totais de notas da conta por status, em quantidade e em valor.

Sem startDate e endDate, o resumo cobre todas as notas da conta.

Os pares de status são somados juntos: authorized inclui as notas ISSUED e AUTHORIZED, e error inclui as FAILED e ERROR.

Case de uso:

Como plataforma, quero mostrar no painel quantas notas foram autorizadas e quantas falharam no mês, sem paginar a listagem inteira.

GET/v1/invoices/notas/summary
Base URL Produção:https://api.validapay.com.br
Base URL Sandbox:https://sandbox.validapay.com.br

Authorizations

bearer

Authorization

string · header · required

Cabeçalho de autenticação Bearer no formato Bearer {{token}} onde {{token}} é o seu token OAuth2.

Escopos requeridos

nota.fiscal/read

Query Parameters

NameTypeValueRequiredDescription
startDate--RequiredData inicial da emissão, ISO 8601 - optional
endDate--RequiredData final da emissão, ISO 8601 - optional
const url = 'https://sandbox.validapay.com.br/v1/invoices/notas/summary?startDate=&endDate=';

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer {{token}}'
  },
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response Examples

200200
{
  "authorizedCount": 128,
  "authorizedAmount": 45320.75,
  "canceledCount": 3,
  "canceledAmount": 890.00,
  "errorCount": 2,
  "errorAmount": 450.00,
  "processingCount": 1,
  "processingAmount": 150.00,
  "replacedCount": 2,
  "replacedAmount": 300.00
}

← Anterior

Listar Notas Fiscais

Próximo →

Consultar Nota Fiscal