Financeiro › Contratos » Itens

Criar

post/financial/contracts/{contract_id}/items

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/financial/contracts/{contract_id}/items
  • Auth: HTTP bearer

Request body

modestring required

Modo do item. Valores permitidos:

  • item: Padrão
  • commission: Comissão
  • service: Serviço
item_idinteger required

ID do tipo de item

descriptionstring required

Descrição do Item

calculate_modestring required

Tipo de valor. Valores permitidos:

  • percentage: Porcentagem
  • fixed: Valor fixo
parent_idinteger

ID do item pai

percentagenumber

Porcentagem

amountnumber

Valor fixo

percentage_modestring

Base de cálculo de porcentagem. Valores permitidos:

  • rental_value: Valor da Locação
  • recurring_commission: Comissão Recorrente
  • first_commission: Primeira Comissão
transfer_owner_idinteger

ID do proprietário da transferência

broker_idinteger

ID do corretor

start_atstring

Data inicial

end_atstring

Data final

commissioned_typestring

Tipo de comissionado. Valores permitidos:

  • seller: Corretor Vendedor
  • broker: Corretor Agenciador
  • pickup: Captador/Angariador
  • indicator: Indicador
  • partner: Parceria
  • manager: Gerente
  • director: Diretor
  • supervisor: Supervisor
  • marketing: Marketing
  • coordinator: Coordenador
  • others: Outros
configstring

Configurações.

Example request

{
  "mode": "item",
  "item_id": 1,
  "description": "Aluguel",
  "calculate_mode": "fixed",
  "parent_id": 1,
  "percentage": 10,
  "amount": 1000,
  "percentage_mode": "rental_value",
  "transfer_owner_id": 1,
  "broker_id": 1,
  "start_at": "2024-01-01",
  "end_at": "2024-12-31",
  "commissioned_type": "seller",
  "config": "{\"installment\": 1, \"billing_mode\": \"monthly\"}"
}

Changes

No recorded changes to this operation across all 1 revision of this API.