Create Contract: Yardi

POST

/v1/contracts/yardi/

POST

/v1/contracts/yardi/

curl -X POST https://api.propexo.com/v1/contracts/yardi/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8b7c6d5e4a3b2c",
  "vendor_id": "vend-1234abcd5678efgh",
  "start_date": "2024-01-15T09:30:00Z",
  "end_date": "2024-12-31T17:00:00Z",
  "contract_details": [
    {
      "construction_job_id": "job-9876fedcba543210",
      "property_id": "prop-1122334455667788",
      "total_amount_in_cents": 1500000
    }
  ]
}'

{
  "meta": {
    "job_id": "job-9876fedcba543210"
  },
  "result": {
    "integration_id": "intg-9f8b7c6d5e4a3b2c",
    "vendor_id": "vend-1234abcd5678efgh",
    "start_date": "2024-01-15T09:30:00Z",
    "end_date": "2024-12-31T17:00:00Z",
    "x_id": "YARDI20240115A1",
    "notes": "Contract for exterior renovation and landscaping",
    "expense_type": "Construction Services",
    "retention_percent": "5.00",
    "contract_details": [
      {
        "construction_job_id": "job-9876fedcba543210",
        "property_id": "prop-1122334455667788",
        "total_amount_in_cents": 1500000,
        "financial_account_id": "finacct-556677889900aabb",
        "notes": "Includes labor and materials for landscaping",
        "cost_code": "CC-4500",
        "category_code": "CAT-12",
        "retention_percent": "5.00"
      }
    ]
  }
}

Create Contract: Yardi

Interface	Method
Job Cost	ImportContract

Notice

Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

integration_idstringRequired

The Propexo unique identifier for the integration

vendor_idstringRequired

The Propexo unique identifier for the vendor

start_datestringRequired

The start date associated with the contract

end_datestringRequired

The end date associated with the contract

contract_detailslist of objectsRequired

x_idstringOptional<=16 characters

The external ID from the integration vendor. This must be a unique value when creating a new contract.

notesstringOptional

Notes associated with the contract

expense_typestringOptional

The expense type of the contract. You'll have to request this data from your customer

retention_percentstringOptional

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error