Financeiro › Contas a Pagar e Receber

Alterar

put/transactions/{id}

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/transactions/{id}
  • Auth: HTTP bearer

Request body

descriptionstring

Descrição do lançamento

amountnumber

Valor do lançamento

amount_primarynumber

Valor original do lançamento

datestring

Data do lançamento

typestring

Tipo do lançamento. Valores permitidos:

  • debit: Despesa
  • credit: Crédito
  • transfer: Transferência
modestring

Modo do lançamento. Valores permitidos:

  • transaction: Lançamentos
  • invoice: Faturas
  • transfer: Repasses
  • commission: Comissões
  • transfer_commission: Repasses de Comissões
  • guaranteed_rent: Aluguel Garantido
  • chargeback: Estornos
plan_idinteger

Plano de contas

business_idinteger

Empresa

account_idinteger

Conta financeira

person_idinteger

Pessoa relacionada

building_idinteger

Imóvel relacionado

contract_idinteger

Contrato relacionado

owner_idinteger

Proprietário relacionado

tenant_idinteger

Inquilino relacionado

broker_idinteger

Corretor relacionado

item_idinteger

Item da transação

invoice_idinteger

Fatura relacionada

tagstring[]

Tags relacionadas

notesstring

Observações

paidboolean

Pago. Pode ser true (Pago) ou false (Agendado/Não Pago).

due_datestring

Data de vencimento

billing_methodstring required

Método de cobrança Valores permitidos:

  • ticket: Boleto
  • cash: Dinheiro
  • deposit: Depósito
  • pix: PIX
  • ted: DOC/TED
  • credit: Cartão de Crédito
  • debit: Cartão de Débito
  • check: Cheque
  • debit_account: Débito em Conta
interestnumber

Juros

discountnumber

Desconto

check_agencystring

Agência do cheque

check_accountstring

Conta do cheque

check_idstring

Número do cheque

recurrency_periodicitystring

Periodicidade da recorrência. Valores permitidos:

  • daily: Diariamente
  • weekly: Semanalmente
  • monthly: Mensalmente
  • bimonthly: Bimestralmente
  • quarterly: Trimestralmente
  • semiannually: Semestralmente
  • annually: Anualmente
recurrency_totalinteger

Total de recorrências

recurrency_installmentinteger

Parcela atual

commissionboolean

Comissão

commission_modestring

Modo da comissão. Valores permitidos:

  • fixed: Valor Fixo
  • percentage: Porcentagem
commission_fixednumber

Valor fixo da comissão

commission_percentagenumber

Percentual da comissão

commission_item_idinteger

Item da comissão

commission_idinteger

Comissão relacionada

metadatastring

Metadados

Example request

{
  "description": "Pagamento de aluguel",
  "amount": 1500,
  "amount_primary": 1500,
  "date": "2024-03-20",
  "type": "credit",
  "mode": "transaction",
  "plan_id": 11,
  "business_id": 6,
  "account_id": 1,
  "person_id": 1,
  "building_id": 1,
  "contract_id": 1,
  "owner_id": 1,
  "tenant_id": 1,
  "broker_id": 1,
  "item_id": 1,
  "invoice_id": 1,
  "tag": [
    1,
    2
  ],
  "notes": "Observação importante",
  "paid": true,
  "due_date": "2024-03-20",
  "billing_method": "pix",
  "interest": 10,
  "discount": 10,
  "check_agency": "1234",
  "check_account": "12345-6",
  "check_id": "123456",
  "recurrency_periodicity": "monthly",
  "recurrency_total": 12,
  "recurrency_installment": 1,
  "commission": true,
  "commission_mode": "fixed",
  "commission_fixed": 100,
  "commission_percentage": 10,
  "commission_item_id": 1,
  "commission_id": 1,
  "metadata": "{\"key\": \"value\"}"
}

Changes

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