{
  "aid": "swaggerhub.palace:agreement-integration-2.0.0",
  "name": "Agreement Integration",
  "type": "Index",
  "description": "<p>The 'Agreement' integration focuses on allowing 3rd party systems to sync contacts / properties from Palace and create new 'Owners', 'Properties', 'Tenancies' and 'Sub-Tenants'. It also allows for sending official 'Agreements' back to Palace as a file document (PDF Recommended).<br><br>The 'Agreement Integration' area does NOT require an upgrade from a 'Standard' API account to a 'Premium' API Account. There is a NO cost involved in using these contracts unless you are a 3rd Party solution provider wanting to integrate at a partner level.<br><br>Along with the CRM contracts, the system also includes an 'Available Property' contracts for those specifically wanting to display properties that available to tenanted only.<br><br>NOTE: For supporting contracts to obtain further codes for the CRM insert functionality please review the CRM Contracts available at https://app.swaggerhub.com/apis-docs/Palace/CRM_Integration/2.0.0</p><p><strong><BR><B>UPDATE: 18th December, 2025<HR><P></B>The following endpoints have been updated to automatically to include a new field for Pet Bonds Required within a 'Tenancy' (TenancyPetBondRequired)<BR><B><LI>v2DetailedTenancy/JSON/{TenancyCode}<LI>v2ViewAllDetailedTenancy/JSON<LI>v2ViewAllDetailedTenancyByProperty/JSON/{PropertyCode}<LI>v2InsertTenancy/JSON<LI>v2UpdateTenancy/JSON/JSON</B><BR></strong><strong><BR><BR><B>UPDATE:30th September, 2025<HR><P></B>The following endpoints have been updated to automatically exclude 'archived' tenants. This is an extension from an earlier update in Palace, allowing customers to archive 'additional tenants. Now when you call any of the below endpoints, you will only receive 'current/active' tenants from the desired database<BR><B><LI>v2DetailedTenancy/JSON/RBTGXXXXXX<LI>v2ViewAllDetailedTenancyByProperty/JSON/RBPRXXXXXX</B><BR><BR>For those using <B>v2ViewAllDetailedTenancy/JSON</B> you will continue to 'GET' ALL tenants (current & archived), however, you can filter the archived entries out by making a slight adjustment to the endpoint via <B>v2ViewAllDetailedTenancy/JSON?current=yes</B><BR><BR>Update: 11th March 2025 - 'Tenancies' contracts now have the 'Status' exposed (TenancyStatus) to check for Active, Inactive and Debtors...</strong><br><br>v2ViewAllDetailedTenancy/JSON<br>v2DetailedTenancy/JSON<br>v2ViewAllDetailedTenancyByProperty/JSON<br>v2InsertTenancy/JSON<br>v2UpdateTenancy/JSON</p><p><strong>Update: 10th November 2024 - New 'Tenancy Termination' fields exposed…</strong><br>v2DetailedTenancy/JSON<br>v2ViewAllDetailedTenancy/JSON<br>v2ViewAllDetailedTenancyByProperty/JSON<br><br><strong>Update: 13th May 2024 - New Gas &amp; Power Consumption exposed...</strong><br>V2InsertProperty/JSON<br>V2UpdateProperty/JSON</p>",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.palace/agreement-integration/2.0.0/apis.json",
  "tags": [
    "swaggerhub.palace",
    "agreement-integration"
  ],
  "created": "2026-04-04",
  "modified": "2026-04-04",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "swaggerhub.palace:agreement-integration-2.0.0",
      "name": "Agreement Integration",
      "description": "<p>The 'Agreement' integration focuses on allowing 3rd party systems to sync contacts / properties from Palace and create new 'Owners', 'Properties', 'Tenancies' and 'Sub-Tenants'. It also allows for sending official 'Agreements' back to Palace as a file document (PDF Recommended).<br><br>The 'Agreement Integration' area does NOT require an upgrade from a 'Standard' API account to a 'Premium' API Account. There is a NO cost involved in using these contracts unless you are a 3rd Party solution provider wanting to integrate at a partner level.<br><br>Along with the CRM contracts, the system also includes an 'Available Property' contracts for those specifically wanting to display properties that available to tenanted only.<br><br>NOTE: For supporting contracts to obtain further codes for the CRM insert functionality please review the CRM Contracts available at https://app.swaggerhub.com/apis-docs/Palace/CRM_Integration/2.0.0</p><p><strong><BR><B>UPDATE: 18th December, 2025<HR><P></B>The following endpoints have been updated to automatically to include a new field for Pet Bonds Required within a 'Tenancy' (TenancyPetBondRequired)<BR><B><LI>v2DetailedTenancy/JSON/{TenancyCode}<LI>v2ViewAllDetailedTenancy/JSON<LI>v2ViewAllDetailedTenancyByProperty/JSON/{PropertyCode}<LI>v2InsertTenancy/JSON<LI>v2UpdateTenancy/JSON/JSON</B><BR></strong><strong><BR><BR><B>UPDATE:30th September, 2025<HR><P></B>The following endpoints have been updated to automatically exclude 'archived' tenants. This is an extension from an earlier update in Palace, allowing customers to archive 'additional tenants. Now when you call any of the below endpoints, you will only receive 'current/active' tenants from the desired database<BR><B><LI>v2DetailedTenancy/JSON/RBTGXXXXXX<LI>v2ViewAllDetailedTenancyByProperty/JSON/RBPRXXXXXX</B><BR><BR>For those using <B>v2ViewAllDetailedTenancy/JSON</B> you will continue to 'GET' ALL tenants (current & archived), however, you can filter the archived entries out by making a slight adjustment to the endpoint via <B>v2ViewAllDetailedTenancy/JSON?current=yes</B><BR><BR>Update: 11th March 2025 - 'Tenancies' contracts now have the 'Status' exposed (TenancyStatus) to check for Active, Inactive and Debtors...</strong><br><br>v2ViewAllDetailedTenancy/JSON<br>v2DetailedTenancy/JSON<br>v2ViewAllDetailedTenancyByProperty/JSON<br>v2InsertTenancy/JSON<br>v2UpdateTenancy/JSON</p><p><strong>Update: 10th November 2024 - New 'Tenancy Termination' fields exposed…</strong><br>v2DetailedTenancy/JSON<br>v2ViewAllDetailedTenancy/JSON<br>v2ViewAllDetailedTenancyByProperty/JSON<br><br><strong>Update: 13th May 2024 - New Gas &amp; Power Consumption exposed...</strong><br>V2InsertProperty/JSON<br>V2UpdateProperty/JSON</p>",
      "image": "",
      "baseURL": "https://api.getpalace.com/Service.svc/RestService",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.palace/agreement-integration/2.0.0",
      "version": "2.0.0",
      "tags": [
        "swaggerhub.palace",
        "agreement-integration"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/swaggerhub.palace/agreement-integration/2.0.0/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/swaggerhub.palace/agreement-integration/2.0.0"
        }
      ],
      "contact": [
        {
          "FN": "Palace.Support@mrisoftware.com",
          "email": "Palace.Support@mrisoftware.com"
        }
      ]
    }
  ]
}