Create Contract: Yardi REST

Beta

POST

/v1/contracts/yardi_rest/

POST

/v1/contracts/yardi_rest/

curl -X POST https://api.propexo.com/v1/contracts/yardi_rest/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "intg-9f8b7c6d5e4a3b2c",
  "vendor_id": "vend-1234567890abcdef",
  "start_date": "2024-01-15T09:30:00Z",
  "contract_details": [
    {
      "construction_job_id": "job-9876543210fedcba",
      "property_id": "prop-1122334455667788",
      "total_amount_in_cents": 1500000
    }
  ]
}'

{
  "meta": {
    "job_id": "job-9876543210fedcba"
  },
  "result": {
    "integration_id": "intg-9f8b7c6d5e4a3b2c",
    "vendor_id": "vend-1234567890abcdef",
    "start_date": "2024-01-15T09:30:00Z",
    "end_date": "2025-01-15T09:30:00Z",
    "notes": "Annual maintenance contract for HVAC system",
    "expense_type": "Maintenance",
    "retention_percent": "5.00",
    "contract_details": [
      {
        "construction_job_id": "job-9876543210fedcba",
        "property_id": "prop-1122334455667788",
        "total_amount_in_cents": 1500000,
        "financial_account_id": "finacc-556677889900aabb",
        "notes": "Includes labor and materials",
        "cost_code": "CC-4500",
        "category_code": "CAT-300",
        "retention_percent": "5.00"
      }
    ]
  }
}

Create Contract: Yardi REST

Interface	Method
Job Cost	/ItfJobCost/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

contract_detailslist of objectsRequired

end_datestringOptional

The end date associated with the 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

The retention percent of the contract. Must be a decimal number with only 2 places

Response

Successful response

metaobject

resultobject

Errors

400

Bad Request Error