Com este endpoint é possível listar todas as licenças de uma SH, ou apenas as que se encaixam no filtro informado.
URL
POST https://painelapi.ns.eti.br/licenca/listLicenses
Dados de entrada
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| X-AUTH-TOKEN | Token de acesso | 1-1 | A | Token de acesso da Software House utilizada para comunicação com as APIS da NS Tecnologia | |
| filter | CNPJ do emitente | 0-1 | O | ||
| manifestaAuto | Filtrar pelo valor da manifestação automática | 0-1 | B | filter | Valor default: 1 |
| vencimentoCertificado | Filtrar pela data de vencimento do certificado | 0-1 | Date | filter | Formato: "dd/MM/yyyy" |
| situacao | Código de situação da licença | 0-1 | N | filter | 0 - Testes; 1 - Producao; 2 - Bloqueado |
| liberado | Código do tipo de liberação da licença | 0-1 | N | filter | 0 - Não liberado; 1 - Liberado; 2 - Descartado |
Exemplo de requisição
curl -X POST
\-H "Content-Type: application/json"
\-d '{"X-AUTH-TOKEN": "SEU_TOKEN", "filter": {"manifestaAuto": true, "vencimentoCertificado": "05/08/2019", "liberado": 1, "situacao": 0}}'
https://painelapi.ns.eti.br/licenca/listLicenses
Dados retornados
| Campo | Descrição | Ocorrência | Tipo | Pai | Observação |
|---|---|---|---|---|---|
| status | Código de status do processamento | ||||
| msg | Descrição literal do status de processamento | ||||
| licencas | Lista de objetos que contém os dados das licenças encontradas com o filtro | 1-1 | O | ||
| idlicenca | Código identificador da licença | 1-1 | N | licencas | |
| situacao | Código de situação da licença | 1-1 | N | licencas | 0 - Testes; 1 - Produção; 2 - Bloqueado |
| liberado | Código do tipo de liberação da Licença | 1-1 | N | licencas | 0 - Não Liberado; 1 - Liberado; 2 - Descartado |
| manifestaAuto | Status da manifestação automática | 1-1 | B | licencas | |
| buscaCTe | Status do download de CT-es emitidos contra o CNPJ desta licença. | 1-1 | B | licencas | |
| buscaNFSe | Status do download de NFS-es emitidos contra o CNPJ desta licença. | 1-1 | B | licencas | |
| datainicio | Data de criação da licença | 1-1 | DateTime | licencas | |
| vencimento | Data de vencimento da licença | 1-1 | DateTime | licencas | |
| projeto | Objeto contendo dados do projeto | 1-1 | O | licencas | |
| idProjeto | Código identificador do projeto | 1-1 | N | projeto | |
| nome | Nome do projeto | 1-1 | A | projeto | |
| pessoa | Objeto contendo os dados da empresa vinculada a licença | 1-1 | Object | licencas | |
| idpessoa | Identificador da empresa | 1-1 | N | pessoa | |
| cnpj | CNPJ da empresa | 1-1 | A | pessoa | |
| ie | Inscrição estadual | 1-1 | A | pessoa | |
| razao | Razão social da empresa | 1-1 | A | pessoa | |
| fantasia | Nome fantasia da empresa | 1-1 | A | pessoa | |
| certificado | Objeto contendo os dados do certificado digital da empresa | 0-1 | O | licencas | Apenas quando existir certificado vinculado a licença e não informado filtro por vencimento de licença |
| idCertificado | Código identificador do certificado | 1-1 | N | certificado | |
| vencimento | Data de vencimento do certificado | 1-1 | DateTime | certificado |
Exemplos de retorno
Retorno com sucesso
{
"status": 200,
"msg": "Requisicao realizada com sucesso",
"licencas": [{
"idlicenca": 700,
"projeto": {
"idProjeto": 20,
"nome": "NS NFCe"
},
"pessoa": {
"idpessoa": 850,
"cnpj": "99999999999999",
"ie": "123456789",
"razao": "RAZAO SOCIAL ME",
"fantasia": ""
},
"certificado": {
"idCertificado": 63,
"vencimento": "05/08/2019 19:59:59"
},
"datainicio": "30/04/2016 00:00:00",
"vencimento": "10/11/2019 00:00:00",
"situacao": 0,
"liberado": 0,
"manifestaAuto": false,
"buscaCTe": false,
"buscaNFSe": false
}, {
...
}
]
}
Códigos de retorno
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso |
| -9 | Nenhuma licença encontrada com o filtro informado |