Documento entrada

Consulta Documento de Entrada

get
/notafiscal/v1/documento/entrada

API para integração de consulta de documento de entrada. 1- Devido a limitação do Swagger na quantidade de caracters que podem ser retornadas, foram criados os campos abaixo para limitar a quantidade de registros quando necessário. O erro retornado quando o limite de caracteres é ultrapassado é "413 - request entity too large".

Autorizações
OAuth2clientCredentialsObrigatório
Token URL:
Parâmetros de consulta
limitinteger · int32 · mín: 1 · máx: 100Opcional

Quantidade máxima de items retornados.

Default: 20
offsetinteger · int32Opcional

Quantidade de items para ignorar antes de retornar resultado.

Default: 0
qstringOpcional

O filtro é permitido apenas pelos atributos do objeto principal.

Esta seção descreve e fornece exemplos de filtragem em consultas em tabelas e exibições habilitadas para REST.

A filtragem é o processo de limitar um recurso de coleção usando uma definição de filtro dinâmico por solicitação em vários recursos de página, em que cada página contém um subconjunto de itens encontrados na coleção completa. A filtragem permite a passagem eficiente de grandes coleções.

Para filtrar em uma consulta, inclua o parâmetro q=FilterObject, onde FilterObject é um objeto JSON que representa a seleção e classificação customizadas a serem aplicadas ao recurso. Por exemplo, suponha o seguinte recurso:

https://api.systextil.com

A consulta a seguir inclui um filtro que restringe a coluna NOME_CLIENTE a "SYSTEXTIL":

https://api.systextil.com/comercial/v1/clientes?q={"nome_cliente":"JOHN"}

Gramática FilterObject

FilterObject { orderby , asof, wmembers }
orderby
  "$orderby": {orderByMembers}
 
orderByMembers
    orderByProperty
    orderByProperty , orderByMembers
 
orderByProperty
    columnName : sortingValue
 
sortingValue
  "ASC"
  "DESC"
  "-1"
  "1"
   -1
   1
   
asof
  "$asof": date
  "$asof": "datechars"
  "$asof": scn
  "$asof": +int
 
wmembers
    wpair
    wpair , wmembers
 
wpair
    columnProperty
    complexOperatorProperty
 
columnProperty
    columnName : string
    columnName : number
    columnName : date
    columnName : simpleOperatorObject
columnName : complexOperatorObject
    columnName : [complexValues]
 
columnName
  "\p{Alpha}[[\p{Alpha}]]([[\p{Alnum}]#$_])*$"
 
complexOperatorProperty
    complexKey : [complexValues]
    complexKey : simpleOperatorObject 
 
complexKey
  "$and"
  "$or"
 
complexValues
    complexValue , complexValues
 
complexValue
    simpleOperatorObject
    complexOperatorObject
    columnObject
 
columnObject
    {columnProperty}
 
simpleOperatorObject
    {simpleOperatorProperty}
 
complexOperatorObject
    {complexOperatorProperty}
 
simpleOperatorProperty
   "$eq" : string | number | date
   "$ne" : string | number | date
   "$lt" :  number | date
   "$lte" : number | date
   "$gt" : number | date
   "$gte" : number | date
   "$instr" : string 
   "$ninstr" : string
   "$like" : string
   "$null" : null
   "$notnull" : null
   "$between" : betweenValue
 
betweenValue
    [null , betweenNotNull]
    [betweenNotNull , null]
    [betweenRegular , betweenRegular]
 
betweenNotNull
    number
    date
    
betweenRegular
    string
    number
    date

Definições de tipo de dados incluem o seguinte:

string 
       JSONString
number
       JSONNumber
date
       {"$date":"datechars"}
scn
       {"$scn": +int}

where

Datechars é um formato de data RFC3339 em UTC (Z)
        
 
JSONString
          ""
          " chars "
chars
         char
         char chars
char
         any-Unicode-character except-"-or-\-or-control-character
          \"
          \\
           \/
          \b
          \f
          \n
          \r
          \t
          \u four-hex-digits
 
 
JSONNumber
    int
    int frac
    int exp
    int frac exp
int
    digit
    digit1-9 digits 
    - digit
    - digit1-9 digits
frac
    . digits
exp
    e digits
digits
    digit
    digit digits
e
    e
    e+
    e-
    E
    E+
    E-

O FilterObject deve ser codificado de acordo com a Seção 2.1 do RFC3986

Exemplos

A seguir estão exemplos de operadores em especificações de FilterObject.

ORDER BY property ($orderby)

Order by with literals

{
"$orderby": {"SALARY":  "ASC","ENAME":"DESC"}
}

Order by with numbers

```json

{ "$orderby": {"SALARY": -1,"ENAME": 1} }

 
y ($asof)
 
### With SCN (Implicit)
```json 
{
  "$asof": 1273919
}

With SCN (Explicit)

{
  "$asof": {"$scn": "1273919"}
}

With Date (Implicit)

{
  "$asof": "2014-06-30T00:00:00Z"
}

With Date (Explicit)

{
  "$asof": {"$date": "2014-06-30T00:00:00Z"}
}

EQUALS operator ($eq)

(Implicit and explicit equality supported._

Implicit (Support String and Dates too)

{
 "SALARY": 1000
}

Explicit

{
 "SALARY": {"$eq": 1000}
}

Strings

{
 "ENAME": {"$eq":"SMITH"}
}

Dates

{
  "HIREDATE": {"$date": "1981-11-17T08:00:00Z"}
}

NOT EQUALS operator ($ne)

Number

{
 "SALARY": {"$ne": 1000}
}

String

```json

{ "ENAME": {"$ne":"SMITH"} }

 
#### Dates
  ```json
{
  "HIREDATE": {"$ne": {"$date":"1981-11-17T08:00:00Z"}}
}

LESS THAN operator ($lt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$lt": {"$date":"1999-12-17T08:00:00Z"}}
}

LESS THAN OR EQUALS operator ($lte)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$lte": 10000} }


#### Dates
  ```json
{
  "HIREDATE": {"$lte": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN operator ($gt)

(Supports dates and numbers only)

Numbers

```json

{ "SALARY": {"$gt": 10000} }

 
#### Dates
  ```json
{
  "SALARY": {"$gt": {"$date":"1999-12-17T08:00:00Z"}}
}

GREATER THAN OR EQUALS operator ($gte)

(Supports dates and numbers only)

Numbers

{
  "SALARY": {"$gte": 10000}
}

Dates

{
  "HIREDATE": {"$gte": {"$date":"1999-12-17T08:00:00Z"}}
}

In string operator ($instr)

(Supports strings only) ```json { "ENAME": {"$instr":"MC"} }

 
#### Not in string operator ($ninstr)
(Supports strings only)
  ```json
{
  "ENAME": {"$ninstr":"MC"}
}

####LIKE operator ($like) (Supports strings. Eescape character not supported to try to match expressions with _ or % characters.) ```json { "ENAME": {"$like":"AX%"} }

 
#### BETWEEN operator ($between)
(Supports string, dates, and numbers)
 
#### Numbers
```json
{
  "SALARY": {"$between": [1000,2000]}
}

Dates

```json

{ "SALARY": {"$between": [{"$date":"1989-12-17T08:00:00Z"},{"$date":"1999-12-17T08:00:00Z"}]} }

 
#### Strings
```json
{
  "ENAME": {"$between": ["A","C"]}
}

Null Ranges ($lte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [null,2000]}
}

Null Ranges ($gte equivalent)

(Supported by numbers and dates only)

{
 "SALARY": {"$between": [1000,null]}
}

NULL operator ($null)

{
  "ENAME": {"$null": null}
}

NOT NULL operator ($notnull)

{
  "ENAME": {"$notnull": null}
}

AND operator ($and)

(Supports all operators, including $and and $or)

Column context delegation

(Operators inside $and will use the closest context defined in the JSON tree.)

{
 "SALARY": {"$and": [{"$gt": 1000},{"$lt":4000}]}
}

Column context override

(Example: salary greater than 1000 and name like S%)

{
  "SALARY": {"$and": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}

Implicit and in columns

{
  "SALARY": [{"$gt": 1000},{"$lt":4000}] 
}

High order AND

(All first columns and or high order operators -- $and and $ors -- defined at the first level of the JSON will be joined and an implicit AND) (Example: Salary greater than 1000 and name starts with S or T)

{
  "SALARY": {"$gt": 1000}, 
  "ENAME": {"$or": [{"$like":"S%"}, {"$like":"T%"}]} 
}

Invalid expression (operators $lt and $gt lack column context)

{
   "$and": [{"$lt": 5000},{"$gt": 1000}]
}

Valid alternatives for the previous invalid expression

{
   "$and": [{"SALARY": {"$lt": 5000}}, {"SALARY": {"$gt": 1000}}]
}

{
   "SALARY": [{"$lt": 5000},{"$gt": 1000}]
}
 
{
   "SALARY": {"$and": [{"$lt": 5000},{"$gt": 1000}]}
}

OR operator ($or)

(Supports all operators including $and and $or)

Column context delegation

(Operators inside $or will use the closest context defined in the JSON tree)

{
  "ENAME": {"$or": [{"$eq":"SMITH"},{"$eq":"KING"}]}
}

Column context override

(Example: name starts with S or salary greater than 1000)

{
  "SALARY": {"$or": [{"$gt": 1000},{"ENAME": {"$like":"S%"}} ] }
}
Respostas
chevron-right
200

Sucesso.

application/json
empresanumber · máx: 3Opcional

Empresa da nota fiscal

Example: 0
nota_fiscalnumber · máx: 9Opcional

Numero da Nota fiscal

Example: 0
serie_nota_fiscalstring · máx: 3Opcional

Série da nota fiscal

numero_danfe_nfestring · máx: 44Opcional

Número da chave de acesso da NFE

especie_documentostring · máx: 5Opcional

Espécie da nota fiscal

natureza_operacao_nota_fiscal_idnumber · máx: 3Opcional

Código da natureza da operação

Example: 0
natureza_operacao_nota_fiscal_estadostring · máx: 2Opcional

Estado da natureza da operação

cfop_nota_fiscalstring · máx: 5Opcional

CFOP principal da nota fiscal

natureza_operacao_nota_fiscal_descricaostring · máx: 40Opcional

Descrição da natureza da operação

cnpj_9_notanumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0
cnpj_4_notanumber · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0
cnpj_2_notanumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 0
nome_cliente_fornecedorstring · máx: 40Opcional

Nome/Razão Social do fornecedor

cnpj_9_responsavelnumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0
cnpj_4_responsavelnumber · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0
cnpj_2_responsavelnumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 0
nome_responsavelstring · máx: 40Opcional

Nome/Razão Social do Responsável

transacao_idnumber · máx: 3Opcional

Código da transação de saída, entrada ou devolução

Example: 0
data_lancamentostring · date-timeOpcional

Data de lançamento da nota fiscal

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
data_emissaostring · date-timeOpcional

Data de emissão da nota fiscal

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
via_transportenumber · máx: 1Opcional

1 - Terrestre 2 - Aéreo 3 - Marítimo 4 - Ferroviário 5 - Fluvial

Example: 0
condicao_pagamento_idnumber · máx: 3Opcional

Código da condição de pagamento

Example: 0
despacho_exportacaonumber · máx: 14Opcional

Número do despacho de exportação fornecido pelo SISCOMEX

Example: 0
valor_totalnumber · máx: 15Opcional

Valor total da nota fiscal

Example: 0
valor_total_ipinumber · máx: 15Opcional

Valor total do IPI

Example: 0
valor_fretenumber · máx: 15Opcional

Valor do frete

Example: 0
valor_seguronumber · máx: 15Opcional

Valor de seguro incidente sobre a nota emitida (Quando houver)

Example: 0
valor_despesasnumber · máx: 15Opcional

Valor de despesas que incidirem sobre a nota emitida (Quando houver)

Example: 0
valor_descontonumber · máx: 15Opcional

Valor do desconto

Example: 0
base_icms_stnumber · máx: 15Opcional

Base ICMS Substituição Tributária

Example: 0
valor_icms_stnumber · máx: 15Opcional

Valor ICMS Substituição Tributária

Example: 0
base_icmsnumber · máx: 15Opcional

Base de calculo do ICMS

Example: 0
valor_icmsnumber · máx: 15Opcional

Valor do ICMS

Example: 0
base_diferencanumber · máx: 15Opcional

Valor da base diferença

Example: 0
valor_total_produtonumber · máx: 15Opcional

Valor total dos produtos

Example: 0
peso_liquidonumber · máx: 12Opcional

Peso liquido da nota

Example: 0
peso_brutonumber · máx: 12Opcional

Peso bruto da nota

Example: 0
valor_irrfnumber · máx: 15Opcional

Valor IRRF

Example: 0
valor_issnumber · máx: 17Opcional

Valor do ISS

Example: 0
valor_inss_retidonumber · máx: 15Opcional

Valor INSS retido

Example: 0
valor_pis_retidonumber · máx: 15Opcional

Valor Pis retido

Example: 0
valor_cofins_retidonumber · máx: 15Opcional

Valor Cofins Retido

Example: 0
valor_csl_retidonumber · máx: 15Opcional

Valor CSL retido

Example: 0
historico_contabil_idnumber · máx: 4Opcional

Código do histórico contábil

Example: 0
historico_contabil_descricaostring · máx: 30Opcional

Descrição do histórico contábil

Example: 0
divisao_qualificacaostring · máx: 1Opcional

Divisão de qualificação: (1),(2),(4),(7),(9)- Divisões de Produto ou (0) para não considerar no processo de qualificação de fornecedores.

lancamento_contabilnumber · máx: 9Opcional

Numero do lançamento contábil da nota fiscal

Example: 0
situacao_entradanumber · máx: 1Opcional

Situação entrada: (4- Nota de Fornecedor ou 5- Nota incompleta)

Example: 0
valor_fcp_destinatarionumber · máx: 13Opcional

Valor do FCP destinatário

Example: 0
valor_icms_destinatarionumber · máx: 13Opcional

Valro do ICMS destinatário

Example: 0
valor_icms_remetentenumber · máx: 13Opcional

Valor do ICMS remetente

Example: 0
tipo_conhecimentonumber · máx: 1Opcional

Tipo de conhecimento: (0) Se estiver digitando uma Nota Fiscal de Entrada; (1) Se estiver digitando um Conhecimento de Frete originado de uma Nota Fiscal de Entrada; (3) Se estiver digitando uma Nota Fiscal que representa um conjunto de Conhecimentos de Fretes, originados de uma ou mais Notas Fiscais de Saída.

Example: 0
tipo_fretenumber · máx: 1Opcional

1 - Frete pago -Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""0"" Emitente, conforme a legislação determina. 2 - Frete a pagar: Ao ser utilizado esta opção, na impressão do Danfe no campo tipo frete sairá da seguinte forma: ""1"" Dest/Rem , conforme a legislação determina. 3 - Terceiros: Ao ser utilizado esta opção o sistema irá colocar direto para a opção ""2"", ou seja, frete por conta de terceiros. 4 - Frete cortesia: Ao ser utilizado esta opção o sistema irá colocar direto para o tipo ""1"" frete por conta do emitente. 6 - Transporte Próprio por conta do Remetente. 7 - Transporte Próprio por conta do Destinatário. 9 - Sem frete: Esta opção será utilizada quando não houver frete.

Example: 0
cnpj_9_transportadoranumber · máx: 9Opcional

Os 9 dígitos principais do CNPJ ou CPF

Example: 0
cnpj_4_transportadoranumber · máx: 4Opcional

Os 4 dígitos secundários do CNPJ ou 0000 quando for CPF

Example: 0
cnpj_2_transportadoranumber · máx: 2Opcional

Os 2 dígitos verificadores do CNPJ ou CPF

Example: 0
nome_transportadorastring · máx: 40Opcional

Nome/Razão Social do fornecedor

valor_tarifa_fretenumber · máx: 5Opcional

Valor da tarifa de frete

Example: 0
tipo_descontonumber · máx: 1Opcional

Informe: 0 para desconto rateado (como já funciona) ou 1 para desconto a nível de item

Example: 0
data_limite_quarentenastring · date-timeOpcional

Data limite da quarentena do produto

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
complemento_edistring · máx: 60Opcional

Dúplicata Única gerada para os conhecimento processados via EDI

observacao1string · máx: 60Opcional

Observação 1 da nota fiscal

observacao2string · máx: 60Opcional

Observação 2 da nota fiscal

tipo_fornecedor_idnumber · máx: 2Opcional

Código do tipo de fornecedor

Example: 0
tipo_fornecedor_descricaostring · máx: 20Opcional

Descrição do tipo de fornecedor

data_digitacaostring · date-timeOpcional

Data de digitação da nota fiscal

Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
usuario_digitacaostring · máx: 250Opcional

Usuário que digitou a nota fiscal

data_atualizacao_apistring · date-timeOpcional

Data de atualização da API.

Example: 2022-03-07T03:00:00ZPattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
get
/notafiscal/v1/documento/entrada

Cadastro Documento de Entrada

post
/notafiscal/v1/documento/entrada
Autorizações
OAuth2clientCredentialsObrigatório
Token URL:
Parâmetros de consulta
syncbooleanOpcional

Informa se a integração é assíncrona (false) ou síncrona (true).

Corpo
Respostas
chevron-right
200

Sucesso na inclusão.

application/json
data_hora_responsestring · date-timeOpcionalExample: 2023-08-31T10:20:11.981250Pattern: ^\d{4}-[01]\d-[0123]\dT[012]\d:[0-5]\d:[0-5]\d(.\d+)?(Z|([-+][012]\d:[0-5]\d))$
idstringOpcionalExample: 0438e762aae55aa7e06364010a0a3117
post
/notafiscal/v1/documento/entrada

Atualizado

Isto foi útil?