Criar um novo evento financeiro de contas a receber

Request

Permite criar um novo evento financeiro de contas a receber, passando dados como data de competência, valor, descrição, conta financeira, condições de pagamento, entre outros. Facilita o registro de receitas previstas ou realizadas.

Security

BearerAuth

Bodyapplication/jsonrequired

Dados do evento financeiro de contas a receber

data_competenciastring, (date)required

Data da competência do evento financeiro

Example:"2024-07-15"

valornumber, (decimal)required

Valor do evento financeiro

Example:100

observacaostringrequired

Observação do evento financeiro

Example:"Evento financeiro no valor de R$100,00"

descricaostringrequired

Descrição do evento financeiro

Example:"Prestação de serviço"

contatostring, (uuid)required

Identificador do negociador

Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"

conta_financeirastring, (uuid)required

Identificador da Conta Financeira

Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"

rateioArray of objects(CategoriaRateio)

condicao_pagamentoobject(ListaCondicaoPagamento)required

curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_competencia": "2024-07-15",
    "valor": 100,
    "observacao": "Evento financeiro no valor de R$100,00",
    "descricao": "Prestação de serviço",
    "contato": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "rateio": [
      {
        "id_categoria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "valor": 100,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
            "valor": 100
          }
        ]
      }
    ],
    "condicao_pagamento": {
      "parcelas": [
        {
          "descricao": "Mensalidade (2/6)",
          "data_vencimento": "2024-07-15",
          "nota": "Pagamento realizado via PIX",
          "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
          "detalhe_valor": {
            "multa": 100.25,
            "juros": 1.5,
            "valor_bruto": 275.99,
            "valor_liquido": 250.33,
            "desconto": 2.1,
            "taxa": 4.4
          },
          "metodo_pagamento": "PIX_PAGAMENTO_INSTANTANEO"
        }
      ]
    }
  }'

Responses

Evento financeiro de contas a receber criado com sucesso

Bodyapplication/json

protocolostring, (uuid)

Identificador do protocolo

Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"

statusstring

Status do protocolo

Enum:"PENDING""SUCCESS""ERROR"

Example:"SUCCESS"

data_criacaostring, (date-time)

Data de criação do protocolo

Example:"2024-10-22T14:30:00Z"

Response

{
  "protocolo": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "status": "SUCCESS",
  "data_criacao": "2024-10-22T14:30:00Z"
}