Create Financial Transaction

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

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

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

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

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

Unique key identifier of the contact linked to the transaction.

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

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

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

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

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

Free text description or notes about the transaction.

Optional free text observation about the transaction.

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

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

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

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

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

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

QR Code string (usually Base64) for PIX payment.

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

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

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

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