For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
How It WorksKnowledge BaseOnboardingVideo TutorialsPMS GuidanceAPI ReferenceRelease Notes
    • Overview
    • PMS Generic APIs
    • CRM Generic APIs
    • PMS APIs
        • GETGet all construction jobs
        • GETGet construction job by ID
        • GETGet all construction job details for a specific construction job
        • GETGet all contracts for a specific construction job
        • POSTCreate Construction Job: Yardi - Not Supported
        • PUTUpdate Construction Job: Yardi - Not Supported
        • POSTCreate Contract: Yardi
        • PUTUpdate Contract: Yardi
        • GETGet all contract details for a specific contract
    • CRM APIs
    • Download OpenAPI Spec
Dashboard
LogoLogo
Yardi (Legacy)Construction Job Cost

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
>    }
>  ]
>}'
1{
2  "meta": {
3    "job_id": "job-9876fedcba543210"
4  },
5  "result": {
6    "integration_id": "intg-9f8b7c6d5e4a3b2c",
7    "vendor_id": "vend-1234abcd5678efgh",
8    "start_date": "2024-01-15T09:30:00Z",
9    "end_date": "2024-12-31T17:00:00Z",
10    "x_id": "YARDI20240115A1",
11    "notes": "Contract for exterior renovation and landscaping",
12    "expense_type": "Construction Services",
13    "retention_percent": "5.00",
14    "contract_details": [
15      {
16        "construction_job_id": "job-9876fedcba543210",
17        "property_id": "prop-1122334455667788",
18        "total_amount_in_cents": 1500000,
19        "financial_account_id": "finacct-556677889900aabb",
20        "notes": "Includes labor and materials for landscaping",
21        "cost_code": "CC-4500",
22        "category_code": "CAT-12",
23        "retention_percent": "5.00"
24      }
25    ]
26  }
27}
Create Contract: Yardi | Interface | Method | |---|---| | Job Cost | ImportContract | <Note title="Notice">Due to PMS limitations, the ID of the created record cannot be retrieved. This will be found on the next data sync.</Note>
Was this page helpful?
Previous

Update Contract: Yardi

Next
Built with

Create Contract: Yardi

InterfaceMethod
Job CostImportContract
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