Contracts
ERP

Retrieve A Contract By Contract Code

Get contract

get/v1/contract/code/{contract_code}

Request

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

Path parameters

contract_codestring required

Query parameters

contract_idstring

Response

Successful Response

Example response

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

Changes

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