Criar Lançamento Financeiro
Nossa API disponibiliza a opção de fazer lançamentos financeiros dentro do contrato. Podendo esses, serem de recebimento ou pagamento.
POST /contracts/{contract_id}/financial
POST /contracts/{contract_id}/financialClique aqui para testar endpoint
Todos os endpoints deverão ser autenticados
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
⚠️ Lembre-se de substituir a variável {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja criar o lançamento financeiro.
Exemplo de payload:
{
"financial_entry": {
"begin_date": "2024-05-12",
"category": "Insira a categoria do lançamento financeiro",
"count": 2,
"flow": "income",
"description": "Insira a descrição do lançamento financeiro",
"frequency": "weekly",
"is_recurrent": true,
"notes": "Insira observações acerca do lançamento financeiro",
"payment_method": "credit_card",
"value": 10000
}
}
Descrição do payload:
| Name | Type | Description |
|---|---|---|
| begin_date | string | data de vencimento do lançamento financeiro |
| category | string | descrição da categoria do lançamento financeiro |
| count | number | caso o valor de is_recurrent seja true, count deverá receber o valor numérico de parcelas do lançamento financeiro |
| flow | string | essa variável deverá ser preenchida conforma a natureza do lançamento: recebimento - "income" pagamento - "outcome" |
| description | string | descrição do lançamento financeiro |
| frequency | string | caso o valor de is_recurrent seja true, frequency deverá receber o valor da frequência na qual será submetido o lançamento financeiro da seguinte forma: diário - "daily" semanal - “weekly” mensal – “monthly" bimestral - “bimonthly” trimestral- “quarterly” semestral - "semiannualy" anual – “annually”; |
| is_recurrent | boolean | Esse lançamento será recorrente? |
| notes | string | observações acerca do lançamento financeiro |
| payment_method | string | método de pagamento. Podendo ser atribuído da seguinte forma: boleto bancário - "bank_slip" cartão de crédito - "credit_card" transferência bancária - "wire_transfer" dinheiro - "cash" outros - "other" |
| value | number | valor do lançamento financeiro |
📝 O campo flow irá determinar se o lançamento será de recebimento ou pagamento.
Exemplo de resposta:
{
"data": {
"category": "Insira a categoria do lançamento financeiro",
"contract": {
"deny_reason": null,
"status": {
"id": 1640
},
"begin_date": "2024-05-12",
"workflow": null,
"current_document": {
"id": "c0444512-1d5b-40a7-9f4b-155a0ee71e38"
},
"classifier": null,
"tasks": null,
"archived": false,
"due_notice": 7,
"id": 176046,
"shares": null,
"inserted_at": "2024-05-23T20:13:07",
"observations": null,
"attachments": null,
"financial": null,
"organization": {
"id": 1199
},
"object": null,
"comments": null,
"review_flow": null,
"form_submission": null,
"review_flows_events": null,
"pendencies": 0.0,
"title": "Teste Contrato",
"assignee": {
"id": 3056
},
"term_type": "Indeterminado",
"deleted": false,
"needs_acceptance": false,
"end_date": "2024-05-30",
"childrem_contracts": null,
"updated_at": "2024-05-29T13:53:23",
"prev_status": null,
"custom_fields": null,
"parent_contract": null,
"number": "2024/28",
"prev_assignee": null
},
"description": "Insira a descrição do lançamento financeiro",
"flow": "income",
"id": 1210,
"inserted_at": "2024-05-31T14:27:43",
"legacy_percent": null,
"notes": "Insira observações acerca do lançamento financeiro",
"payment_method": "credit_card",
"rrule": "RRULE:FREQ=MONTHLY;WKST=SU;BYMONTHDAY=1;COUNT=1",
"updated_at": "2024-05-31T14:27:43",
"user": {
"id": 3056
},
"value": "10000"
}
}
Como utilizar a funcionalidade de financeiro da Contraktor?
Acesse nossa central de ajuda e veja o passo a passo completo:
Updated 6 months ago