Contracts

Update A Contract By Contract Id

Update contract

post/v1/contract/{contract_id}

Request

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

Path parameters

contract_idstring required

Query parameters

contract_codestring

Request body

categorystring nullable
subcategorystring nullable
codestring nullable
field_valuesobject[] nullable
contract_typestring nullable
created_atstring nullable
current_installmentinteger nullable
daily_valuenumber nullable
due_daystring nullable
billing_modestring nullable
descriptionstring nullable
durationinteger nullable
duration_typestring nullable
end_atstring nullable
fine_chargeboolean nullable
fine_percent_late_paymentnumber nullable
has_invoiceboolean nullable
include_in_dimobboolean nullable
indeterminateboolean nullable
initial_valuenumber nullable
invoice_descriptionstring nullable
in_progressboolean nullable
interest_chargeboolean nullable
interest_percent_late_paymentnumber nullable
invoice_items_valuenumber nullable
irrfboolean nullable
items_management_feeinteger nullable
last_annual_readjustment_atstring date nullable
lease_typestring nullable
management_feeobject nullable
monthly_valuenumber nullable
next_invoicestring nullable
next_invoice_due_datestring nullable
next_invoice_end_atstring date nullable
next_invoice_generate_instring nullable
next_invoice_start_atstring date nullable
next_invoice_valuenumber nullable
nota_fiscalboolean nullable
propertyobject nullable
proportional_in_next_invoiceboolean nullable
receipt_methodstring nullable
send_nota_fiscal_in_invoice_createboolean nullable
sourcestring nullable
start_atstring nullable
statusstring nullable
updated_atstring nullable
valuenumber nullable
credit_card_percentagenumber nullable
credit_card_installment_percentagenumber nullable
credit_card_pass_on_fixed_rateboolean nullable
credit_card_pass_on_installments_feeboolean nullable
credit_card_auto_chargeboolean nullable
payment_maximum_installmentsinteger nullable

Example request

{
  "contacts": [
    {
      "type": "person if has CPF"
    }
  ],
  "items": [
    {
      "action": "create",
      "behavior": "charge_tenant",
      "item_type": "lease_value",
      "contact": {
        "type": "person if has CPF"
      }
    }
  ]
}

Response

Successful Response

codestring nullable

Changes

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