Skip to content
/
Rateio, centros de custo...
Last updated

📘 Consultar Parcela por ID -- Rateio, Categoria e Centro de Custo

Este guia mostra como utilizar o endpoint GET /v1/financeiro/eventos-financeiros/parcelas/{id} para obter os detalhes de uma parcela específica de um evento financeiro (conta a pagar ou a receber).
Na resposta, é possível visualizar informações de Rateio, Categoria e Centro de Custo.

🔗 Endpoint

GET https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/{id}
  • {id} → ID da parcela (UUID) obtido na criação ou listagem de eventos financeiros.

🔑 Autenticação

Este endpoint requer autenticação via OAuth2.
Inclua o token de acesso no header da requisição:

Authorization: Bearer {access_token}
Content-Type: application/json

📥 Exemplo de Requisição

GET https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b
Authorization: Bearer {access_token}
Content-Type: application/json

📤 Exemplo de Resposta (trecho relevante)

{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "status": "PENDENTE",
  "valor_pago": 10,
  "data_vencimento": "01/01/2030",
  "descricao": "bla bla bla",
  "evento": {
    "tipo": "RECEITA",
    "rateio": [
      {
        "id_categoria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "nome_categoria": "ABC",
        "valor": 20.5,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
            "nome_centro_custo": "ABC",
            "valor": 30.5
          }
        ]
      }
    ]
  }
}

🔍 Localizando Rateio, Categoria e Centro de Custo

1. Rateio (evento.rateio)

  • Localização: evento.rateio
  • Tipo: Array de objetos
  • Cada item representa uma divisão do valor da parcela.
  • Campos principais:
    • valor → Valor destinado a essa parte do rateio.
    • id_categoria / nome_categoria → Categoria vinculada.
    • rateio_centro_custo → Lista de centros de custo associados ao rateio.

2. Categoria

Dentro de cada item de evento.rateio:

{
  "id_categoria": "UUID",
  "nome_categoria": "Nome da Categoria"
}

3. Centro de Custo

Dentro de rateio_centro_custo:

{
  "id_centro_custo": "UUID",
  "nome_centro_custo": "Nome do Centro de Custo",
  "valor": 30.5
}

✅ Boas Práticas

  • Nem toda parcela terá rateio → se evento.rateio vier vazio, significa que não houve distribuição.
  • Utilize os IDs (id_categoria, id_centro_custo) para consultar detalhes em outros endpoints:
    • GET /v1/categorias
    • GET /v1/centro-de-custo
  • Quando houver rateio, valide se a soma de rateio.valor ou de rateio.rateio_centro_custo[].valor corresponde ao valor total da parcela.

📚 Recursos Relacionados

Previous page
Next page