Consultar
Requisição
GET [Url Ambiente]/negocios/
Header
| Identificador | Valor |
|---|---|
| Accept | application/json |
| X-Api-Key | Token de acesso à API |
| x-idtokenoper | Token do contrato |
Query
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| idempresa | (Obrigatório) Código da empresa | Integer | 123 |
Exemplo
curl -X GET --header 'Accept: application/json' --header 'X-Api-Key: e26f1ae9-d729-4fa9-bdd9-d2cbdcb5fa94' --header 'x-idtokenoper: 0c3a7999-06c9-4680-8a8a-aeb57965c468' 'https://sistemacontas.com.br/contas/api/v1/negocios?idempresa=123'
Resposta
Status Code 200
Retorno de sucesso.
Em caso de sucesso é retornada uma lista de objetos de negócios. Seguem campos que são retornados na consulta:
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| idnegocio | Código do negócio | Integer | 3104 |
| sigla | Sigla do negócio | String | "1.01" |
| descricao | Descrição do negócio | String | "Administração geral" |
| grupo | Agrupamento de negócio | String | |
| ativo | Indica se o negócio está ativo | Boolean | true |
| icone | Ícone da categoria (Fonte awesome) | String | "f00a" |
| grau | Grau da negócio (A = Analítico, S = Sintético) | String | "S" |
[
{
"idnegocio": 3104,
"descricao": "Administração geral",
"grupo": null,
"grau": "S",
"ativo": false,
"sigla": "1.01",
"icone": "f00a"
},
...
]