Skip to main content

Consulta de documentos fiscais

Listagem dos documentos fiscais gerados por meio de filtros de seleção, que limitam o resultado e podem ser zero ou mais entre: período, serie_codigo e ultimo_serie_contador.

Os parâmetros inicio_datahora e fim_datahora limitam o resultado pelo campo registrado_em.

O parâmetro serie_codigo limita o resultado pelo campo serie_codigo.

O parâmetro ultimo_serie_contador limita o resultado para listar apenas os contadores acima do ultimo_serie_contador

Caso esses parâmetros não sejam informados, a resposta será gerada sem a aplicação de filtros.

Para evitar sobrecarga nas respostas, o sistema realiza automaticamente a paginação dos dados. Caso os parâmetros page e per_page não sejam informados, serão utilizados, respectivamente, os valores padrão 1 e 20.

GET api/documentos_fiscais

HEADERS

CHAVE
 VALOR
 DESCRIÇÃO
 OBRIGATÓRIO
Accept
 application/vnd.linkc.com.br; version=1 Versão da API. SIM
Authorization
 Bearer <TOKEN>
 Token obtido na autenticação
 SIM
Content-Type
 application/json
 Tipo de conteúdo do request
 SIM

PARÂMETROS QUERY STRING

CHAVE
 DESCRIÇÃO
 OBRIGATÓRIO

page

Número da página da listagem

 NÃO

per_page

Quantidade de registros por página

 NÃO

inicio_datahora

Horário inicial do período de consulta no campo: registrado_em

 NÃO

fim_datahora

Horário final do período de consulta no campo: registrado_em

 NÃO

serie_codigo

Série código do documento fiscal

 NÃO

ultima_serie_contador

 Última série do contador NÃO

RETORNO EM CASO DE SUCESSO (200 – OK)

CHAVE
 DESCRIÇÃO
documentos_fiscais[]
Lista dos documentos fiscais
documentos_fiscais[].id
Identificador único do documento fiscal
documentos_fiscais[].serie_codigo
Código da série do documento fiscal
documentos_fiscais[].serie_contador
Contador da série do documento fiscal
documentos_fiscais[].registrado_em
Data e hora da emissão do documento fiscal
documentos_fiscais[].valor
Valor do documento fiscal
documentos_fiscais[].pessoa.id Código da pessoa
documentos_fiscais[].pessoa.nome Nome da pessoa
documentos_fiscais[].documento Documento da pessoa
documentos_fiscais[].lote_documento_fiscal.data_em Data do lote
metadata
Retorno de outras informações sobre a consulta
metadata.page
Página atual.
metadata.per_page
Quantidade de registro por página.
metatada.total_page
Total de páginas.
metatada.total_items
Total de registros.

EXEMPLO DE RETORNO EM CASO DE SUCESSO (200 – OK)

{
    "documentos_fiscais": [
        {
        "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
        "serie_codigo": "A",
        "serie_contador": "0001",
        "valor": 10.0
        "registrado_em": "2019-08-30T20:49:20.000000-03:00",
        "pessoa": {
          "id": "73b4cab7-ea27-426c-b247-bf0f006e0f05",
          "nome": "FULANO",
          "documento": "012345678901",
        },
        "lote_documento_fiscal": {  
          "data_em": "2019-08-30",
        }
    }, …
    ],
    "metadata": {
      "page": 1,
      "per_page": 20,
      "total_page": 10,
      "total_items": 197
    }
}

OUTROS RETORNOS

CÓDIGO HTTP
 DESCRIÇÃO
401
 Caso as credenciais sejam inválidas.

Back to top