Está página apresenta os métodos disponíveis na API com exemplos de consumo e as tabelas dos campos esperados e retornados por cada método.
Os exemplos exibidos aqui estão implementados utilizando a ferramenta CURL.
Consolidação de NFC-e
A partir deste serviço é possível realizar a consolidação dos dados armazenados no banco de dados do seu sistema com os dados armazenados no banco de dados da NS Tecnologia.
URL
Produção: POST https://console.ns.eti.br/analytics/nfce/compliance
Produção: POST https://console.ns.eti.br/v1/analitico/nfce/consolidacao
Dados de entrada
Content-Type: application/json
| Campo | Ocorrência | Tipo | Pai | Descrição |
|---|---|---|---|---|
| X-AUTH-TOKEN | 1-1 | A | Token de acesso da Software HousePode ser enviado também via Header ou QueryString na URL. | |
| dhEmiIni | 1-1 | D | Data de emissão inicial, formato: dd/MM/yyyy | |
| dhEmiFin | 1-1 | D | Data de emissão final, formato: dd/MM/yyyy | |
| CNPJ | 1-1 | N | CNPJ do contribuinte | |
| serie | 1-1 | N | Número de série |
Exemplo de requisição
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"dhEmiIni": "01/02/2019",
"dhEmiFin": "06/02/2019",
"CNPJ": "99999999999",
"serie": 1
}' \
https://console.ns.eti.br/analytics/nfce/compliance
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | 1-1 | N | ||
| motivo | Descrição literal do status de processamento | 1-1 | A | ||
| result | Objeto contendo os dados de retorno | 0-1 | O | Somente em status = 200 | |
| totalEmit | Quantidade total de documentos emitidos e com status de autorizados | 1-1 | N | result | |
| totalEmitValue | Valor total de documentos emitidos e com status de autorizados | 1-1 | N | result | |
| totalCanceled | Quantidade total de documentos emitidos e com status de autorizados | 1-1 | N | result | |
| totalCanceledValue | Valor total de documentos emitidos e com status de cancelados | 1-1 | N | result | |
| nnfGaps | Array contendo a lista de números de documentos não presentes no banco de dados da NS | 0-1 | Array | result | Somente se o campo serie tiver sido informado na requisição. Ex.: Se as NFC-es de número 1, 3 e 4 foram emitidas e NFC-e de número 2 não, esta lista conterá o número 2, indicando que a numeração 2 não foi utilizada. |
Exemplos de retorno
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"result": {
"totalEmit": 1658,
"totalEmitValue": 84344.99,
"totalCanceled": 0,
"totalCanceledValue": 0,
"nnfGaps": [
2
]
}
}
{
"status": 200,
"motivo": "Consulta realizada com sucesso",
"result": {
"totalEmit": 1658,
"totalEmitValue": 84344.99,
"totalCanceled": 0,
"totalCanceledValue": 0,
"nnfGaps": [
2
]
}
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Consulta realizada com sucesso |