Consultar
Requisição
GET [Url Ambiente]/categorias/
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/categorias?idempresa=123'
Resposta
Status Code 200
Retorno de sucesso.
Em caso de sucesso é retornada uma lista de objetos de categorias. Seguem campos que são retornados na consulta:
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| idcategoria | Código da categoria | Integer | 26843 |
| idgrupodre | Código do grupo de DRE | Integer | 29 |
| sigla | Sigla da categoria | String | "3.03.004" |
| descricao | Descrição da categoria | String | "Serviço Manutenção Software/hardware" |
| naturezafluxo | P = Pagamento, R = Recebimento | String | "P" |
| ativo | Indica se a categoria está ativa | Boolean | true |
| icone | Ícone da categoria (Fonte awesome) | String | "f0c9" |
| grau | Grau da categoria (A = Analítica, S = Sintética) | String | "A" |
| agrupamento | Agrupamento da categoria | String | |
| idnatcategoria | Código da natureza da categoria (ver tabela abaixo) | Integer | |
| usu_emprestimo | Indica se pode ser utilizada em empréstimos | Boolean |
[
{
"idcategoria": 22413,
"idgrupodre": 15,
"descricao": "Serviço Manutenção Software/hardware",
"naturezafluxo": "P",
"ativo": true,
"icone": "f0c9",
"grau": "A",
"sigla": "3.03.004",
"agrupamento": "1. RESULTADO OPERACIONAL (1 + 2 + 3)",
"idnatcategoria": 3,
"uso_emprestimo": null
},
...
]
Códigos de naturezas de categorias
| Código | Descrição |
|---|---|
| 1 | Receita operacional |
| 2 | Custo do serviço/mercadoria |
| 3 | Despesa operacional |
| 4 | Receita/Despesa NÃO operacional |
| 5 | Financiamento / Empréstimo |
| 6 | Investimento e Capital |
| 7 | Distribuição de resultado |
| 8 | Participações societárias/coligadas |
| 9 | Operações entre contas e ajustes |