Invoices

Invoice Update

post/v1/invoice/{invoice_id}

Request

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

Path parameters

invoice_idstring required

Request body

due_datestring nullable

Due date of the invoice, format YYYY-MM-DD. Required for create a new invoice

reference_start_atstring date nullable

Start date of the reference period for the invoice, format YYYY-MM-DD

reference_end_atstring date nullable

End date of the reference period for the invoice, format YYYY-MM-DD

categorystring nullable

Category of the invoice, if exist

subcategorystring nullable

Subcategory of the invoice, if exist

installment_invoice_manualboolean nullable
anticipate_invoiceboolean nullable

Indicate if the invoice is an anticipate invoice, if invoice is associated with a sale contract

send_invoice_notification_emailboolean nullable

Indicate if the invoice notification should be sent by email

send_invoice_notification_whatsappboolean nullable

Indicate if the invoice notification should be sent by WhatsApp

rental_invoice_manualboolean nullable

Indicate if the invoice is a rental invoice, if invoice is associated with a lease

payment_method'bank_slip' | 'credit_card' | 'pix' | 'cash' | 'transference' | 'bank_check' | 'deposit' nullable

Payment method used for the invoice

status'pending' | 'paid' | 'partially_paid' | 'expired' | 'deleted' | 'canceled' | 'all' | 'overdue' | 'draft' | 'in_process'

Current status of the invoice

paid_atstring nullable

Paid date when the invoice was paid, format YYYY-MM-DD

difference_valuenumber nullable

Difference value applied to the invoice when paid with a different value than the total

interest_valuenumber nullable

Interest value applied to the invoice if overdue

send_receipt_tenantboolean nullable

Indicate if the receipt should be sent to the tenant, if exist

send_overdue_notificationboolean nullable

Indicate if the overdue notification should be sent, if exist

payment_maximum_installmentsinteger nullable

Maximum number of installments allowed if payment method is credit card

credit_card_percentagenumber nullable

Percentage of the credit card fee applied to the invoice, if exist

credit_card_installment_percentagenumber nullable

Percentage of the credit card installment fee applied to the invoice, if exist

interest_chargeboolean nullable

Indicate if the interest percent should be applied to the invoice. Only used to define interest_percent, it is not stored in the invoice

fine_chargeboolean nullable

Indicate if the fine percent should be applied to the invoice. Only used to define fine_percent, it is not stored in the invoice

interest_percentnumber nullable

Interest percentage applied to overdue invoice charge fee, if exist

fine_percentnumber nullable

Fine percentage applied to overdue invoice charge fee, if exist

pass_on_fixed_rateboolean nullable

Indicate if the invoice has a fixed rate that should be passed on to the tenant

pass_on_installments_feeboolean nullable

Indicate if the invoice has installments fee that should be passed on to the tenant

pay_automatically_due_dateboolean nullable

Indicate if the invoice can be charged automatically on the credit card of the payer on the due date

interest_descriptionstring nullable

Description of the interest applied to the invoice, if exist

charge_fee_valuenumber nullable

Value of the charge fee applied to the invoice, if exist

charge_feenumber nullable

Charge fee value applied to the invoice, if exist

operation_idstring nullable

Operation identifier for the invoice, if exist

quantity_installmentsinteger nullable

Number of installments for the invoice, if exist

credit_card_infostring nullable

Credit card information associated with the invoice, if exist

user_namestring nullable

Name of the user who created the invoice, if exist

bank_slip_idinteger nullable

Bank slip identifier the invoice, when the invoice was send bank

bank_slip_urlstring nullable

Bank slip url the invoice, when the invoice was send bank

bank_typestring nullable

Bank type associated with the invoice, if exist

barcodestring nullable

Barcode of the invoice, if exist

created_atstring nullable

Creation date of the invoice, format YYYY-MM-DD. Only applied for third-party access users, used for refactoring/recharging with a previous reference period

only_beneficiaries_in_databoolean nullable

Indicates if the invoice data should only include beneficiaries. This is used when the invoice is related to a lease and only the beneficiaries are needed in the response.

confirm_cancel_onlending_paidboolean nullable

Indicate if the user confirmed the cancellation of an invoice that already has a paid onlending to the landlord

Example request

{
  "beneficiaries": [
    {
      "action": "PUT",
      "bank_data": {
        "code": "001",
        "name": "Banco do Brasil"
      }
    }
  ],
  "items": [
    {
      "behavior": "charge_tenant_and_onlend",
      "action": "PUT"
    }
  ],
  "payment_method": "bank_slip",
  "status": "pending"
}

Response

Successful Response

invoice_idstring required

Unique identifier for the created invoice

Changes

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