Requisição

URL: https://api.erpeasy.compels.net/empresa

Method: GET


Os argumentos são:

Nome
TipoObrigatórioDescrição
offsetNNãoNúmero que identifica em qual registro a consulta iniciará, caso não informado o padrão será 0.
limitNNãoNú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/empresa?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
resultsO0-N
Empresa
metadataO1-1
Metadata


EMPRESA

Campo
Tipo
Ocorrência
Descrição
id
N
1-1
Identificador único numérico da empresa
codigo
A
1-1
Identificador único alfanumérico da empresa
razaoSocial
A
1-1
Nome/Razão Social da empresa
cnpj
A
1-1
CNPJ da empresa
inscricaoEstadual
A
1-1
Inscrição Estadual da empresa


METADATA

Campo
Tipo
Ocorrência
Descrição
countN1-1
Total de registros
offsetN1-1
Número que identifica em qual registro a consulta iniciada
limitN1-1Número que identifica o limite de registros na consulta


Exemplo de resposta


{
    "results": [
        {
            "id": 1,
            "codigo": "DEMO",
            "razaoSocial": "(DEMO) COMPELS INFORMÁTICA LTDA - ME",
            "nomeFantasia": "(DEMO) COMPELS INFORMÁTICA",
            "cnpj": "10.810.642/0001-00",
            "inscricaoEstadual": "ISENTO"
        }
    ],
    "metadata": {
        "resultset": {
            "count": 1,
            "offset": 0,
            "limit": 50
        }
    }
}