Consulta com OData (CT-e)
O endpoint OData permite consultas avançadas com filtros, ordenação e paginação.
Sumário
- Buscar Lista de CT-es
- Parâmetros OData Suportados
- Exemplos de Filtros
- Paginação com $skiptoken
- Buscar Eventos de CT-e
Buscar Lista de CT-es
GET /v2/companies/{company_id}/inbound/odata/TransportationInvoices
Authorization: ApiKey {api_key}
Parâmetros OData Suportados
| Parâmetro | Descrição | Exemplo |
|---|---|---|
$filter | Filtra registros | issuedOn ge 2024-01-01 |
$top | Máximo de registros por página (máx: 1000) | $top=100 |
$skip | Ignora N registros (offset) | $skip=200 |
$skiptoken | Token de paginação (mais eficiente que skip) | $skiptoken=abc123 |
$orderby | Ordenação | $orderby=issuedOn desc |
$select | Seleciona campos específicos | $select=accessKey,issuedOn |
Exemplos de Filtros
CT-es do mês de janeiro de 2024:
GET /v2/companies/{company_id}/inbound/odata/TransportationInvoices
?$filter=issuedOn ge 2024-01-01T00:00:00Z and issuedOn lt 2024-02-01T00:00:00Z
&$top=100
&$orderby=issuedOn desc
CT-es com NSU maior que 5000:
GET /v2/companies/{company_id}/inbound/odata/TransportationInvoices
?$filter=nsu gt 5000
&$top=50
Paginação com $skiptoken
Para listas grandes, use $skiptoken em vez de $skip. O token é retornado na resposta quando há mais páginas:
{
"@odata.context": "...",
"@odata.nextLink": "https://api.nfe.io/v2/companies/comp_123/inbound/odata/TransportationInvoices?$skiptoken=abc123",
"value": [
{ "accessKey": "...", "issuedOn": "..." },
{ "accessKey": "...", "issuedOn": "..." }
]
}
Na próxima requisição, use a URL de @odata.nextLink diretamente.
Buscar Eventos de CT-e
GET /v2/companies/{company_id}/inbound/odata/TransportationInvoiceEvents
?$filter=receiptOn ge 2024-01-01T00:00:00Z
&$top=100
O campo de filtro para eventos é receiptOn (data de recebimento) em vez de issuedOn.