Create Contract: Yardi REST

Beta

POSThttps://api.propexo.com/v1/contracts/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
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring
The end date associated with the contract
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
notesstring

Notes associated with the contract

expense_typestring

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

retention_percentstring

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

contract_details object[]required
Array [
construction_job_idstringrequired
The Propexo unique identifier for the construction job
property_idstringrequired
The Propexo unique identifier for the property
financial_account_idstring
The Propexo unique identifier for the financial account
total_amount_in_centsnumberrequired
The amount of the contract detail, in cents
notesstring
Notes associated with the contract detail
cost_codestring
The cost code of the contract detail. You'll have to request this data from your customer
category_codestring
The category code for the contract detail. You'll have to request this data from your customer
retention_percentstring
The retention percent of the contract detail. Must be a decimal number with only 2 places
]

Response

Successful response

meta objectrequired
job_idstringrequired
result objectrequired
integration_idstringrequired
The Propexo unique identifier for the integration
vendor_idstringrequired
The Propexo unique identifier for the vendor
start_datestring | nullnullablerequired
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring | nullnullablerequired
The end date associated with the contract
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
notesstring | nullnullablerequired
Notes associated with the contract
expense_typestring | nullnullablerequired
The expense type of the contract. You'll have to request this data from your customer
retention_percentstring | nullnullablerequired
The retention percent of the contract. Must be a decimal number with only 2 places
contract_details object[]required
Array [
construction_job_idstringrequired
The Propexo unique identifier for the construction job
property_idstringrequired
The Propexo unique identifier for the property
financial_account_idstring
The Propexo unique identifier for the financial account
total_amount_in_centsnumberrequired
The amount of the contract detail, in cents
notesstring
Notes associated with the contract detail
cost_codestring
The cost code of the contract detail. You'll have to request this data from your customer
category_codestring
The category code for the contract detail. You'll have to request this data from your customer
retention_percentstring
The retention percent of the contract detail. Must be a decimal number with only 2 places
]

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

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": "string",
  "vendor_id": "string",
  "start_date": "2024-07-29T15:51:28.071Z",
  "contract_details": [
    {
      "construction_job_id": "string",
      "property_id": "string",
      "financial_account_id": "string",
      "total_amount_in_cents": 0,
      "notes": "string",
      "cost_code": "string",
      "category_code": "string",
      "retention_percent": "string"
    }
  ]
}'

200 Successful response

{
  "meta": {
    "job_id": "string"
  },
  "result": {
    "integration_id": "string",
    "vendor_id": "string",
    "start_date": "2024-07-29T15:51:28.071Z",
    "end_date": "2024-07-29T15:51:28.071Z",
    "notes": "string",
    "expense_type": "string",
    "retention_percent": "string",
    "contract_details": [
      {
        "construction_job_id": "string",
        "property_id": "string",
        "financial_account_id": "string",
        "total_amount_in_cents": 0,
        "notes": "string",
        "cost_code": "string",
        "category_code": "string",
        "retention_percent": "string"
      }
    ]
  }
}