Skip to content
API/
/
/
Retornar a configuração d...

Retornar a configuração de de-para de categorias

Request

Retorna o de-para entre as operações financeiras e as categorias configuradas para o tenant, incluindo opcionalmente a sugestão padrão de categoria para cada operação.

Security
BearerAuth
Query
sugestao_padraoboolean

Quando verdadeiro (padrão), inclui o objeto sugestao_padrao em cada item. Quando falso, o campo sugestao_padrao é retornado como null.

Default:true
Example:sugestao_padrao=true
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/categorias/configuracao-padrao?sugestao_padrao=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
Array [
tipo_operacaostring

Tipo da operação financeira. Valores possíveis:

  • FRETES_RECEBIDOS: Categoria para valor de frete inserido na venda.
  • FRETES_PAGOS: Categoria para valor de frete inserido na compra.
  • IMPOSTOS_RETIDOS_EM_VENDAS: Categoria para valor dos impostos retidos na venda.
  • DESCONTOS_INCONDICIONAIS_OBTIDOS: Categoria para descontos obtidos na compra.
  • DESCONTOS_INCONDICIONAIS_CONCEDIDOS: Categoria para descontos concedidos na venda.
  • DESCONTOS_FINANCEIROS_OBTIDOS: Categoria para descontos obtidos, no caso de baixas em despesas com desconto.
  • DESCONTOS_FINANCEIROS_CONCEDIDOS: Categoria para descontos concedidos, no caso de baixas em receitas com desconto.
  • MULTAS_RECEBIDAS: Categoria para multas recebidas, em baixas no Contas a receber.
  • MULTAS_PAGAS: Categoria para multas pagas, em baixas no Contas a pagar.
  • JUROS_RECEBIDOS: Categoria para juros recebidos em baixas no Contas a receber.
  • JUROS_PAGOS: Categoria para juros pagos, em baixas no Contas a pagar.
  • TARIFAS: Categorias para tarifas pagas, em baixas no contas a receber.
  • PERDAS: Categoria para perdas, quando a parcela é dada como perda no Contas a receber.
Enum:"FRETES_RECEBIDOS""FRETES_PAGOS""IMPOSTOS_RETIDOS_EM_VENDAS""DESCONTOS_INCONDICIONAIS_OBTIDOS""DESCONTOS_INCONDICIONAIS_CONCEDIDOS""DESCONTOS_FINANCEIROS_OBTIDOS""DESCONTOS_FINANCEIROS_CONCEDIDOS""MULTAS_RECEBIDAS""MULTAS_PAGAS""JUROS_RECEBIDOS"
Example:"FRETES_RECEBIDOS"
id_categoriastring or null, (uuid)

Identificador da categoria configurada para a operação

Example:"e82ba6fd-a291-422f-8ef7-eb383205d743"
nome_categoriastring or null

Nome da categoria configurada para a operação

Example:"0.5 categoria dre"
sugestao_padraoobject or null(SugestaoPadrao)

Sugestão padrão de categoria para a operação. Quando sugestao_padrao=false, este campo é retornado como null.

]
Response
[
  {
    "tipo_operacao": "FRETES_RECEBIDOS",
    "id_categoria": "e82ba6fd-a291-422f-8ef7-eb383205d743",
    "nome_categoria": "0.5 categoria dre",
    "sugestao_padrao": { … }
  }
]