NFS-e Recebidas

Listar NFS-e Recebidas

Lista as notas emitidas contra o CNPJ da empresa, da mais recente para a mais antiga. A paginação é por cursor: envie em cursor o nextCursor devolvido na resposta anterior. Quando nextCursor vier nulo, não há mais páginas.

get/v1/inbound-service-invoices

Request

  • Base URL: https://api.spedy.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api.spedy.com.br/v1/inbound-service-invoices
  • Auth: API key in header X-Api-Key

Query parameters

accessKeystring

Filtra pela chave de acesso da NFS-e (50 dígitos).

statusInboundServiceInvoiceStatus[]

Filtra pela situação da nota no Ambiente de Dados Nacional. Aceita múltiplos valores.

manifestationStatus'none' | 'confirmed' | 'rejected'
<p>Valores possíveis:</p> <ul> <li><b>none</b>: Nenhuma manifestação registrada ainda para a nota.</li> <li><b>confirmed</b>: O tomador confirmou a operação.</li> <li><b>rejected</b>: O tomador rejeitou a operação.</li> </ul>

Filtra pelo status de manifestação do tomador.

role'recipient' | 'intermediary'
<p>Valores possíveis:</p> <ul> <li><b>recipient</b>: Sua empresa é a tomadora do serviço.</li> <li><b>intermediary</b>: Sua empresa é a intermediária da operação.</li> </ul>

Filtra pelo papel da sua empresa na nota.

environmentType'production' | 'development' | 'simulation'
<p>Valores possíveis:</p> <ul> <li><b>production</b>: Produção</li> <li><b>development</b>: Homologação</li> <li><b>simulation</b>: </li> </ul>

Ambiente das notas (produção ou homologação). Opcional — se omitido, retorna notas de todos os ambientes.

initialDatestring date-time

Data de emissão inicial do período (inclusive).

endDatestring date-time

Data de emissão final do período (inclusive).

cursorstring

Envie o nextCursor recebido na resposta anterior para obter a próxima página. Vazio ou ausente retorna a primeira. Não interprete o conteúdo: o formato pode mudar sem aviso.

limitinteger

Quantidade de itens por página (padrão 20, máximo 200).

Response

OK

nextCursorstring nullable

Cursor para a próxima página; envie-o no parâmetro cursor da próxima requisição. Nulo quando não há mais páginas.

hasNextboolean

Indica se há mais páginas a buscar.

Changes

No recorded changes to this operation across all 1 revision of this API.