API Reference

Criar Lançamento de Saída Único

Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
{ "ds_transaction": "Lançamento de saída único pendente", "dt_competence": "2022-10-01", "activity_type": 0, "repeat_type": 1, "type": 0, "id_accounts_main": 4, "id_contacts": 1, "obs_transaction": "Observação", "itens": [ { "id_plan_accounts_entities": 701, "id_cost_centers": 2, "value_in_cent": 100000 } ], "payments": [ { "situation": 0, "value_in_cent": 100000, "dt_due": "2022-10-10", } ], "tags": [ { "id_tags": 5 }, { "id_tags": 8 } ] }
{ "ds_transaction": "Lançamento de saída único pago", "dt_competence": "2022-10-01", "activity_type": 0, "repeat_type": 1, "type": 0, "id_accounts_main": 4, "id_contacts": 1, "obs_transaction": "Observação", "itens": [ { "id_plan_accounts_entities": 701, "id_cost_centers": 2, "value_in_cent": 100000 } ], "payments": [ { "situation": 1, "value_in_cent": 100000, "dt_due": "2022-10-10", "id_accounts_paid": 4, "payment_in_cent": 100000, "dt_billing": "2022-10-05", } ], "tags": [ { "id_tags": 5 }, { "id_tags": 8 } ] }
{ "ds_transaction": "Lançamento de saída único pago parcial", "dt_competence": "2022-10-01", "activity_type": 0, "repeat_type": 1, "type": 0, "id_accounts_main": 4, "id_contacts": 1, "obs_transaction": "Observação", "itens": [ { "id_plan_accounts_entities": 701, "id_cost_centers": 2, "value_in_cent": 100000 } ], "payments": [ { "situation": 2, "value_in_cent": 70000, "dt_due": "2022-10-10", "id_accounts_paid": 4, "payment_in_cent": 70000, "dt_billing": "2022-10-05", }, { "situation": 0, "value_in_cent": 30000, "dt_due": "2022-10-15" } ], "tags": [ { "id_tags": 5 }, { "id_tags": 8 } ] }

📘

Lançamento pendente

  • É obrigatório informar a conta ou cartão de crédito do lançamento (id_accounts_main ou id_credit_cards_main).

📘

Lançamento pago

  • É obrigatório informar a conta ou cartão de crédito do lançamento (id_accounts_main ou id_credit_cards_main).
  • É obrigatório ter apenas um objeto de item de pagamento e nele informar no mínimo a conta ou cartão de crédito de pagamento, valor do pagamento e data de pagamento (id_accounts_paid ou id_credit_cards_paid, payment_in_cent e dt_billing).

📘

Lançamento pago parcial

  • É obrigatório informar a conta ou cartão de crédito do lançamento (id_accounts_main ou id_credit_cards_main).
  • É obrigatório ter dois objetos de itens de pagamentos:
    • No objeto pago (situation = 2), deve ser informado no mínimo a conta ou cartão de crédito de pagamento, valor do pagamento e data de pagamento (id_accounts_paid ou id_credit_cards_paid, payment_in_cent e dt_billing).
    • No objeto pendente (situation = 0), deve ser informado apenas a data do próximo vencimento e valor restante a ser pago (dt_due e value_in_cent)
Body Params
string
required

Descrição do lançamento

int32
required
Defaults to 0

Tipo de lançamento (0 - Lançamento, 1 - Transferência, 2 - Saldo inicial, 3 - Pagamento de fatura de cartão de crédito)

string
required

Data de competência (YYYY-MM-DD)

int32
required
Defaults to 1

Tipo de repetição (0 - Parcelado/Recorrência, 1 - Lançamento único)

int32
required
Defaults to 0

Tipo de atividade (0 - Saída, 1 - Entrada)

int64

ID da conta padrão

int64

ID do contato

string

Observação do lançamento

itens
array of objects
required

Item do lançamento

itens*
payments
array of objects
required

Item do pagamento

payments*
tags
array of objects

Tags do lançamento

tags
Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json