Invoices
ERP

Get Invoice By Invoice Id

get/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

Query parameters

verify_and_att_invoiceboolean nullable

Response

Successful Response

invoice_idstring required

Unique identifier for the invoice

categorystring nullable

Category of the invoice

subcategorystring nullable

Subcategory of the invoice

due_datestring required

Due date of the invoice, format YYYY-MM-DD

paid_atstring nullable

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

payment_authenticationstring nullable

Payment authentication token for the invoice, if exist

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

Current status of the invoice

invoice_urlstring nullable

URL to access the invoice details in web, if exist

send_overdue_notificationboolean nullable

Indicate if the overdue notification should be sent, if exist

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

Payment method used for the invoice

payments_methods_availableunknown
payment_maximum_installmentsinteger nullable

Maximum number of installments allowed if payment method is credit card, if exist

charge_fee_valuenumber nullable

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

difference_valuenumber nullable

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

interest_valuenumber nullable

Interest value applied to the invoice if overdue, if exist

valuenumber required

Value of the invoice, if exist

total_valuenumber required

Total value of the invoice, if exist

bank_slip_idstring 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

reference_start_atstring nullable

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

reference_end_atstring nullable

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

barcodestring nullable

Barcode of the invoice, if exist

created_atstring nullable

Creation date of the invoice, format YYYY-MM-DD

created_manuallyboolean nullable

Indicate if the invoice was created manually

onlendings_and_feesobject nullable

Onlendings and fees associated with the invoice, if exist

onlending_splitboolean nullable

Indicate if the invoice was split onlending to landlord, only for receipt account integration PJBank

credit_card_percentageinteger nullable

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

credit_card_installment_percentageinteger nullable

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

interest_chargeboolean nullable

Fixed interest charge for late payment

fine_chargeboolean nullable

Fixed fine charge for late payment

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

invoice_paid_manualboolean nullable

Indicate if the invoice was paid manually

historyobject[]

History of changes made to the invoice, if exist

beneficiariesobject[]

List of beneficiaries associated with the invoice, if exist

Example response

{
  "status": "pending",
  "payment_method": "bank_slip",
  "items": [
    {
      "behavior": "charge_tenant_and_onlend",
      "action": "PUT"
    }
  ]
}

Changes

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