Vacatia API Catalog
/
Berkley API
/
Contracts
/
Create a contract

Berkley API (1.0.0-BETA2)

Download OpenAPI description
berkley.json
berkley.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/berkley/
The staging API server
https://porter-staging.vacatia.com/api/
The PRODUCTION API server
https://porter.vacatia.com/api/

Owners

Operations

Properties

Operations

Contracts

Operations

Create a contract

Request

Bodyapplication/jsonrequired

The new contract

legacyContractIdstring

The legacy contract ID (spiContractId for instance)

Example: 12345
propertyIdstringrequired
Example: "MT-MLR"
frequencystringrequired
Enum"A""E""O""T0""T1""T2"
usagestringrequired
Enum"fixed_interval_fixed_unit""fixed_interval_float_unit""float_interval_fixed_unit""float_interval_float_unit"
unitSkuCodestringrequired
Example: "101AB"
intervalSkuCodestring
Example: "52"
purchaseDatestring(date)required

The purchase date (i.e. contract date)

firstOccupancyYearintegerrequired
Example: 2030
amountstring
Example: "1000.00"
rciPointsboolean
Default false
primaryOwnerIdstring
Example: "V-0000-0000"
secondaryOwnerIdstring
Example: "V-0000-0000"
additionalOwnerIdsArray of strings
Example: ["V-0000-0000"]
transferSourceIdsArray of strings
Example: ["MLR-12345"]
curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/berkley/contracts \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "legacyContractId": 12345,
    "propertyId": "MT-MLR",
    "frequency": "A",
    "usage": "fixed_interval_fixed_unit",
    "unitSkuCode": "101AB",
    "intervalSkuCode": "52",
    "purchaseDate": "2019-08-24",
    "firstOccupancyYear": 2030,
    "amount": "1000.00",
    "rciPoints": false,
    "primaryOwnerId": "V-0000-0000",
    "secondaryOwnerId": "V-0000-0000",
    "additionalOwnerIds": [
      "V-0000-0000"
    ],
    "transferSourceIds": [
      "MLR-12345"
    ]
  }'

Responses

The new contract id

Bodyapplication/json
dataobject(PostContractResponse)
Response
application/json
{
  "data": {
    "id": "MLR-12345"
  }
}

Reservations

Operations

Guests

Operations