Requisição
URL: https://api.erpeasy.compels.net/notaICMS
Method: GET
Os argumentos são:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| tipo | A | Não | Identificador do tipo da Nota 0 - Entrada 1 - Saída |
| emissaoPropria | L | Não | Valor para identificar se a nota é de emissão própria. |
| numero | N | Não | Número da nota |
| dataInicial | D | Não | Data inicio para a consulta no formato AAAA-MM-DD |
| dataFinal | D | Não | Data final para a consulta no formato AAAA-MM-DD |
| selecionarPor | A | Não | Determina a seleção da data. Por : emissao entradaSaida Caso não informado o valor padrão será "emissao" |
| status | A | Não | Status da Nota: Aberta Fechada Em processamento Processada Denegada Inutilizada Autorizada Cancelada |
| codigoNegociante | A | Não | Código do negociante |
| nomeNegociante | A | Não | Nome do negociante |
| cpfCnpjNegociante | A | Não | CPF/CNPJ do negociante |
| offset | N | Não | Número que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0. |
| limit | N | Não | Número que identifica a quantidade de registros a consulta retornará, caso não informado o padrão será 50 (valor máximo). |
Exemplo de endpoint com argumentos:
https://api.erpeasy.compels.net/notaICMS?offset=0&limit=50
Resposta
A resposta será dada através de um texto no formato JSON cujos atributos são:
RESPONSE
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| results | O | 0-N | NotaICMS |
| metadata | O | 1-1 | Metadata |
NotaICMS
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| id | N | 1-1 | Identificador único interno |
| empresa | O | 1-1 | Empresa |
| tipo | A | 1-1 | Tipo 0 - Entrada 1 - Saída |
| emissaoPropria | L | 1-1 | Emissão própria |
| numero | N | 1-1 | Número |
| serie | A | 1-1 | Série |
| especie | A | 1-1 | Espécie |
| status | A | 1-1 | Status Aberta Fechada Em processamento Processada Denegada Inutilizada Autorizada Cancelada |
| dataEmissao | D | 1-1 | Data de emissão |
| dataEntradaSaida | D | 1-1 | Data de entrada/saída |
| chaveAcesso | A | 1-1 | Chave de acesso |
| formaEmissao | A | 1-1 | Forma de emissão |
| finalidadeEmissao | A | 1-1 | Finalidade de emissão |
| formatoImpressao | A | 1-1 | Formato de impressão |
| naturezaOperacao | A | 1-1 | Natureza de Operação |
| codigoRemetente | A | 1-1 | Código do Remetente |
| razaoSocialNomeRemetente | A | 1-1 | Razão Social / Nome |
| cnpjCpfRemetente | A | 1-1 | CNPJ / CPF |
| tipoContribuicaoRemetente | A | 1-1 | Tipo da contribuição |
| inscricaoEstadualRemetente | A | 1-1 | Inscrição estadual |
| inscricaoEstadualSTRemetente | A | 0-1 | Inscrição estadual ST |
| telefoneRemetente | A | 0-1 | Telefone |
| emailRemetente | A | 0-1 | |
| cepEnderecoRemetente | A | 1-1 | CEP |
| logradouroEnderecoRemetente | A | 1-1 | Logradouro |
| numeroEnderecoRemetente | A | 1-1 | Número |
| complementoEnderecoRemetente | A | 0-1 | Complemento |
| bairroEnderecoRemetente | A | 1-1 | Bairro |
| municipioEnderecoRemetente | A | 1-1 | Município |
| codigoMunicipioEnderecoRemetente | N | 1-1 | Código do município |
| ufEnderecoRemetente | A | 1-1 | UF |
| codigoUFEnderecoRemetente | N | 1-1 | Código da UF |
| paisEnderecoRemetente | A | 1-1 | País |
| codigoPaisEnderecoRemetente | N | 1-1 | Código do País |
METADATA
| Campo | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| count | N | 1-1 | Total de registros |
| offset | N | 1-1 | Número que identifica em qual registro a consulta iniciada |
| limit | N | 1-1 | Número que identifica o limite de registros na consulta |
Exemplo de resposta
{
"results": [
{
}
],
"metadata": {
"resultset": {
"count": 200,
"offset": 0,
"limit": 50
}
}
}