Financial Transactions

Update Financial Transaction

Update financial transaction

post/v1/financial/transaction/{transaction_id}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/financial/transaction/{transaction_id}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

transaction_idstring required

Query parameters

update_allstring nullable
update_bank_operationboolean nullable

Request body

transaction_typestring nullable

Type of financial transaction. Supported values: 'income', 'expense', 'transference'. Required.

payment_methodstring nullable

Payment method used if the transaction is marked as paid. Required when 'paid' = true (e.g., 'credit_card', 'pix', 'boleto').

bank_typestring nullable

Reference name for the bank integration that will be sent to the bank.

valuenumber nullable

Monetary value of the transaction. Must be greater than zero. Required for all transaction types.

paidboolean nullable

Indicates whether the transaction is paid (true/false). If true, both 'paid_at' and 'payment_method' are required.

contact_keystring nullable

Unique key identifier of the contact linked to the transaction.

pix_keystring nullable

PIX key used for payment (e.g., CPF, email, phone number, random key).

pix_key_typestring nullable

Type of PIX key (e.g., 'cpf', 'email', 'phone', 'random').

account_keystring nullable

Unique account key identifier. Can be used instead of 'account'.

categorystring nullable

Transaction category (e.g., 'Rent', 'Utilities'). Must be a valid system category.

subcategorystring nullable

Detailed transaction subcategory (e.g., 'Electricity', 'Water'). Typically requires 'category'.

descriptionstring nullable

Free text description or notes about the transaction.

observationstring nullable

Optional free text observation about the transaction.

paid_atstring nullable

Date when the transaction was paid. Required if 'paid' = true. Format: 'YYYY-MM-DD'.

repeat_typestring nullable

Recurrence type of the transaction. Supported values: 'unique', 'recurrent', 'installment'. Required.

repeat_totalinteger nullable

Total number of repetitions for a recurring transaction. Cannot exceed 999.

repeat_frequencystring nullable

Frequency of recurrence (e.g., 'monthly', 'weekly'). Required if 'repeat_type' != 'unique'.

due_datestring nullable

Due date of the transaction. Required. Format: 'YYYY-MM-DD'.

duplicatedboolean nullable

Indicates if this transaction is a duplicate of another (true/false).

qrcodestring nullable

QR Code string (usually Base64) for PIX payment.

bar_codestring nullable

Bar code string for boleto or other slip-based payment methods.

landlord_transaction_typestring nullable

Specific type of transaction related to landlord operations (e.g., 'rent_payment').

sum_typestring nullable

Specific type of transaction sum (e.g., 'bank_slip_fee').

property_keystring nullable

Property urlsafe key to link the transaction to a specific property.

Response

Successful Response

transaction_idstring nullable

Changes

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