Invoices
ERP

Get List Invoices

get/v1/invoices

Request

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

Query parameters

integer
OR
string
contact_typestring nullable
integer
OR
string
integer
OR
string
contract_typestring nullable
integer
OR
string
pageinteger nullable
start_atstring nullable
end_atstring nullable
order_bystring nullable
sort_bystring nullable
statusunknown
payment_method'all' | 'bank_slip' | 'credit_card' | 'pix' | 'cash' | 'transference' | 'all_payments' | 'bank_check' | 'deposit' nullable
payments_methods_availableunknown
periodunknown

Response

Successful Response

countinteger required

Count of invoices returned in the response

next_pageinteger

Next page number for pagination, if available

totalnumber

Total value of all invoices returned in the response

total_paidnumber

Total value of all paid invoices returned in the response

total_pendingnumber

Total value of all pending invoices returned in the response

total_overduenumber

Total value of all overdue invoices returned in the response

Example response

{
  "invoices": [
    {
      "status": "pending",
      "due_date": "2025-10-01",
      "payment_method": "bank_slip",
      "paid_at": "2025-10-01",
      "invoice_url": "https://fatura.imobzi.com/ac-fezg2211236e7k/4b93651c6e3511f093541b6a3214867c-b699"
    }
  ]
}

Changes

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