MyCRM API v1
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Authentication
- HTTP Authentication, scheme: Bearer JWT authorization header using the Bearer scheme.
Adviser
Gets a collection of advisers
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdvisersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/advisers/{id}/relationships/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/addresses',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/advisers/{id}/relationships/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/advisers/{id}/relationships/addresses',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/advisers/{id}/relationships/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single adviser by id
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdviserDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contactGroups related to a single adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/relationships/contactGroups \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/contactGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/relationships/contactGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/relationships/contactGroups',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/relationships/contactGroups
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets contactGroups via a single related adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/contactGroups \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/contactGroups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/contactGroups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/contactGroups',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/contactGroups
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactGroupsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets adviserDetails via a single related adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/adviserDetails \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/adviserDetails',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/adviserDetails', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/adviserDetails',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/adviserDetails
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdviserDetailsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets organisations via a single related adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/organisation \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/organisation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/organisation', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/organisation',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/organisation
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OrganisationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets agreementHolders via a single related adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/agreementHolders \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/agreementHolders',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/agreementHolders', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/agreementHolders',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/agreementHolders
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
},
"relationships": {
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AgreementHoldersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets addresses via a single related adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/addresses
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isBusiness": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdviserAddressesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a adviserDetails related to a single adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/relationships/adviserDetails \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/adviserDetails',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/relationships/adviserDetails', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/relationships/adviserDetails',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/relationships/adviserDetails
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a organisations related to a single adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/relationships/organisation \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/organisation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/relationships/organisation', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/relationships/organisation',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/relationships/organisation
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a agreementHolders related to a single adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/relationships/agreementHolders \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/agreementHolders',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/relationships/agreementHolders', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/relationships/agreementHolders',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/relationships/agreementHolders
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a addresses related to a single adviser
Code samples
# You can also use wget
curl -X GET /jsonapi/advisers/{id}/relationships/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/advisers/{id}/relationships/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/advisers/{id}/relationships/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/advisers/{id}/relationships/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/advisers/{id}/relationships/addresses
Where id is the identifier of the adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
AdviserDetails
Gets advisers via a single related adviser detail
Code samples
# You can also use wget
curl -X GET /jsonapi/adviser-details/{id}/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/adviser-details/{id}/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/adviser-details/{id}/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/adviser-details/{id}/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/adviser-details/{id}/adviser
Where id is the identifier of the adviser detail
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdvisersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/adviser-details/{id}/relationships/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/adviser-details/{id}/relationships/adviser',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/adviser-details/{id}/relationships/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/adviser-details/{id}/relationships/adviser',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/adviser-details/{id}/relationships/adviser
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of adviser details
Code samples
# You can also use wget
curl -X GET /jsonapi/adviser-details \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/adviser-details',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/adviser-details', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/adviser-details',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/adviser-details
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdviserDetailsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single adviser detail by id
Code samples
# You can also use wget
curl -X GET /jsonapi/adviser-details/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/adviser-details/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/adviser-details/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/adviser-details/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/adviser-details/{id}
Where id is the identifier of the adviser detail
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdviserDetailDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a advisers related to a single adviser detail
Code samples
# You can also use wget
curl -X GET /jsonapi/adviser-details/{id}/relationships/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/adviser-details/{id}/relationships/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/adviser-details/{id}/relationships/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/adviser-details/{id}/relationships/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/adviser-details/{id}/relationships/adviser
Where id is the identifier of the adviser detail
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Assets
Gets a addresses related to a single asset
Code samples
# You can also use wget
curl -X GET /jsonapi/assets/{id}/relationships/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}/relationships/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets/{id}/relationships/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets/{id}/relationships/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets/{id}/relationships/addresses
Where id is the identifier of the asset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/assets/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}/relationships/ownership',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/assets/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/assets/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/assets/{id}/relationships/ownership
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets addresses via a single related asset
Code samples
# You can also use wget
curl -X GET /jsonapi/assets/{id}/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets/{id}/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets/{id}/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets/{id}/addresses
Where id is the identifier of the asset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | FinancialAddressesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets ownerships via a single related asset
Code samples
# You can also use wget
curl -X GET /jsonapi/assets/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets/{id}/ownership
Where id is the identifier of the asset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OwnersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of assets
Code samples
# You can also use wget
curl -X GET /jsonapi/assets \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single asset by id
Code samples
# You can also use wget
curl -X GET /jsonapi/assets/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets/{id}
Where id is the identifier of the asset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a ownerships related to a single asset
Code samples
# You can also use wget
curl -X GET /jsonapi/assets/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/assets/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/assets/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/assets/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/assets/{id}/relationships/ownership
Where id is the identifier of the asset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
AssetCategories
Gets a collection of asset categories
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-categories \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-categories', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-categories',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/asset-categories/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-categories/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/asset-categories/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/asset-categories/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/asset-categories/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single asset category by id
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-categories/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-categories/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-categories/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-categories/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-categories/{id}
Where id is the identifier of the asset category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetCategoryDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
ContactGroups
Gets advisers via a single related contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/adviser
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdvisersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/contact-groups/{id}/relationships/referrer \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/referrer',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/contact-groups/{id}/relationships/referrer', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/contact-groups/{id}/relationships/referrer',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/contact-groups/{id}/relationships/referrer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets contacts via a single related contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/contacts \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/contacts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/contacts',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/contacts
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets businesses via a single related contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/businesses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/businesses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/businesses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/businesses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/businesses
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | BusinessesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of contact groups
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactGroupsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single contact group by id
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactGroupDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a businesses related to a single contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/relationships/businesses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/businesses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/relationships/businesses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/relationships/businesses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/relationships/businesses
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets referrerOrganisations via a single related contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/referrerOrganisation \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/referrerOrganisation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/referrerOrganisation', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/referrerOrganisation',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/referrerOrganisation
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrgName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ReferrerOrganisationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets referrers via a single related contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/referrer \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/referrer',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/referrer', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/referrer',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/referrer
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ReferrerMembersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contacts related to a single contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/relationships/contacts \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/relationships/contacts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/relationships/contacts',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/relationships/contacts
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a advisers related to a single contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/relationships/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/relationships/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/relationships/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/relationships/adviser
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a referrerOrganisations related to a single contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/relationships/referrerOrganisation \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/referrerOrganisation',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/relationships/referrerOrganisation', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/relationships/referrerOrganisation',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/relationships/referrerOrganisation
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a referrers related to a single contact group
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-groups/{id}/relationships/referrer \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-groups/{id}/relationships/referrer',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-groups/{id}/relationships/referrer', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-groups/{id}/relationships/referrer',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-groups/{id}/relationships/referrer
Where id is the identifier of the contact group
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
AssetSubTypes
Gets a collection of asset sub-types
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-sub-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-sub-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-sub-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-sub-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-sub-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetSubTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/asset-sub-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-sub-types/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/asset-sub-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/asset-sub-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/asset-sub-types/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single asset sub-type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-sub-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-sub-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-sub-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-sub-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-sub-types/{id}
Where id is the identifier of the asset sub-type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetSubTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
ContactExternalReferences
Gets a integrations related to a single contact external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references/{id}/relationships/integration \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}/relationships/integration',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references/{id}/relationships/integration', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references/{id}/relationships/integration',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references/{id}/relationships/integration
Where id is the identifier of the contact external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/contact-external-references/{id}/relationships/contact \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}/relationships/contact',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/contact-external-references/{id}/relationships/contact', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/contact-external-references/{id}/relationships/contact',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/contact-external-references/{id}/relationships/contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets integrations via a single related contact external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references/{id}/integration \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}/integration',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references/{id}/integration', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references/{id}/integration',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references/{id}/integration
Where id is the identifier of the contact external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IntegrationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets contacts via a single related contact external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references/{id}/contact \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}/contact',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references/{id}/contact', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references/{id}/contact',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references/{id}/contact
Where id is the identifier of the contact external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of external references of contacts
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single contact external reference by id
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references/{id}
Where id is the identifier of the contact external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactExternalReferenceDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contacts related to a single contact external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-external-references/{id}/relationships/contact \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-external-references/{id}/relationships/contact',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-external-references/{id}/relationships/contact', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-external-references/{id}/relationships/contact',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-external-references/{id}/relationships/contact
Where id is the identifier of the contact external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
AssetTypes
Gets a collection of asset types
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/asset-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-types/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/asset-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/asset-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/asset-types/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single asset type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/asset-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/asset-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/asset-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/asset-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/asset-types/{id}
Where id is the identifier of the asset type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Contacts
Gets contactGroups via a single related contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/contactGroup \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/contactGroup',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/contactGroup', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/contactGroup',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/contactGroup
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactGroupsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/contacts/{id}/relationships/contactAddress \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/contactAddress',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/contacts/{id}/relationships/contactAddress', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/contacts/{id}/relationships/contactAddress',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/contacts/{id}/relationships/contactAddress
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of contacts
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single contact by id
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contactGroups related to a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/relationships/contactGroup \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/contactGroup',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/relationships/contactGroup', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/relationships/contactGroup',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/relationships/contactGroup
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets ownerships via a single related contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/ownership
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OwnersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets externalReferences via a single related contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/externalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/externalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/externalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/externalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/externalReferences
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets deals via a single related contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/deals \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/deals',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/deals', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/deals',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/deals
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealParticipantsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets contactAddresses via a single related contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/contactAddress \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/contactAddress',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/contactAddress', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/contactAddress',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/contactAddress
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactAddressesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a ownerships related to a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/relationships/ownership
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a externalReferences related to a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/relationships/externalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/externalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/relationships/externalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/relationships/externalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/relationships/externalReferences
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a deals related to a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/relationships/deals \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/deals',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/relationships/deals', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/relationships/deals',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/relationships/deals
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contactAddresses related to a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contacts/{id}/relationships/contactAddress \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contacts/{id}/relationships/contactAddress',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contacts/{id}/relationships/contactAddress', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contacts/{id}/relationships/contactAddress',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contacts/{id}/relationships/contactAddress
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
ContactMarketingConsent
Updates the marketing consent declaration of an existing contact
Code samples
# You can also use wget
curl -X PATCH /jsonapi/contact-marketing/{id} \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"attributes": {
"hasMarketingConsent": true
},
"relationships": {},
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-marketing/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.patch('/jsonapi/contact-marketing/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.patch '/jsonapi/contact-marketing/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /jsonapi/contact-marketing/{id}
Where id is the identifier of the contact
Body parameter
{
"data": {
"type": "string",
"attributes": {
"hasMarketingConsent": true
},
"relationships": {},
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | ContactMarketingDocument | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactMarketingDocument |
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets the marketing consent declaration of a single contact
Code samples
# You can also use wget
curl -X GET /jsonapi/contact-marketing/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/contact-marketing/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/contact-marketing/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/contact-marketing/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/contact-marketing/{id}
Where id is the identifier of the contact
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactMarketingDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
DealExternalReferences
Gets deals via a single related deal external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references/{id}/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references/{id}/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references/{id}/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references/{id}/deal
Where id is the identifier of the deal external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/deal-external-references/{id}/relationships/integration \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}/relationships/integration',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/deal-external-references/{id}/relationships/integration', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/deal-external-references/{id}/relationships/integration',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/deal-external-references/{id}/relationships/integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of external references of deals
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single deal external reference by id
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references/{id}
Where id is the identifier of the deal external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealExternalReferenceDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a deals related to a single deal external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}/relationships/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references/{id}/relationships/deal
Where id is the identifier of the deal external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets integrations via a single related deal external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references/{id}/integration \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}/integration',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references/{id}/integration', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references/{id}/integration',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references/{id}/integration
Where id is the identifier of the deal external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IntegrationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a integrations related to a single deal external reference
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-external-references/{id}/relationships/integration \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-external-references/{id}/relationships/integration',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-external-references/{id}/relationships/integration', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-external-references/{id}/relationships/integration',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-external-references/{id}/relationships/integration
Where id is the identifier of the deal external reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
DealNotes
Gets deals via a single related deal note
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-notes/{id}/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-notes/{id}/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-notes/{id}/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-notes/{id}/deal
Where id is the identifier of the deal note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/deal-notes/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/relationships/deal',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/deal-notes/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/deal-notes/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/deal-notes/{id}/relationships/deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Creates a new deal note with attributes, relationships or both
Code samples
# You can also use wget
curl -X POST /jsonapi/deal-notes \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"attributes": {
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"data": {
"type": "string",
"id": "string"
}
}
},
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.post('/jsonapi/deal-notes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.post '/jsonapi/deal-notes',
params: {
}, headers: headers
p JSON.parse(result)
POST /jsonapi/deal-notes
Body parameter
{
"data": {
"type": "string",
"attributes": {
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"data": {
"type": "string",
"id": "string"
}
}
},
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | DealNoteDocument | false | none |
Example responses
201 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | DealNoteDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | Location of newly created resource |
Updates the attributes and/or relationships of an existing deal note. Only the values of sent attributes are replaced. And only the values of sent relationships are replaced
Code samples
# You can also use wget
curl -X PATCH /jsonapi/deal-notes/{id} \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"attributes": {
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"data": {
"type": "string",
"id": "string"
}
}
},
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.patch('/jsonapi/deal-notes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.patch '/jsonapi/deal-notes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /jsonapi/deal-notes/{id}
Where id is the identifier of the deal note
Body parameter
{
"data": {
"type": "string",
"attributes": {
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"data": {
"type": "string",
"id": "string"
}
}
},
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | DealNoteDocument | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealNoteDocument |
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single deal note by id
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-notes/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-notes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-notes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-notes/{id}
Where id is the identifier of the deal note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealNoteDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Deletes an existing deal note
Code samples
# You can also use wget
curl -X DELETE /jsonapi/deal-notes/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.delete('/jsonapi/deal-notes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.delete '/jsonapi/deal-notes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /jsonapi/deal-notes/{id}
Where id is the identifier of the deal note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a deals related to a single deal note
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-notes/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/relationships/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-notes/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-notes/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-notes/{id}/relationships/deal
Where id is the identifier of the deal note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Adds deals to a to-many relationship with an existing deal note
Code samples
# You can also use wget
curl -X POST /jsonapi/deal-notes/{id}/relationships/deal \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/relationships/deal',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.post('/jsonapi/deal-notes/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.post '/jsonapi/deal-notes/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
POST /jsonapi/deal-notes/{id}/relationships/deal
Where id is the identifier of the primary deal note resource
Body parameter
{
"data": {
"type": "string",
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | RelationshipsSingleDocument | false | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Performs a complete replacement of a deal relationship on an existing deal note
Code samples
# You can also use wget
curl -X PATCH /jsonapi/deal-notes/{id}/relationships/deal \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/relationships/deal',
{
method: 'PATCH',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.patch('/jsonapi/deal-notes/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.patch '/jsonapi/deal-notes/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
PATCH /jsonapi/deal-notes/{id}/relationships/deal
Where id is the identifier of the deal note
Body parameter
{
"data": {
"type": "string",
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
| body | body | RelationshipsSingleDocument | false | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Removes a deal note from a to-many relationship with deals
Code samples
# You can also use wget
curl -X DELETE /jsonapi/deal-notes/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-notes/{id}/relationships/deal',
{
method: 'DELETE',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.delete('/jsonapi/deal-notes/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.delete '/jsonapi/deal-notes/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
DELETE /jsonapi/deal-notes/{id}/relationships/deal
Where id is the identifier of the deal note
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | none | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
DealParticipants
Gets contacts via a single related participants in a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants/{id}/contact \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}/contact',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants/{id}/contact', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants/{id}/contact',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants/{id}/contact
Where id is the identifier of the participants in a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/deal-participants/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}/relationships/deal',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/deal-participants/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/deal-participants/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/deal-participants/{id}/relationships/deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of participants in deals
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealParticipantsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single participants in a deal by id
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants/{id}
Where id is the identifier of the participants in a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealParticipantDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contacts related to a single participants in a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants/{id}/relationships/contact \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}/relationships/contact',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants/{id}/relationships/contact', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants/{id}/relationships/contact',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants/{id}/relationships/contact
Where id is the identifier of the participants in a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets deals via a single related participants in a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants/{id}/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants/{id}/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants/{id}/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants/{id}/deal
Where id is the identifier of the participants in a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a deals related to a single participants in a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-participants/{id}/relationships/deal \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-participants/{id}/relationships/deal',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-participants/{id}/relationships/deal', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-participants/{id}/relationships/deal',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-participants/{id}/relationships/deal
Where id is the identifier of the participants in a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Deals
Gets dealScenarios via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/dealScenario \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/dealScenario',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/dealScenario', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/dealScenario',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/dealScenario
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealScenariosDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/deals/{id}/relationships/loanSecurities \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/loanSecurities',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/deals/{id}/relationships/loanSecurities', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/deals/{id}/relationships/loanSecurities',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/deals/{id}/relationships/loanSecurities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of deals
Code samples
# You can also use wget
curl -X GET /jsonapi/deals \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single deal by id
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a dealScenarios related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/dealScenario \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/dealScenario',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/dealScenario', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/dealScenario',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/dealScenario
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets importantDates via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/importantDates \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/importantDates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/importantDates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/importantDates',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/importantDates
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"date": "2019-08-24",
"dateType": "Settled"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealImportantDatesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets participants via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/participants \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/participants',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/participants', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/participants',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/participants
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealParticipantsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets externalReferences via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/externalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/externalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/externalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/externalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/externalReferences
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets contacts via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/contacts \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/contacts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/contacts',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/contacts
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets dealStructures via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/dealStructures \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/dealStructures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/dealStructures', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/dealStructures',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/dealStructures
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"fixedRateBeginDate": "2019-08-24",
"rateTypePeriodMonths": 0,
"loanStructureType": "PrincipalInterest",
"interestRate": 0.1,
"amount": 0.1,
"rateType": "string",
"paymentAmount": 0.1,
"interestOnlyExpiryDate": "2019-08-24",
"loanTermYears": 0.1,
"fixedRateExpiryDate": "2019-08-24"
},
"relationships": {
"dealImportantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealStructuresDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets advisers via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/adviser
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AdvisersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets dealNotes via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/dealNotes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/dealNotes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/dealNotes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/dealNotes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/dealNotes
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealNotesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets loanSecurities via a single related deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/loanSecurities \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/loanSecurities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/loanSecurities', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/loanSecurities',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/loanSecurities
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealSecuritiesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a importantDates related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/importantDates \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/importantDates',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/importantDates', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/importantDates',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/importantDates
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a participants related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/participants \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/participants',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/participants', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/participants',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/participants
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a externalReferences related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/externalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/externalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/externalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/externalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/externalReferences
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contacts related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/contacts \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/contacts',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/contacts', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/contacts',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/contacts
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a dealStructures related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/dealStructures \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/dealStructures',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/dealStructures', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/dealStructures',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/dealStructures
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a advisers related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/adviser \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/adviser',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/adviser', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/adviser',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/adviser
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a dealNotes related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/dealNotes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/dealNotes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/dealNotes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/dealNotes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/dealNotes
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a loanSecurities related to a single deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deals/{id}/relationships/loanSecurities \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deals/{id}/relationships/loanSecurities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deals/{id}/relationships/loanSecurities', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deals/{id}/relationships/loanSecurities',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deals/{id}/relationships/loanSecurities
Where id is the identifier of the deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
DealSecurities
Gets assets via a single related securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/asset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/asset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/asset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/asset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/asset
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/deal-securities/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/relationships/ownership',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/deal-securities/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/deal-securities/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/deal-securities/{id}/relationships/ownership
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of securities for deals
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealSecuritiesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single securities for a deal by id
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealSecurityDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a assets related to a single securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/relationships/asset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/relationships/asset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/relationships/asset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/relationships/asset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/relationships/asset
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets titleIdentifications via a single related securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/titleIdentifications \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/titleIdentifications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/titleIdentifications', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/titleIdentifications',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/titleIdentifications
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"titleIdentificationType": "string",
"value": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealSecurityTitleIdentitiesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets ownerships via a single related securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/ownership
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"ownershipPercentage": 0.1
},
"relationships": {
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealSecurityOwnershipsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a titleIdentifications related to a single securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/relationships/titleIdentifications \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/relationships/titleIdentifications',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/relationships/titleIdentifications', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/relationships/titleIdentifications',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/relationships/titleIdentifications
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a ownerships related to a single securities for a deal
Code samples
# You can also use wget
curl -X GET /jsonapi/deal-securities/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/deal-securities/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/deal-securities/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/deal-securities/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/deal-securities/{id}/relationships/ownership
Where id is the identifier of the securities for a deal
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Incomes
Gets a ownerships related to a single income
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes/{id}/relationships/ownership
Where id is the identifier of the income
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/incomes/{id}/relationships/linkedAsset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}/relationships/linkedAsset',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/incomes/{id}/relationships/linkedAsset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/incomes/{id}/relationships/linkedAsset',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/incomes/{id}/relationships/linkedAsset
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets ownerships via a single related income
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes/{id}/ownership
Where id is the identifier of the income
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OwnersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets linkedAssets via a single related income
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes/{id}/linkedAsset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}/linkedAsset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes/{id}/linkedAsset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes/{id}/linkedAsset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes/{id}/linkedAsset
Where id is the identifier of the income
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of incomes
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single income by id
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes/{id}
Where id is the identifier of the income
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a linkedAssets related to a single income
Code samples
# You can also use wget
curl -X GET /jsonapi/incomes/{id}/relationships/linkedAsset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/incomes/{id}/relationships/linkedAsset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/incomes/{id}/relationships/linkedAsset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/incomes/{id}/relationships/linkedAsset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/incomes/{id}/relationships/linkedAsset
Where id is the identifier of the income
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
EnquirySources
Gets a collection of enquiry sources
Code samples
# You can also use wget
curl -X GET /jsonapi/enquiry-sources \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/enquiry-sources',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/enquiry-sources', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/enquiry-sources',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/enquiry-sources
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | EnquirySourcesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/enquiry-sources/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/enquiry-sources/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/enquiry-sources/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/enquiry-sources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/enquiry-sources/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single enquiry source by id
Code samples
# You can also use wget
curl -X GET /jsonapi/enquiry-sources/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/enquiry-sources/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/enquiry-sources/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/enquiry-sources/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/enquiry-sources/{id}
Where id is the identifier of the enquiry source
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | EnquirySourceDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
ExpenseCategories
Gets expenseTypes via a single related expense category
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-categories/{id}/expenseTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-categories/{id}/expenseTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-categories/{id}/expenseTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-categories/{id}/expenseTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-categories/{id}/expenseTypes
Where id is the identifier of the expense category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-categories/{id}/relationships/expenseTypes',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/expense-categories/{id}/relationships/expenseTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/expense-categories/{id}/relationships/expenseTypes',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/expense-categories/{id}/relationships/expenseTypes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of expense categories
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-categories \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-categories', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-categories',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single expense category by id
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-categories/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-categories/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-categories/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-categories/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-categories/{id}
Where id is the identifier of the expense category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseCategoryDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a expenseTypes related to a single expense category
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-categories/{id}/relationships/expenseTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-categories/{id}/relationships/expenseTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-categories/{id}/relationships/expenseTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-categories/{id}/relationships/expenseTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-categories/{id}/relationships/expenseTypes
Where id is the identifier of the expense category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Expenses
Gets ownerships via a single related expense
Code samples
# You can also use wget
curl -X GET /jsonapi/expenses/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expenses/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expenses/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expenses/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expenses/{id}/ownership
Where id is the identifier of the expense
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OwnersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/expenses/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expenses/{id}/relationships/ownership',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/expenses/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/expenses/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/expenses/{id}/relationships/ownership
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of expenses
Code samples
# You can also use wget
curl -X GET /jsonapi/expenses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expenses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expenses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expenses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expenses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpensesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single expense by id
Code samples
# You can also use wget
curl -X GET /jsonapi/expenses/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expenses/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expenses/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expenses/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expenses/{id}
Where id is the identifier of the expense
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a ownerships related to a single expense
Code samples
# You can also use wget
curl -X GET /jsonapi/expenses/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expenses/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expenses/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expenses/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expenses/{id}/relationships/ownership
Where id is the identifier of the expense
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
ExpenseTypes
Gets expenseCategories via a single related expense type
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-types/{id}/expenseCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-types/{id}/expenseCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-types/{id}/expenseCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-types/{id}/expenseCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-types/{id}/expenseCategory
Where id is the identifier of the expense type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-types/{id}/relationships/expenseCategory',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/expense-types/{id}/relationships/expenseCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/expense-types/{id}/relationships/expenseCategory',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/expense-types/{id}/relationships/expenseCategory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of expense types
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single expense type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-types/{id}
Where id is the identifier of the expense type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ExpenseTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a expenseCategories related to a single expense type
Code samples
# You can also use wget
curl -X GET /jsonapi/expense-types/{id}/relationships/expenseCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/expense-types/{id}/relationships/expenseCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/expense-types/{id}/relationships/expenseCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/expense-types/{id}/relationships/expenseCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/expense-types/{id}/relationships/expenseCategory
Where id is the identifier of the expense type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
IncomeCategories
Gets incomeTypes via a single related income category
Code samples
# You can also use wget
curl -X GET /jsonapi/income-categories/{id}/incomeTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-categories/{id}/incomeTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-categories/{id}/incomeTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-categories/{id}/incomeTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-categories/{id}/incomeTypes
Where id is the identifier of the income category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-categories/{id}/relationships/incomeTypes',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/income-categories/{id}/relationships/incomeTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/income-categories/{id}/relationships/incomeTypes',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/income-categories/{id}/relationships/incomeTypes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of income categories
Code samples
# You can also use wget
curl -X GET /jsonapi/income-categories \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-categories', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-categories',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single income category by id
Code samples
# You can also use wget
curl -X GET /jsonapi/income-categories/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-categories/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-categories/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-categories/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-categories/{id}
Where id is the identifier of the income category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeCategoryDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a incomeTypes related to a single income category
Code samples
# You can also use wget
curl -X GET /jsonapi/income-categories/{id}/relationships/incomeTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-categories/{id}/relationships/incomeTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-categories/{id}/relationships/incomeTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-categories/{id}/relationships/incomeTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-categories/{id}/relationships/incomeTypes
Where id is the identifier of the income category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
IncomeTypes
Gets incomeCategories via a single related income type
Code samples
# You can also use wget
curl -X GET /jsonapi/income-types/{id}/incomeCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-types/{id}/incomeCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-types/{id}/incomeCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-types/{id}/incomeCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-types/{id}/incomeCategory
Where id is the identifier of the income type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/income-types/{id}/relationships/incomeCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-types/{id}/relationships/incomeCategory',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/income-types/{id}/relationships/incomeCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/income-types/{id}/relationships/incomeCategory',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/income-types/{id}/relationships/incomeCategory
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of income types
Code samples
# You can also use wget
curl -X GET /jsonapi/income-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single income type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/income-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-types/{id}
Where id is the identifier of the income type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IncomeTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a incomeCategories related to a single income type
Code samples
# You can also use wget
curl -X GET /jsonapi/income-types/{id}/relationships/incomeCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/income-types/{id}/relationships/incomeCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/income-types/{id}/relationships/incomeCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/income-types/{id}/relationships/incomeCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/income-types/{id}/relationships/incomeCategory
Where id is the identifier of the income type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Integrations
Gets contactExternalReferences via a single related integration
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations/{id}/contactExternalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}/contactExternalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations/{id}/contactExternalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations/{id}/contactExternalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations/{id}/contactExternalReferences
Where id is the identifier of the integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ContactExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/integrations/{id}/relationships/dealExternalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}/relationships/dealExternalReferences',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/integrations/{id}/relationships/dealExternalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/integrations/{id}/relationships/dealExternalReferences',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/integrations/{id}/relationships/dealExternalReferences
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of integrations
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IntegrationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single integration by id
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations/{id}
Where id is the identifier of the integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | IntegrationDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a contactExternalReferences related to a single integration
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations/{id}/relationships/contactExternalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}/relationships/contactExternalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations/{id}/relationships/contactExternalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations/{id}/relationships/contactExternalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations/{id}/relationships/contactExternalReferences
Where id is the identifier of the integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets dealExternalReferences via a single related integration
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations/{id}/dealExternalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}/dealExternalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations/{id}/dealExternalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations/{id}/dealExternalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations/{id}/dealExternalReferences
Where id is the identifier of the integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | DealExternalReferencesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a dealExternalReferences related to a single integration
Code samples
# You can also use wget
curl -X GET /jsonapi/integrations/{id}/relationships/dealExternalReferences \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/integrations/{id}/relationships/dealExternalReferences',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/integrations/{id}/relationships/dealExternalReferences', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/integrations/{id}/relationships/dealExternalReferences',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/integrations/{id}/relationships/dealExternalReferences
Where id is the identifier of the integration
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Liabilities
Gets linkedAssets via a single related liabilities
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities/{id}/linkedAsset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}/linkedAsset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities/{id}/linkedAsset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities/{id}/linkedAsset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities/{id}/linkedAsset
Where id is the identifier of the liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | AssetsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/liabilities/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}/relationships/ownership',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/liabilities/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/liabilities/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/liabilities/{id}/relationships/ownership
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of liabilities
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilitiesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single liabilities by id
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities/{id}
Where id is the identifier of the liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a linkedAssets related to a single liabilities
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities/{id}/relationships/linkedAsset \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}/relationships/linkedAsset',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities/{id}/relationships/linkedAsset', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities/{id}/relationships/linkedAsset',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities/{id}/relationships/linkedAsset
Where id is the identifier of the liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets ownerships via a single related liabilities
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities/{id}/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities/{id}/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities/{id}/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities/{id}/ownership
Where id is the identifier of the liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OwnersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a ownerships related to a single liabilities
Code samples
# You can also use wget
curl -X GET /jsonapi/liabilities/{id}/relationships/ownership \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liabilities/{id}/relationships/ownership',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liabilities/{id}/relationships/ownership', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liabilities/{id}/relationships/ownership',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liabilities/{id}/relationships/ownership
Where id is the identifier of the liabilities
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Leads
Creates a lead, including contact and deal attributes
Code samples
# You can also use wget
curl -X POST /jsonapi/leads \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"attributes": {
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true
},
"relationships": {},
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/leads',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.post('/jsonapi/leads', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.post '/jsonapi/leads',
params: {
}, headers: headers
p JSON.parse(result)
POST /jsonapi/leads
Body parameter
{
"data": {
"type": "string",
"attributes": {
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true
},
"relationships": {},
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | LeadDocument | false | none |
Example responses
201 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | LeadDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | Location of newly created resource |
Gets select details if an existing lead
Code samples
# You can also use wget
curl -X GET /jsonapi/leads/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/leads/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/leads/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/leads/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/leads/{id}
Where id is the identifier of the lead
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LeadDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
LiabilityCategories
Gets liabilityTypes via a single related liability category
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-categories/{id}/liabilityTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-categories/{id}/liabilityTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-categories/{id}/liabilityTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-categories/{id}/liabilityTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-categories/{id}/liabilityTypes
Where id is the identifier of the liability category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-categories/{id}/relationships/liabilityTypes',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/liability-categories/{id}/relationships/liabilityTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/liability-categories/{id}/relationships/liabilityTypes',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/liability-categories/{id}/relationships/liabilityTypes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of liability categories
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-categories \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-categories',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-categories', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-categories',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-categories
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single liability category by id
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-categories/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-categories/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-categories/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-categories/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-categories/{id}
Where id is the identifier of the liability category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityCategoryDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a liabilityTypes related to a single liability category
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-categories/{id}/relationships/liabilityTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-categories/{id}/relationships/liabilityTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-categories/{id}/relationships/liabilityTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-categories/{id}/relationships/liabilityTypes
Where id is the identifier of the liability category
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
LiabilityTypes
Gets liabilityCategories via a single related liability type
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types/{id}/liabilityCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}/liabilityCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types/{id}/liabilityCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types/{id}/liabilityCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types/{id}/liabilityCategory
Where id is the identifier of the liability type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityCategoriesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/liability-types/{id}/relationships/liabilitySubTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}/relationships/liabilitySubTypes',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/liability-types/{id}/relationships/liabilitySubTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/liability-types/{id}/relationships/liabilitySubTypes',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/liability-types/{id}/relationships/liabilitySubTypes
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of liability types
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single liability type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types/{id}
Where id is the identifier of the liability type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilityTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a liabilityCategories related to a single liability type
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types/{id}/relationships/liabilityCategory \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}/relationships/liabilityCategory',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types/{id}/relationships/liabilityCategory', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types/{id}/relationships/liabilityCategory',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types/{id}/relationships/liabilityCategory
Where id is the identifier of the liability type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsSingleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets liabilitySubTypes via a single related liability type
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types/{id}/liabilitySubTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}/liabilitySubTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types/{id}/liabilitySubTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types/{id}/liabilitySubTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types/{id}/liabilitySubTypes
Where id is the identifier of the liability type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | LiabilitySubTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a liabilitySubTypes related to a single liability type
Code samples
# You can also use wget
curl -X GET /jsonapi/liability-types/{id}/relationships/liabilitySubTypes \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/liability-types/{id}/relationships/liabilitySubTypes',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/liability-types/{id}/relationships/liabilitySubTypes', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/liability-types/{id}/relationships/liabilitySubTypes',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/liability-types/{id}/relationships/liabilitySubTypes
Where id is the identifier of the liability type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Organisations
Gets addresses via a single related organisation
Code samples
# You can also use wget
curl -X GET /jsonapi/organisations/{id}/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/organisations/{id}/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/organisations/{id}/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/organisations/{id}/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/organisations/{id}/addresses
Where id is the identifier of the organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isCustomAddress": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OrganisationAddressesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/organisations/{id}/relationships/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/organisations/{id}/relationships/addresses',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/organisations/{id}/relationships/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/organisations/{id}/relationships/addresses',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/organisations/{id}/relationships/addresses
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a collection of organisations
Code samples
# You can also use wget
curl -X GET /jsonapi/organisations \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/organisations',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/organisations', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/organisations',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/organisations
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OrganisationsDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single organisation by id
Code samples
# You can also use wget
curl -X GET /jsonapi/organisations/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/organisations/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/organisations/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/organisations/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/organisations/{id}
Where id is the identifier of the organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | OrganisationDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a addresses related to a single organisation
Code samples
# You can also use wget
curl -X GET /jsonapi/organisations/{id}/relationships/addresses \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/organisations/{id}/relationships/addresses',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/organisations/{id}/relationships/addresses', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/organisations/{id}/relationships/addresses',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/organisations/{id}/relationships/addresses
Where id is the identifier of the organisation
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | RelationshipsMultipleDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
PropertyTypes
Gets a collection of property types
Code samples
# You can also use wget
curl -X GET /jsonapi/property-types \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/property-types',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/property-types', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/property-types',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/property-types
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PropertyTypesDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/property-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/property-types/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/property-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/property-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/property-types/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single property type by id
Code samples
# You can also use wget
curl -X GET /jsonapi/property-types/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/property-types/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/property-types/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/property-types/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/property-types/{id}
Where id is the identifier of the property type
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | PropertyTypeDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Referrers
Gets a collection of referrers
Code samples
# You can also use wget
curl -X GET /jsonapi/referrers \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/referrers',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/referrers', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/referrers',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/referrers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| filter | query | array[string] | false | none |
| sort | query | array[string] | false | none |
| page | query | Pagination | false | none |
| include | query | array[string] | false | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrganisationName": "string",
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ReferrersDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Retrieve headers related to the associated GET request
Code samples
# You can also use wget
curl -X HEAD /jsonapi/referrers/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/referrers/{id}',
{
method: 'HEAD',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.head('/jsonapi/referrers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.head '/jsonapi/referrers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
HEAD /jsonapi/referrers/{id}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
default Response
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | None |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Gets a single referrer by id
Code samples
# You can also use wget
curl -X GET /jsonapi/referrers/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/referrers/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/referrers/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/referrers/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/referrers/{id}
Where id is the identifier of the referrer
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"referrerOrganisationName": "string",
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | ReferrerDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
StructuredLeads
Creates a structured lead, including contact and deal attributes
Code samples
# You can also use wget
curl -X POST /jsonapi/structured-leads \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json'
const inputBody = '{
"data": {
"type": "string",
"attributes": {
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true
},
"relationships": {},
"id": "string"
}
}';
const headers = {
'Content-Type':'application/vnd.api+json',
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/structured-leads',
{
method: 'POST',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Content-Type': 'application/vnd.api+json',
'Accept': 'application/vnd.api+json'
}
r = requests.post('/jsonapi/structured-leads', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Content-Type' => 'application/vnd.api+json',
'Accept' => 'application/vnd.api+json'
}
result = RestClient.post '/jsonapi/structured-leads',
params: {
}, headers: headers
p JSON.parse(result)
POST /jsonapi/structured-leads
Body parameter
{
"data": {
"type": "string",
"attributes": {
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true
},
"relationships": {},
"id": "string"
}
}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| body | body | StructuredLeadDocument | false | none |
Example responses
201 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | none | StructuredLeadDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Response Headers
| Status | Header | Type | Format | Description |
|---|---|---|---|---|
| 201 | Location | string | Location of newly created resource |
Gets select details of an existing lead
Code samples
# You can also use wget
curl -X GET /jsonapi/structured-leads/{id} \
-H 'Accept: application/vnd.api+json'
const headers = {
'Accept':'application/vnd.api+json'
};
fetch('/jsonapi/structured-leads/{id}',
{
method: 'GET',
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
import requests
headers = {
'Accept': 'application/vnd.api+json'
}
r = requests.get('/jsonapi/structured-leads/{id}', headers = headers)
print(r.json())
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/vnd.api+json'
}
result = RestClient.get '/jsonapi/structured-leads/{id}',
params: {
}, headers: headers
p JSON.parse(result)
GET /jsonapi/structured-leads/{id}
Where id is the identifier of the lead
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | integer(int32) | true | none |
Example responses
200 Response
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | none | StructuredLeadDocument |
| 401 | Unauthorized | Unauthorized | None |
| default | Default | Errors - common HTTP status codes will include 400, 403, 404 etc. | ErrorDocument |
Schemas
Address
{
"id": "string",
"postCode": "string",
"suburb": "string",
"streetAddress": "string",
"country": "string",
"formattedAddress": "string",
"addressDetails": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| postCode | string¦null | false | read-only | none |
| suburb | string¦null | false | read-only | none |
| streetAddress | string¦null | false | read-only | none |
| country | string¦null | false | read-only | none |
| formattedAddress | string¦null | false | read-only | none |
| addressDetails | [ContactAddress]¦null | false | none | none |
| state | string¦null | false | read-only | none |
AddressType
"CurrentAddress"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | CurrentAddress |
| anonymous | PostalAddress |
| anonymous | PostSettlementAddress |
| anonymous | PreviousAddress |
| anonymous | Other |
Adviser
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AdvisersEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AdviserAttributes | false | none | none |
| relationships | AdviserRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AdviserAddress
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isBusiness": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AdviserAddressEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AdviserAddressAttributes | false | none | none |
| relationships | AdviserAddressRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AdviserAddressAttributes
{
"isMailing": true,
"isBusiness": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isMailing | boolean¦null | false | read-only | none |
| isBusiness | boolean¦null | false | read-only | none |
| formattedAddress | string¦null | false | read-only | none |
| streetAddress | string¦null | false | read-only | none |
| country | string¦null | false | read-only | none |
| suburb | string¦null | false | read-only | none |
| postCode | string¦null | false | read-only | none |
| state | string¦null | false | read-only | none |
AdviserAddressDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isBusiness": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AdviserAddress | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdviserAddressEntityType
"adviser-address"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | adviser-address |
AdviserAddressRelationships
{
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adviser | RelationshipsSingleDocument | false | none | none |
AdviserAddressesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isBusiness": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AdviserAddress] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdviserAttributes
{
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| googlePlaces | string¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| isBrokerWebPublic | boolean | false | read-only | none |
| myLeadGenActivationDate | string(date-time)¦null | false | read-only | none |
| isMyLeadGenActive | boolean¦null | false | read-only | none |
| bio | string¦null | false | read-only | none |
| jobTitle | string¦null | false | read-only | none |
| website | string¦null | false | read-only | none |
| status | string¦null | false | read-only | none |
| string¦null | false | read-only | none | |
| skype | string¦null | false | read-only | none |
| string¦null | false | read-only | none | |
| string¦null | false | read-only | none | |
| string¦null | false | read-only | none | |
| youtubeFeatured | string¦null | false | read-only | none |
| string¦null | false | read-only | none | |
| calendly | string¦null | false | read-only | none |
| myLeadGenerator | string¦null | false | read-only | none |
| profilePhotoHeadShot | string(uri)¦null | false | read-only | none |
| profilePhotoHalfBody | string(uri)¦null | false | read-only | none |
| profilePhotoFullBody | string(uri)¦null | false | read-only | none |
| countryCode | CountryCode | false | read-only | none |
| youtubeChannel | string¦null | false | read-only | none |
AdviserDetail
{
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AdviserDetailsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AdviserDetailAttributes | false | none | none |
| relationships | AdviserDetailRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AdviserDetailAttributes
{
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| gender | GenderCode | false | none | none |
| placeOfBirth | string¦null | false | none | none |
| title | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| preferredName | string¦null | false | none | none |
| homePhone | string¦null | false | none | none |
| businessPhone | string¦null | false | none | none |
| mobilePhone | string¦null | false | none | none |
| string¦null | false | none | none | |
| birthCountry | string¦null | false | none | none |
| fax | string¦null | false | none | none |
| workEmail | string¦null | false | none | none |
| dateOfBirth | string(date)¦null | false | none | none |
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| description | string¦null | false | none | none |
AdviserDetailDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AdviserDetail | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdviserDetailRelationships
{
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adviser | RelationshipsSingleDocument | false | none | none |
AdviserDetailsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"gender": "Male",
"placeOfBirth": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"mobilePhone": "string",
"email": "string",
"birthCountry": "string",
"fax": "string",
"workEmail": "string",
"dateOfBirth": "2019-08-24",
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string"
},
"relationships": {
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AdviserDetail] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdviserDetailsEntityType
"adviser-details"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | adviser-details |
AdviserDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Adviser | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdviserRelationships
{
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| adviserDetails | RelationshipsSingleDocument | false | none | none |
| organisation | RelationshipsSingleDocument | false | none | none |
| agreementHolders | RelationshipsMultipleDocument | false | none | none |
| familyFranchisees | RelationshipsMultipleDocument | false | none | none |
| addresses | RelationshipsMultipleDocument | false | write-only | none |
| contactGroups | RelationshipsMultipleDocument | false | none | none |
AdvisersDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Adviser] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AdvisersEntityType
"advisers"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | advisers |
AgreementHolder
{
"type": "string",
"id": "string",
"attributes": {
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
},
"relationships": {
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AgreementHoldersEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AgreementHolderAttributes | false | none | none |
| relationships | AgreementHolderRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AgreementHolderAttributes
{
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| appointmentEntity | string¦null | false | read-only | none |
| employmentType | string¦null | false | read-only | none |
| entityType | string¦null | false | read-only | none |
AgreementHolderDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
},
"relationships": {
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AgreementHolder | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AgreementHolderRelationships
{
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| apiFamilyFranchisees | RelationshipsMultipleDocument | false | none | none |
| organisation | RelationshipsSingleDocument | false | write-only | none |
AgreementHoldersDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
},
"relationships": {
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AgreementHolder] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AgreementHoldersEntityType
"agreement-holders"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | agreement-holders |
ApiAdviserProfile
{
"id": "string",
"jobTitle": "string",
"bio": "string",
"adviser": {
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| jobTitle | string¦null | false | read-only | none |
| bio | string¦null | false | read-only | none |
| adviser | Adviser | false | none | none |
ApiClientEntityEmployment
{
"id": "string",
"business": {
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"address": {
"id": "string",
"postCode": "string",
"suburb": "string",
"streetAddress": "string",
"country": "string",
"formattedAddress": "string",
"addressDetails": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"state": "string"
},
"contact": {
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactAddress": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| business | Business | false | none | none |
| address | Address | false | none | none |
| contact | Contact | false | none | none |
ApiFamilyFranchisee
{
"id": "string",
"franchiseeDetails": {
"type": "string",
"id": "string",
"attributes": {
"appointmentEntity": "string",
"employmentType": "string",
"entityType": "string"
},
"relationships": {
"apiFamilyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"family": {
"type": "string",
"id": "string",
"attributes": {
"googlePlaces": "string",
"created": "2019-08-24T14:15:22Z",
"isBrokerWebPublic": true,
"myLeadGenActivationDate": "2019-08-24T14:15:22Z",
"isMyLeadGenActive": true,
"bio": "string",
"jobTitle": "string",
"website": "string",
"status": "string",
"email": "string",
"skype": "string",
"facebook": "string",
"linkedIn": "string",
"twitter": "string",
"youtubeFeatured": "string",
"instagram": "string",
"calendly": "string",
"myLeadGenerator": "string",
"profilePhotoHeadShot": "http://example.com",
"profilePhotoHalfBody": "http://example.com",
"profilePhotoFullBody": "http://example.com",
"countryCode": "NZ",
"youtubeChannel": "string"
},
"relationships": {
"adviserDetails": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"organisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"agreementHolders": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"familyFranchisees": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| franchiseeDetails | AgreementHolder | false | none | none |
| family | Adviser | false | none | none |
ApiFamilySocialMedia
{
"id": "string",
"linkedInUrl": "string",
"facebookUrl": "string",
"googleMyBusinessUrl": "string",
"youtubeUrl": "string",
"twitterUrl": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| linkedInUrl | string¦null | false | read-only | none |
| facebookUrl | string¦null | false | read-only | none |
| googleMyBusinessUrl | string¦null | false | read-only | none |
| youtubeUrl | string¦null | false | read-only | none |
| twitterUrl | string¦null | false | read-only | none |
ApiLoanSecurity
{
"id": "string",
"loanSecurityInfo": [
{
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"address": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string | true | read-only | none |
| loanSecurityInfo | [DealSecurity]¦null | false | none | none |
Asset
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AssetsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AssetAttributes | false | none | none |
| relationships | AssetRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AssetAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| description | string¦null | false | read-only | none |
| value | number(double)¦null | false | read-only | none |
| accountName | string¦null | false | read-only | none |
| accountNumber | string¦null | false | read-only | none |
| bsb | string¦null | false | read-only | none |
| vehicleMake | string¦null | false | read-only | none |
| vehicleYear | integer(int32)¦null | false | read-only | none |
| propertyType | string¦null | false | read-only | none |
| isRentalIncome | boolean¦null | false | read-only | none |
| isExistingMortgages | boolean¦null | false | read-only | none |
| assetTypeId | integer(int32)¦null | false | read-only | none |
| isAccountDetailsKnown | boolean¦null | false | read-only | none |
| institution | string¦null | false | read-only | none |
| assetSubType | string¦null | false | read-only | none |
| assetSubTypeId | integer(int32)¦null | false | read-only | none |
| assetType | string¦null | false | read-only | none |
| assetCategory | string¦null | false | read-only | none |
| currencyCode | string¦null | false | read-only | none |
| valuationBasis | string¦null | false | read-only | none |
| propertyZoningType | string¦null | false | read-only | none |
| addressPropertyType | string¦null | false | read-only | none |
| assetCategoryId | integer(int32)¦null | false | read-only | none |
AssetCategoriesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AssetCategory] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetCategoriesEntityType
"asset-categories"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | asset-categories |
AssetCategory
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AssetCategoriesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AssetCategoryAttributes | false | none | none |
| relationships | AssetCategoryRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AssetCategoryAttributes
{
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | read-only | none |
AssetCategoryDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AssetCategory | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetCategoryRelationships
{}
Properties
None
AssetDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Asset | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetRelationships
{
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ownership | RelationshipsMultipleDocument | false | none | none |
| addresses | RelationshipsMultipleDocument | false | none | none |
AssetSubType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AssetSubTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AssetSubTypeAttributes | false | none | none |
| relationships | AssetSubTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AssetSubTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
AssetSubTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AssetSubType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetSubTypeRelationships
{}
Properties
None
AssetSubTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AssetSubType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetSubTypesEntityType
"asset-sub-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | asset-sub-types |
AssetType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | AssetTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | AssetTypeAttributes | false | none | none |
| relationships | AssetTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
AssetTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
AssetTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | AssetType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetTypeRelationships
{}
Properties
None
AssetTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [AssetType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetTypesEntityType
"asset-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | asset-types |
AssetsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyType": "string",
"isRentalIncome": true,
"isExistingMortgages": true,
"assetTypeId": 0,
"isAccountDetailsKnown": true,
"institution": "string",
"assetSubType": "string",
"assetSubTypeId": 0,
"assetType": "string",
"assetCategory": "string",
"currencyCode": "string",
"valuationBasis": "string",
"propertyZoningType": "string",
"addressPropertyType": "string",
"assetCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Asset] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
AssetsEntityType
"assets"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | assets |
Business
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | BusinessEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | BusinessAttributes | false | none | none |
| relationships | BusinessRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
BusinessAttributes
{
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string(date-time)¦null | false | read-only | none |
| name | string¦null | false | none | none |
| phone | string¦null | false | none | none |
| string¦null | false | none | none | |
| taxNumber | string¦null | false | none | none |
| companyNumber | string¦null | false | none | none |
| abn | string¦null | false | none | none |
| acn | string¦null | false | none | none |
| notes | string¦null | false | none | none |
| description | string¦null | false | none | none |
| businessType | string¦null | false | read-only | none |
| updated | string(date-time)¦null | false | read-only | none |
BusinessDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Business | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
BusinessEntityType
"business"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | business |
BusinessRelationships
{
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactGroup | RelationshipsSingleDocument | false | none | none |
| ownership | RelationshipsMultipleDocument | false | none | none |
| deals | RelationshipsMultipleDocument | false | none | none |
| employments | RelationshipsMultipleDocument | false | write-only | none |
BusinessesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"name": "string",
"phone": "string",
"email": "string",
"taxNumber": "string",
"companyNumber": "string",
"abn": "string",
"acn": "string",
"notes": "string",
"description": "string",
"businessType": "string",
"updated": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Business] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ClientAddressType
"Current"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Current |
| anonymous | Postal |
| anonymous | PostSettlement |
| anonymous | Previous |
| anonymous | Other |
Contact
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactAddress": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ContactsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ContactAttributes | false | none | none |
| relationships | ContactRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ContactAccessType
"Other"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Other |
| anonymous | LoanParty |
ContactAddress
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ContactAddressEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ContactAddressAttributes | false | none | none |
| relationships | ContactAddressRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ContactAddressAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| addressType | AddressType | false | none | none |
| formattedAddress | string¦null | false | read-only | none |
| streetAddress | string¦null | false | read-only | none |
| country | string¦null | false | read-only | none |
| suburb | string¦null | false | read-only | none |
| postCode | string¦null | false | read-only | none |
| state | string¦null | false | read-only | none |
ContactAddressDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ContactAddress | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactAddressEntityType
"contact-address"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | contact-address |
ContactAddressRelationships
{
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contacts | RelationshipsMultipleDocument | false | write-only | none |
ContactAddressesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"addressType": "CurrentAddress",
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ContactAddress] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactAttributes
{
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| mobile | string¦null | false | none | none |
| title | string¦null | false | none | none |
| firstName | string¦null | false | none | none |
| middleName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| preferredName | string¦null | false | none | none |
| homePhone | string¦null | false | none | none |
| businessPhone | string¦null | false | none | none |
| string¦null | false | none | none | |
| secondaryEmail | string¦null | false | none | none |
| maritalStatus | MaritalStatus | false | none | none |
| gender | GenderCode | false | none | none |
| updated | string(date-time)¦null | false | read-only | none |
| hasMarketingConsent | boolean¦null | false | none | none |
| dateOfBirth | string(date)¦null | false | none | none |
| isPrimary | boolean¦null | false | none | none |
| role | ContactRole | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
ContactDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactAddress": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Contact | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactExternalReference
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ContactExternalReferencesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ContactExternalReferenceAttributes | false | none | none |
| relationships | ContactExternalReferenceRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ContactExternalReferenceAttributes
{
"externalReference": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| externalReference | string | false | none | none |
ContactExternalReferenceDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ContactExternalReference | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactExternalReferenceRelationships
{
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| integration | RelationshipsSingleDocument | false | none | none |
| contact | RelationshipsSingleDocument | false | none | none |
ContactExternalReferencesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ContactExternalReference] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactExternalReferencesEntityType
"contact-external-references"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | contact-external-references |
ContactGroup
{
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrerOrganisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrer": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ContactGroupsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ContactGroupAttributes | false | none | none |
| relationships | ContactGroupRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ContactGroupAttributes
{
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| enquirySourceCategoryId | integer(int32)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| reviewMonth | integer(int32)¦null | false | none | none |
| utmSource | string¦null | false | none | none |
| utmMedium | string¦null | false | none | none |
| utmTerm | string¦null | false | none | none |
| utmContent | string¦null | false | none | none |
| utmCampaign | string¦null | false | none | none |
| categories | [string]¦null | false | read-only | none |
| sourceAdditionalDetails | string¦null | false | none | none |
| enquirySourceSystemUrl | string¦null | false | read-only | none |
| enquirySourceReferrerName | string¦null | false | read-only | none |
| enquirySourceReferrerOrganisationName | string¦null | false | read-only | none |
| contactType | ContactType | false | none | none |
| notes | string¦null | false | none | none |
| updated | string(date-time)¦null | false | read-only | none |
| enquirySourceId | integer(int32)¦null | false | read-only | none |
| enquirySourceCategory | string¦null | false | read-only | none |
| enquirySource | string¦null | false | read-only | none |
| enquirySourceReferrerId | string¦null | false | read-only | none |
ContactGroupDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrerOrganisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrer": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ContactGroup | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactGroupRelationships
{
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrerOrganisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrer": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| businesses | RelationshipsMultipleDocument | false | none | none |
| contacts | RelationshipsMultipleDocument | false | none | none |
| adviser | RelationshipsSingleDocument | false | none | none |
| referrerOrganisation | RelationshipsSingleDocument | false | write-only | none |
| referrer | RelationshipsSingleDocument | false | write-only | none |
ContactGroupsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"enquirySourceCategoryId": 0,
"created": "2019-08-24T14:15:22Z",
"reviewMonth": 0,
"utmSource": "string",
"utmMedium": "string",
"utmTerm": "string",
"utmContent": "string",
"utmCampaign": "string",
"categories": [
"string"
],
"sourceAdditionalDetails": "string",
"enquirySourceSystemUrl": "string",
"enquirySourceReferrerName": "string",
"enquirySourceReferrerOrganisationName": "string",
"contactType": "Lead",
"notes": "string",
"updated": "2019-08-24T14:15:22Z",
"enquirySourceId": 0,
"enquirySourceCategory": "string",
"enquirySource": "string",
"enquirySourceReferrerId": "string"
},
"relationships": {
"businesses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrerOrganisation": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"referrer": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ContactGroup] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactGroupsEntityType
"contact-groups"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | contact-groups |
ContactMarketing
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ContactMarketingEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ContactMarketingAttributes | false | none | none |
| relationships | ContactMarketingRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ContactMarketingAttributes
{
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| hasMarketingConsent | boolean¦null | false | none | none |
ContactMarketingDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ContactMarketing | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactMarketingEntityType
"contact-marketing"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | contact-marketing |
ContactMarketingRelationships
{}
Properties
None
ContactMarketingsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ContactMarketing] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactRelationships
{
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactAddress": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactGroup | RelationshipsSingleDocument | false | none | none |
| ownership | RelationshipsMultipleDocument | false | none | none |
| externalReferences | RelationshipsMultipleDocument | false | none | none |
| deals | RelationshipsMultipleDocument | false | none | none |
| employments | RelationshipsMultipleDocument | false | write-only | none |
| contactAddress | RelationshipsMultipleDocument | false | write-only | none |
ContactRole
"Adult"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Adult |
| anonymous | Child |
| anonymous | Other |
ContactType
"Lead"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Lead |
| anonymous | Application |
| anonymous | ExistingClient |
| anonymous | ProfessionalPartner |
| anonymous | PreviousClient |
| anonymous | Opportunity |
| anonymous | NewClient |
ContactsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"mobile": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"preferredName": "string",
"homePhone": "string",
"businessPhone": "string",
"email": "string",
"secondaryEmail": "string",
"maritalStatus": "Single",
"gender": "Male",
"updated": "2019-08-24T14:15:22Z",
"hasMarketingConsent": true,
"dateOfBirth": "2019-08-24",
"isPrimary": true,
"role": "Adult",
"created": "2019-08-24T14:15:22Z"
},
"relationships": {
"contactGroup": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deals": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"employments": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contactAddress": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Contact] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ContactsEntityType
"contacts"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | contacts |
Coordinate
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"isValid": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| x | number(double) | false | none | none |
| y | number(double) | false | none | none |
| z | number(double) | false | none | none |
| m | number(double) | false | none | none |
| coordinateValue | Coordinate | false | none | none |
| isValid | boolean | false | read-only | none |
CoordinateEqualityComparer
{}
Properties
None
CoordinateSequence
{
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dimension | integer(int32) | false | read-only | none |
| measures | integer(int32) | false | read-only | none |
| spatial | integer(int32) | false | read-only | none |
| ordinates | Ordinates | false | none | none |
| hasZ | boolean | false | read-only | none |
| hasM | boolean | false | read-only | none |
| zOrdinateIndex | integer(int32) | false | read-only | none |
| mOrdinateIndex | integer(int32) | false | read-only | none |
| first | Coordinate | false | none | none |
| last | Coordinate | false | none | none |
| count | integer(int32) | false | read-only | none |
CoordinateSequenceFactory
{
"ordinates": "None"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ordinates | Ordinates | false | none | none |
CountryCode
"NZ"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | NZ |
| anonymous | AU |
| anonymous | ID |
Deal
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealAttributes | false | none | none |
| relationships | DealRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| dates | ImportantDatesSet | false | none | none |
| totalLoanAmount | number(double)¦null | false | read-only | none |
| name | string¦null | false | read-only | none |
| dealStatus | SystemStatus | false | read-only | none |
| opportunity | Opportunity | false | none | none |
| splits | [Split]¦null | false | read-only | none |
| lenderName | string¦null | false | read-only | none |
| customStatusName | string¦null | false | read-only | none |
| dealType | DealType | false | none | none |
DealDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Deal | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealExternalReference
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealExternalReferencesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealExternalReferenceAttributes | false | none | none |
| relationships | DealExternalReferenceRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealExternalReferenceAttributes
{
"externalReference": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| externalReference | string | false | none | none |
DealExternalReferenceDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealExternalReference | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealExternalReferenceRelationships
{
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| integration | RelationshipsSingleDocument | false | none | none |
| deal | RelationshipsSingleDocument | false | none | none |
DealExternalReferencesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"externalReference": "string"
},
"relationships": {
"integration": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealExternalReference] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealExternalReferencesEntityType
"deal-external-references"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-external-references |
DealImportantDate
{
"type": "string",
"id": "string",
"attributes": {
"date": "2019-08-24",
"dateType": "Settled"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealImportantDatesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealImportantDateAttributes | false | none | none |
| relationships | DealImportantDateRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealImportantDateAttributes
{
"date": "2019-08-24",
"dateType": "Settled"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| date | string(date)¦null | false | read-only | none |
| dateType | ImportantDate | false | read-only | none |
DealImportantDateDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"date": "2019-08-24",
"dateType": "Settled"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealImportantDate | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealImportantDateRelationships
{
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deal | RelationshipsSingleDocument | false | none | none |
DealImportantDatesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"date": "2019-08-24",
"dateType": "Settled"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealImportantDate] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealImportantDatesEntityType
"deal-important-dates"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-important-dates |
DealNote
{
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealNotesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealNoteAttributes | false | none | none |
| relationships | DealNoteRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealNoteAttributes
{
"writtenBy": "string",
"title": "string",
"detail": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| writtenBy | string¦null | false | read-only | none |
| title | string¦null | false | none | none |
| detail | string¦null | false | none | none |
DealNoteDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealNote | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealNoteRelationships
{
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| deal | RelationshipsSingleDocument | false | none | none |
DealNotesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"writtenBy": "string",
"title": "string",
"detail": "string"
},
"relationships": {
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealNote] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealNotesEntityType
"deal-notes"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-notes |
DealParticipant
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealParticipantsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealParticipantAttributes | false | none | none |
| relationships | DealParticipantRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealParticipantAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| isApplicant | boolean¦null | false | read-only | none |
| isDependent | boolean¦null | false | read-only | none |
| isGuarantor | boolean¦null | false | read-only | none |
DealParticipantDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealParticipant | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealParticipantRelationships
{
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contact | RelationshipsSingleDocument | false | none | none |
| deal | RelationshipsSingleDocument | false | none | none |
DealParticipantsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"isApplicant": true,
"isDependent": true,
"isGuarantor": true
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealParticipant] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealParticipantsEntityType
"deal-participants"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-participants |
DealRelationships
{
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealScenario | RelationshipsSingleDocument | false | none | none |
| importantDates | RelationshipsMultipleDocument | false | none | none |
| participants | RelationshipsMultipleDocument | false | none | none |
| externalReferences | RelationshipsMultipleDocument | false | none | none |
| dealStructures | RelationshipsMultipleDocument | false | none | none |
| contacts | RelationshipsMultipleDocument | false | write-only | none |
| adviser | RelationshipsSingleDocument | false | none | none |
| dealNotes | RelationshipsMultipleDocument | false | none | none |
| loanSecurities | RelationshipsMultipleDocument | false | none | none |
DealScenario
{
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"highLevelSummary": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealScenarioEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealScenarioAttributes | false | none | none |
| relationships | DealScenarioRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealScenarioAttributes
{}
Properties
None
DealScenarioDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"highLevelSummary": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealScenario | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealScenarioEntityType
"deal-scenario"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-scenario |
DealScenarioRelationships
{
"highLevelSummary": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| highLevelSummary | RelationshipsSingleDocument | false | write-only | none |
| deal | RelationshipsSingleDocument | false | none | none |
DealScenariosDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"highLevelSummary": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealScenario] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecuritiesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"address": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealSecurity] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecuritiesEntityType
"deal-securities"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-securities |
DealSecurity
{
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"address": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealSecuritiesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealSecurityAttributes | false | none | none |
| relationships | DealSecurityRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealSecurityAttributes
{
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactForAccess | ContactAccessType | false | read-only | none |
| isPreApproval | boolean¦null | false | none | none |
| contractPrice | number(double)¦null | false | none | none |
| landValue | number(double)¦null | false | none | none |
| currentValue | number(double)¦null | false | none | none |
| contractDate | string(date)¦null | false | none | none |
| licensedRealEstateAgentContract | boolean¦null | false | none | none |
| propertyState | string¦null | false | none | none |
| isElectronicTransfer | boolean¦null | false | read-only | none |
| titleType | string¦null | false | read-only | none |
| title | string¦null | false | read-only | none |
| valuationBasis | string¦null | false | read-only | none |
| propertyType | string¦null | false | read-only | none |
| propertyZoning | string¦null | false | read-only | none |
| propertyHolding | string¦null | false | read-only | none |
| propertyPrimaryPurpose | string¦null | false | read-only | none |
| futureValue | number(double)¦null | false | none | none |
| buildAmount | number(double)¦null | false | none | none |
| propertyStatus | string¦null | false | read-only | none |
| constructionType | string¦null | false | read-only | none |
| constructionCategory | string¦null | false | read-only | none |
| propertyTransaction | string¦null | false | read-only | none |
| securityType | string¦null | false | read-only | none |
| propertySuburb | string¦null | false | none | none |
| accessFaxNumber | string¦null | false | none | none |
| accessFaxAreaCode | string¦null | false | none | none |
| accessMobileNumber | string¦null | false | none | none |
| accessMobileAreaCode | string¦null | false | none | none |
| accessPhoneNumber | string¦null | false | none | none |
| accessPhoneAreaCode | string¦null | false | none | none |
| accessContactLastName | string¦null | false | none | none |
| isAnnualPropertyTax | boolean¦null | false | read-only | none |
| accessContactFirstName | string¦null | false | none | none |
| accessContactTitle | string¦null | false | none | none |
DealSecurityDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"contactForAccess": "Other",
"isPreApproval": true,
"contractPrice": 0.1,
"landValue": 0.1,
"currentValue": 0.1,
"contractDate": "2019-08-24",
"licensedRealEstateAgentContract": true,
"propertyState": "string",
"isElectronicTransfer": true,
"titleType": "string",
"title": "string",
"valuationBasis": "string",
"propertyType": "string",
"propertyZoning": "string",
"propertyHolding": "string",
"propertyPrimaryPurpose": "string",
"futureValue": 0.1,
"buildAmount": 0.1,
"propertyStatus": "string",
"constructionType": "string",
"constructionCategory": "string",
"propertyTransaction": "string",
"securityType": "string",
"propertySuburb": "string",
"accessFaxNumber": "string",
"accessFaxAreaCode": "string",
"accessMobileNumber": "string",
"accessMobileAreaCode": "string",
"accessPhoneNumber": "string",
"accessPhoneAreaCode": "string",
"accessContactLastName": "string",
"isAnnualPropertyTax": true,
"accessContactFirstName": "string",
"accessContactTitle": "string"
},
"relationships": {
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"address": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealSecurity | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecurityOwnership
{
"type": "string",
"id": "string",
"attributes": {
"ownershipPercentage": 0.1
},
"relationships": {
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealSecurityOwnershipEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealSecurityOwnershipAttributes | false | none | none |
| relationships | DealSecurityOwnershipRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealSecurityOwnershipAttributes
{
"ownershipPercentage": 0.1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ownershipPercentage | number(double)¦null | false | read-only | none |
DealSecurityOwnershipDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"ownershipPercentage": 0.1
},
"relationships": {
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealSecurityOwnership | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecurityOwnershipEntityType
"deal-security-ownership"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-security-ownership |
DealSecurityOwnershipRelationships
{
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| business | RelationshipsSingleDocument | false | none | none |
| contact | RelationshipsSingleDocument | false | none | none |
DealSecurityOwnershipsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"ownershipPercentage": 0.1
},
"relationships": {
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealSecurityOwnership] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecurityRelationships
{
"titleIdentifications": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"address": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| titleIdentifications | RelationshipsMultipleDocument | false | none | none |
| address | RelationshipsSingleDocument | false | write-only | none |
| asset | RelationshipsSingleDocument | false | write-only | none |
| ownership | RelationshipsMultipleDocument | false | none | none |
DealSecurityTitleIdentitiesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"titleIdentificationType": "string",
"value": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealSecurityTitleIdentity] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecurityTitleIdentity
{
"type": "string",
"id": "string",
"attributes": {
"titleIdentificationType": "string",
"value": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealSecurityTitleIdentityEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealSecurityTitleIdentityAttributes | false | none | none |
| relationships | DealSecurityTitleIdentityRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealSecurityTitleIdentityAttributes
{
"titleIdentificationType": "string",
"value": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| titleIdentificationType | string¦null | false | read-only | none |
| value | string¦null | false | none | none |
DealSecurityTitleIdentityDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"titleIdentificationType": "string",
"value": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealSecurityTitleIdentity | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealSecurityTitleIdentityEntityType
"deal-security-title-identity"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-security-title-identity |
DealSecurityTitleIdentityRelationships
{}
Properties
None
DealStructure
{
"type": "string",
"id": "string",
"attributes": {
"fixedRateBeginDate": "2019-08-24",
"rateTypePeriodMonths": 0,
"loanStructureType": "PrincipalInterest",
"interestRate": 0.1,
"amount": 0.1,
"rateType": "string",
"paymentAmount": 0.1,
"interestOnlyExpiryDate": "2019-08-24",
"loanTermYears": 0.1,
"fixedRateExpiryDate": "2019-08-24"
},
"relationships": {
"dealImportantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealStructuresEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealStructureAttributes | false | none | none |
| relationships | DealStructureRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealStructureAttributes
{
"fixedRateBeginDate": "2019-08-24",
"rateTypePeriodMonths": 0,
"loanStructureType": "PrincipalInterest",
"interestRate": 0.1,
"amount": 0.1,
"rateType": "string",
"paymentAmount": 0.1,
"interestOnlyExpiryDate": "2019-08-24",
"loanTermYears": 0.1,
"fixedRateExpiryDate": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| fixedRateBeginDate | string(date)¦null | false | read-only | none |
| rateTypePeriodMonths | integer(int32)¦null | false | read-only | none |
| loanStructureType | LoanStructureType | false | none | none |
| interestRate | number(double)¦null | false | read-only | none |
| amount | number(double)¦null | false | read-only | none |
| rateType | string¦null | false | read-only | none |
| paymentAmount | number(double)¦null | false | read-only | none |
| interestOnlyExpiryDate | string(date)¦null | false | read-only | none |
| loanTermYears | number(double)¦null | false | read-only | none |
| fixedRateExpiryDate | string(date)¦null | false | read-only | none |
DealStructureDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"fixedRateBeginDate": "2019-08-24",
"rateTypePeriodMonths": 0,
"loanStructureType": "PrincipalInterest",
"interestRate": 0.1,
"amount": 0.1,
"rateType": "string",
"paymentAmount": 0.1,
"interestOnlyExpiryDate": "2019-08-24",
"loanTermYears": 0.1,
"fixedRateExpiryDate": "2019-08-24"
},
"relationships": {
"dealImportantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealStructure | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealStructureImportantDate
{
"type": "string",
"id": "string",
"attributes": {
"startDate": "2019-08-24",
"dateType": "InterestOnly",
"finishDate": "2019-08-24"
},
"relationships": {
"dealStructure": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | DealStructureImportantDatesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | DealStructureImportantDateAttributes | false | none | none |
| relationships | DealStructureImportantDateRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
DealStructureImportantDateAttributes
{
"startDate": "2019-08-24",
"dateType": "InterestOnly",
"finishDate": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| startDate | string(date)¦null | false | read-only | none |
| dateType | LoanStructureImportantDateTypes | false | read-only | none |
| finishDate | string(date)¦null | false | read-only | none |
DealStructureImportantDateDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"startDate": "2019-08-24",
"dateType": "InterestOnly",
"finishDate": "2019-08-24"
},
"relationships": {
"dealStructure": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | DealStructureImportantDate | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealStructureImportantDateRelationships
{
"dealStructure": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealStructure | RelationshipsSingleDocument | false | write-only | none |
DealStructureImportantDatesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"startDate": "2019-08-24",
"dateType": "InterestOnly",
"finishDate": "2019-08-24"
},
"relationships": {
"dealStructure": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealStructureImportantDate] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealStructureImportantDatesEntityType
"deal-structure-important-dates"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-structure-important-dates |
DealStructureRelationships
{
"dealImportantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealImportantDates | RelationshipsMultipleDocument | false | none | none |
| deal | RelationshipsSingleDocument | false | write-only | none |
DealStructuresDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"fixedRateBeginDate": "2019-08-24",
"rateTypePeriodMonths": 0,
"loanStructureType": "PrincipalInterest",
"interestRate": 0.1,
"amount": 0.1,
"rateType": "string",
"paymentAmount": 0.1,
"interestOnlyExpiryDate": "2019-08-24",
"loanTermYears": 0.1,
"fixedRateExpiryDate": "2019-08-24"
},
"relationships": {
"dealImportantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"deal": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [DealStructure] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealStructuresEntityType
"deal-structures"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deal-structures |
DealType
"Residential"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Residential |
| anonymous | Commercial |
| anonymous | SmallBusiness |
| anonymous | AssetFinance |
| anonymous | PersonalLoan |
| anonymous | DepositBond |
DealsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"dates": {
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
},
"totalLoanAmount": 0.1,
"name": "string",
"dealStatus": "NewLeads",
"opportunity": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
},
"splits": [
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
],
"lenderName": "string",
"customStatusName": "string",
"dealType": "Residential"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"importantDates": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"participants": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"externalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealStructures": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"contacts": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"adviser": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"dealNotes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"loanSecurities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Deal] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
DealsEntityType
"deals"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | deals |
Dimension
"Point"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Point |
| anonymous | Curve |
| anonymous | Surface |
| anonymous | Collapse |
| anonymous | Dontcare |
| anonymous | True |
| anonymous | False |
EmployerType
"Private"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Private |
| anonymous | Public |
EmploymentBasis
"FullTime"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | FullTime |
| anonymous | PartTime |
| anonymous | Contract |
| anonymous | Temporary |
| anonymous | Casual |
EmploymentStatus
"PrimaryEmployment"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PrimaryEmployment |
| anonymous | SecondaryEmployment |
| anonymous | PreviousEmployment |
EmploymentType
"PAYG"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PAYG |
| anonymous | SelfEmployed |
| anonymous | Unemployed |
| anonymous | Retired |
| anonymous | HomeDuties |
| anonymous | Student |
EnquirySource
{
"type": "string",
"id": "string",
"attributes": {
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | EnquirySourceEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | EnquirySourceAttributes | false | none | none |
| relationships | EnquirySourceRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
EnquirySourceAttributes
{
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| sourceCategoryId | integer(int32) | false | read-only | none |
| sourceCategoryName | string¦null | false | read-only | none |
| sourceId | integer(int32) | false | read-only | none |
| sourceName | string¦null | false | read-only | none |
EnquirySourceDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | EnquirySource | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
EnquirySourceEntityType
"enquiry-source"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | enquiry-source |
EnquirySourceRelationships
{}
Properties
None
EnquirySourcesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"sourceCategoryId": 0,
"sourceCategoryName": "string",
"sourceId": 0,
"sourceName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [EnquirySource] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
Envelope
{
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isNull | boolean | false | read-only | none |
| width | number(double) | false | read-only | none |
| height | number(double) | false | read-only | none |
| diameter | number(double) | false | read-only | none |
| minX | number(double) | false | read-only | none |
| maxX | number(double) | false | read-only | none |
| minY | number(double) | false | read-only | none |
| maxY | number(double) | false | read-only | none |
| area | number(double) | false | read-only | none |
| minExtent | number(double) | false | read-only | none |
| maxExtent | number(double) | false | read-only | none |
| centre | Coordinate | false | none | none |
ErrorDocument
{
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"errors": [
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| links | TopLevelLinks | false | none | none |
| errors | [ErrorObject]¦null | false | none | none |
ErrorLinks
{
"about": "string",
"type": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| about | string¦null | false | none | none |
| type | string¦null | false | none | none |
ErrorObject
{
"id": "string",
"links": {
"about": "string",
"type": "string"
},
"status": "string",
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string",
"header": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| links | ErrorLinks | false | none | none |
| status | string¦null | false | none | none |
| code | string¦null | false | none | none |
| title | string¦null | false | none | none |
| detail | string¦null | false | none | none |
| source | ErrorSource | false | none | none |
| meta | object¦null | false | none | none |
| » additionalProperties | any | false | none | none |
ErrorSource
{
"pointer": "string",
"parameter": "string",
"header": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| pointer | string¦null | false | none | none |
| parameter | string¦null | false | none | none |
| header | string¦null | false | none | none |
ExistingContactCheck
"Email"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | |
| anonymous | EmailMobile |
| anonymous | EmailName |
| anonymous | EmailMobileName |
| anonymous | EmailDateOfBirth |
| anonymous | EmailDateOfBirthName |
Expense
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ExpensesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ExpenseAttributes | false | none | none |
| relationships | ExpenseRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ExpenseAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| description | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| expenseTypeId | integer(int32)¦null | false | read-only | none |
| frequency | string¦null | false | read-only | none |
| expenseCategory | string¦null | false | read-only | none |
| expenseType | string¦null | false | read-only | none |
| expenseCategoryId | integer(int32)¦null | false | read-only | none |
ExpenseCategoriesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"expenseTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ExpenseCategory] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpenseCategoriesEntityType
"expense-categories"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | expense-categories |
ExpenseCategory
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"expenseTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ExpenseCategoriesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ExpenseCategoryAttributes | false | none | none |
| relationships | ExpenseCategoryRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ExpenseCategoryAttributes
{
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | read-only | none |
ExpenseCategoryDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"expenseTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ExpenseCategory | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpenseCategoryRelationships
{
"expenseTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| expenseTypes | RelationshipsMultipleDocument | false | write-only | none |
ExpenseDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Expense | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpenseRelationships
{
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| ownership | RelationshipsMultipleDocument | false | none | none |
ExpenseType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"expenseCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ExpenseTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ExpenseTypeAttributes | false | none | none |
| relationships | ExpenseTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ExpenseTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
ExpenseTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"expenseCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ExpenseType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpenseTypeRelationships
{
"expenseCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| expenseCategory | RelationshipsSingleDocument | false | write-only | none |
ExpenseTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"expenseCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ExpenseType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpenseTypesEntityType
"expense-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | expense-types |
ExpensesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"expenseTypeId": 0,
"frequency": "string",
"expenseCategory": "string",
"expenseType": "string",
"expenseCategoryId": 0
},
"relationships": {
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Expense] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ExpensesEntityType
"expenses"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | expenses |
Financial
{
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"expenses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"clients": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"incomes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"liabilities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"assets": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | FinancialsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | FinancialAttributes | false | none | none |
| relationships | FinancialRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
FinancialAddress
{
"type": "string",
"id": "string",
"attributes": {
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | FinancialAddressEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | FinancialAddressAttributes | false | none | none |
| relationships | FinancialAddressRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
FinancialAddressAttributes
{
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| formattedAddress | string¦null | false | read-only | none |
| streetAddress | string¦null | false | read-only | none |
| country | string¦null | false | read-only | none |
| suburb | string¦null | false | read-only | none |
| postCode | string¦null | false | read-only | none |
| state | string¦null | false | read-only | none |
FinancialAddressDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | FinancialAddress | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
FinancialAddressEntityType
"financial-address"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | financial-address |
FinancialAddressRelationships
{}
Properties
None
FinancialAddressesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [FinancialAddress] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
FinancialAttributes
{}
Properties
None
FinancialDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"expenses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"clients": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"incomes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"liabilities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"assets": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Financial | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
FinancialRelationships
{
"expenses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"clients": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"incomes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"liabilities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"assets": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| expenses | RelationshipsMultipleDocument | false | none | none |
| addresses | RelationshipsMultipleDocument | false | none | none |
| clients | RelationshipsMultipleDocument | false | none | none |
| incomes | RelationshipsMultipleDocument | false | none | none |
| liabilities | RelationshipsMultipleDocument | false | none | none |
| assets | RelationshipsMultipleDocument | false | none | none |
FinancialsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {},
"relationships": {
"expenses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"clients": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"incomes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"liabilities": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"assets": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Financial] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
FinancialsEntityType
"financials"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | financials |
Frequency
"Yearly"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Yearly |
| anonymous | HalfYearly |
| anonymous | Quarterly |
| anonymous | Monthly |
| anonymous | Fortnightly |
| anonymous | Weekly |
| anonymous | HalfMonthly |
Gender
"Male"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Male |
| anonymous | Female |
| anonymous | Undisclosed |
GenderCode
"Male"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Male |
| anonymous | Female |
| anonymous | Undisclosed |
Geometry
{
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"dimension": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"boundaryDimension": "Point",
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| factory | GeometryFactory | false | none | none |
| userData | any | false | none | none |
| srid | integer(int32) | false | none | none |
| geometryType | string¦null | false | read-only | none |
| ogcGeometryType | OgcGeometryType | false | none | none |
| precisionModel | PrecisionModel | false | none | none |
| coordinate | Coordinate | false | none | none |
| coordinates | [Coordinate]¦null | false | read-only | none |
| numPoints | integer(int32) | false | read-only | none |
| numGeometries | integer(int32) | false | read-only | none |
| isSimple | boolean | false | read-only | none |
| isValid | boolean | false | read-only | none |
| isEmpty | boolean | false | read-only | none |
| area | number(double) | false | read-only | none |
| length | number(double) | false | read-only | none |
| centroid | Point | false | none | none |
| interiorPoint | Point | false | none | none |
| pointOnSurface | Point | false | none | none |
| dimension | Dimension | false | none | none |
| boundary | Geometry | false | none | none |
| boundaryDimension | Dimension | false | none | none |
| envelope | Geometry | false | none | none |
| envelopeInternal | Envelope | false | none | none |
| isRectangle | boolean | false | read-only | none |
GeometryFactory
{
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| precisionModel | PrecisionModel | false | none | none |
| coordinateSequenceFactory | CoordinateSequenceFactory | false | none | none |
| srid | integer(int32) | false | read-only | none |
| geometryServices | NtsGeometryServices | false | none | none |
GeometryOverlay
{}
Properties
None
HighLevelSummariesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [HighLevelSummary] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
HighLevelSummary
{
"type": "string",
"id": "string",
"attributes": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | HighLevelSummaryEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | HighLevelSummaryAttributes | false | none | none |
| relationships | HighLevelSummaryRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
HighLevelSummaryAttributes
{
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| proposedLoanAmount | number(double)¦null | false | none | none |
| securityAmount | number(double)¦null | false | none | none |
| summaryNotes | string¦null | false | none | none |
HighLevelSummaryDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string"
},
"relationships": {
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | HighLevelSummary | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
HighLevelSummaryEntityType
"high-level-summary"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | high-level-summary |
HighLevelSummaryRelationships
{
"dealScenario": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dealScenario | RelationshipsSingleDocument | false | write-only | none |
ImportantDate
"Settled"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Settled |
| anonymous | FinanceClause |
| anonymous | NotProceeding |
| anonymous | Lodged |
| anonymous | PreApproved |
| anonymous | ConditionallyApproved |
| anonymous | Approved |
| anonymous | PreApprovedExpiry |
| anonymous | EstimatedSettled |
ImportantDatesSet
{
"settled": "2019-08-24",
"lodged": "2019-08-24",
"financeClause": "2019-08-24",
"notProceeding": "2019-08-24",
"approved": "2019-08-24",
"preApproved": "2019-08-24",
"conditionallyApproved": "2019-08-24",
"preApprovedExpiry": "2019-08-24",
"estimatedSettled": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| settled | string(date)¦null | false | none | none |
| lodged | string(date)¦null | false | none | none |
| financeClause | string(date)¦null | false | none | none |
| notProceeding | string(date)¦null | false | none | none |
| approved | string(date)¦null | false | none | none |
| preApproved | string(date)¦null | false | none | none |
| conditionallyApproved | string(date)¦null | false | none | none |
| preApprovedExpiry | string(date)¦null | false | none | none |
| estimatedSettled | string(date)¦null | false | none | none |
IncludedResource
{
"type": "string",
"id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | none |
| id | string¦null | false | none | none |
Income
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | IncomesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | IncomeAttributes | false | none | none |
| relationships | IncomeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
IncomeAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| description | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| incomeTypeId | integer(int32)¦null | false | read-only | none |
| incomeVerification | string¦null | false | read-only | none |
| frequency | string¦null | false | read-only | none |
| incomeCategory | string¦null | false | read-only | none |
| incomeType | string¦null | false | read-only | none |
| incomeCategoryId | integer(int32)¦null | false | read-only | none |
IncomeCategoriesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"incomeTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [IncomeCategory] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomeCategoriesEntityType
"income-categories"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | income-categories |
IncomeCategory
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"incomeTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | IncomeCategoriesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | IncomeCategoryAttributes | false | none | none |
| relationships | IncomeCategoryRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
IncomeCategoryAttributes
{
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | read-only | none |
IncomeCategoryDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"incomeTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | IncomeCategory | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomeCategoryRelationships
{
"incomeTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| incomeTypes | RelationshipsMultipleDocument | false | write-only | none |
IncomeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Income | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomeRelationships
{
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| linkedAsset | RelationshipsSingleDocument | false | none | none |
| ownership | RelationshipsMultipleDocument | false | none | none |
IncomeType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"incomeCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | IncomeTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | IncomeTypeAttributes | false | none | none |
| relationships | IncomeTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
IncomeTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
IncomeTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"incomeCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | IncomeType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomeTypeRelationships
{
"incomeCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| incomeCategory | RelationshipsSingleDocument | false | write-only | none |
IncomeTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"incomeCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [IncomeType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomeTypesEntityType
"income-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | income-types |
IncomeVerificationEnum
"CurrentPayslips"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | CurrentPayslips |
| anonymous | CurrentGroupCertificate |
| anonymous | CurrentPersonalTaxReturn |
| anonymous | PreviousYearPersonalTaxReturn |
| anonymous | NoticeOfAssessment |
| anonymous | CurrentCompanyTaxReturn |
| anonymous | PreviousCompanyTaxReturn |
| anonymous | LetterFromEmployer |
| anonymous | EmploymentContract |
| anonymous | BankAccountStatement |
| anonymous | Other |
IncomesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"description": "string",
"value": 0.1,
"incomeTypeId": 0,
"incomeVerification": "string",
"frequency": "string",
"incomeCategory": "string",
"incomeType": "string",
"incomeCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Income] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IncomesEntityType
"incomes"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | incomes |
Integration
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | IntegrationsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | IntegrationAttributes | false | none | none |
| relationships | IntegrationRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
IntegrationAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time) | false | read-only | none |
| created | string(date-time) | false | read-only | none |
| name | string | false | none | none |
| description | string¦null | false | none | none |
IntegrationDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Integration | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IntegrationRelationships
{
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactExternalReferences | RelationshipsMultipleDocument | false | none | none |
| dealExternalReferences | RelationshipsMultipleDocument | false | none | none |
IntegrationsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"name": "string",
"description": "string"
},
"relationships": {
"contactExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
},
"dealExternalReferences": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Integration] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
IntegrationsEntityType
"integrations"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | integrations |
Lead
{
"type": "string",
"id": "string",
"attributes": {
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | LeadsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | LeadAttributes | false | none | none |
| relationships | LeadRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
LeadAddress
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| formattedAddress | string¦null | false | none | none |
| streetAddress | string¦null | false | none | none |
| suburb | string¦null | false | none | none |
| state | string¦null | false | none | none |
| postCode | string¦null | false | none | none |
| country | string¦null | false | none | none |
| addressType | ClientAddressType | false | none | none |
LeadAddressReference
{
"lid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string | true | none | none |
LeadAsset
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| assetTypeId | integer(int32)¦null | false | none | none |
| assetSubTypeId | integer(int32)¦null | false | none | none |
| description | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| institution | string¦null | false | none | none |
| accountName | string¦null | false | none | none |
| bsb | string¦null | false | none | none |
| accountNumber | string¦null | false | none | none |
| vehicleMake | string¦null | false | none | none |
| vehicleYear | integer(int32)¦null | false | none | none |
| propertyZoningId | integer(int32)¦null | false | none | none |
| propertyTypeId | integer(int32)¦null | false | none | none |
| propertyPrimaryPurpose | PropertyPrimaryPurpose | false | none | none |
| valueBasis | PropertyValueEstimatedBasis | false | none | none |
| address | LeadAddressReference | false | none | none |
| ownership | [LeadContactReference]¦null | false | none | none |
LeadAssetReference
{
"lid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string | true | none | none |
LeadAttributes
{
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| dateOfBirth | string(date)¦null | false | write-only | none |
| title | Title | false | write-only | none |
| firstName | string¦null | false | write-only | none |
| preferredName | string¦null | false | write-only | none |
| lastName | string¦null | false | write-only | none |
| string¦null | false | write-only | none | |
| mobile | string¦null | false | write-only | none |
| contactMatchExisting | ExistingContactCheck | false | write-only | none |
| gender | Gender | false | write-only | none |
| maritalStatus | MaritalStatus | false | write-only | none |
| hasMarketingConsent | boolean¦null | false | write-only | none |
| isGuarantor | boolean¦null | false | write-only | none |
| isDependant | boolean¦null | false | write-only | none |
| isPrimary | boolean¦null | false | write-only | none |
| streetAddress | string¦null | false | write-only | none |
| suburb | string¦null | false | write-only | none |
| state | string¦null | false | write-only | none |
| postCode | string¦null | false | write-only | none |
| country | string¦null | false | write-only | none |
| addressType | ClientAddressType | false | write-only | none |
| formattedAddress | string¦null | false | write-only | none |
| dealName | string¦null | false | write-only | none |
| noteTitle | string¦null | false | write-only | none |
| noteDetails | string¦null | false | write-only | none |
| utmSource | string¦null | false | write-only | none |
| utmMedium | string¦null | false | write-only | none |
| utmCampaign | string¦null | false | write-only | none |
| utmTerm | string¦null | false | write-only | none |
| utmContent | string¦null | false | write-only | none |
| sourceSystemUrl | string¦null | false | write-only | none |
| sourceId | integer(int32)¦null | false | write-only | none |
| sourceCategoryId | integer(int32)¦null | false | write-only | none |
| sourceReferrerId | string¦null | false | write-only | none |
| sourceAdditionalDetails | string¦null | false | write-only | none |
| externalReference | string¦null | false | write-only | none |
| externalIntegration | string¦null | false | write-only | none |
| externalIntegrationAllowCreate | boolean | false | write-only | none |
| sendNotification | boolean | false | write-only | none |
| customStatusName | string¦null | false | read-only | none |
| dealStatus | SystemStatus | false | read-only | none |
LeadContact
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| title | Title | false | none | none |
| firstName | string¦null | false | none | none |
| preferredName | string¦null | false | none | none |
| lastName | string¦null | false | none | none |
| string¦null | false | none | none | |
| mobile | string¦null | false | none | none |
| homePhone | string¦null | false | none | none |
| businessPhone | string¦null | false | none | none |
| dateOfBirthAsString | string(date)¦null | false | none | none |
| dateOfBirth | string(date-time)¦null | false | none | none |
| gender | Gender | false | none | none |
| maritalStatus | MaritalStatus | false | none | none |
| hasMarketingConsent | boolean¦null | false | none | none |
| isGuarantor | boolean¦null | false | none | none |
| isDependant | boolean¦null | false | none | none |
| isPrimary | boolean¦null | false | none | none |
| addresses | [LeadAddressReference]¦null | false | none | none |
| employments | [LeadEmploymentReference]¦null | false | none | none |
LeadContactReference
{
"lid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string | true | none | none |
LeadDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Lead | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LeadEmployment
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| employmentStatus | EmploymentStatus | false | none | none |
| employmentType | EmploymentType | false | none | none |
| dateStartedAsString | string(date)¦null | false | none | none |
| dateStarted | string(date-time)¦null | false | none | none |
| dateEndedAsString | string(date)¦null | false | none | none |
| dateEnded | string(date-time)¦null | false | none | none |
| employmentRoleName | string¦null | false | none | none |
| employmentBasis | EmploymentBasis | false | none | none |
| isProbation | boolean¦null | false | none | none |
| businessNumber | string¦null | false | none | none |
| companyNumber | string¦null | false | none | none |
| employerName | string¦null | false | none | none |
| employerContactTitle | Title | false | none | none |
| employerContactFirstName | string¦null | false | none | none |
| employerContactLastName | string¦null | false | none | none |
| employerType | EmployerType | false | none | none |
| employerPhone | string¦null | false | none | none |
| address | LeadAddressReference | false | none | none |
LeadEmploymentReference
{
"lid": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string | true | none | none |
LeadExpense
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| expenseTypeId | integer(int32)¦null | false | none | none |
| description | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| frequency | Frequency | false | none | none |
| ownership | [LeadContactReference]¦null | false | none | none |
LeadIncome
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| incomeTypeId | integer(int32)¦null | false | none | none |
| description | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| frequency | Frequency | false | none | none |
| incomeVerification | IncomeVerificationEnum | false | none | none |
| ownership | [LeadContactReference]¦null | false | none | none |
| asset | LeadAssetReference | false | none | none |
| employment | LeadEmploymentReference | false | none | none |
LeadLiability
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| lid | string¦null | false | none | none |
| liabilityTypeId | integer(int32)¦null | false | none | none |
| liabilitySubTypeId | integer(int32)¦null | false | none | none |
| description | string¦null | false | none | none |
| accountName | string¦null | false | none | none |
| bsb | string¦null | false | none | none |
| accountNumber | string¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| limit | number(double)¦null | false | none | none |
| repayments | number(double)¦null | false | none | none |
| repaymentFrequency | Frequency | false | none | none |
| interestRate | number(double)¦null | false | none | none |
| interestTaxDeductible | boolean¦null | false | none | none |
| creditorName | string¦null | false | none | none |
| loanTerm | integer(int32)¦null | false | none | none |
| loanRepaymentType | LiabilityRepaymentType | false | none | none |
| mortgagePriority | MortgagePriority | false | none | none |
| asset | LeadAssetReference | false | none | none |
| ownership | [LeadContactReference]¦null | false | none | none |
LeadRelationships
{}
Properties
None
LeadsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"dateOfBirth": "2019-08-24",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"contactMatchExisting": "Email",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "string",
"country": "string",
"addressType": "Current",
"formattedAddress": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceSystemUrl": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Lead] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LeadsEntityType
"leads"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | leads |
LiabilitiesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Liability] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilitiesEntityType
"liabilities"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | liabilities |
Liability
{
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | LiabilitiesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | LiabilityAttributes | false | none | none |
| relationships | LiabilityRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
LiabilityAttributes
{
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| created | string(date-time)¦null | false | read-only | none |
| repayment | number(double)¦null | false | none | none |
| value | number(double)¦null | false | none | none |
| limit | number(double)¦null | false | none | none |
| accountName | string¦null | false | none | none |
| accountNumber | string¦null | false | none | none |
| bsb | string¦null | false | none | none |
| interestTaxDeductible | boolean¦null | false | none | none |
| interestRate | number(double)¦null | false | none | none |
| isAccountDetailsKnown | boolean¦null | false | none | none |
| liabilityTypeId | integer(int32)¦null | false | read-only | none |
| loanTerm | integer(int32)¦null | false | none | none |
| liabilitySubTypeId | integer(int32)¦null | false | read-only | none |
| repaymentFrequency | string¦null | false | read-only | none |
| liabilityCategory | string¦null | false | read-only | none |
| liabilitySubType | string¦null | false | read-only | none |
| liabilityType | string¦null | false | read-only | none |
| mortgagePriority | string¦null | false | read-only | none |
| updated | string(date-time)¦null | false | read-only | none |
| creditorName | string¦null | false | read-only | none |
| loanRepaymentType | LiabilityRepaymentType | false | read-only | none |
| liabilityCategoryId | integer(int32)¦null | false | read-only | none |
LiabilityCategoriesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"liabilityTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [LiabilityCategory] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilityCategoriesEntityType
"liability-categories"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | liability-categories |
LiabilityCategory
{
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"liabilityTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | LiabilityCategoriesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | LiabilityCategoryAttributes | false | none | none |
| relationships | LiabilityCategoryRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
LiabilityCategoryAttributes
{
"description": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| description | string¦null | false | read-only | none |
LiabilityCategoryDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"description": "string"
},
"relationships": {
"liabilityTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | LiabilityCategory | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilityCategoryRelationships
{
"liabilityTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| liabilityTypes | RelationshipsMultipleDocument | false | write-only | none |
LiabilityDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"created": "2019-08-24T14:15:22Z",
"repayment": 0.1,
"value": 0.1,
"limit": 0.1,
"accountName": "string",
"accountNumber": "string",
"bsb": "string",
"interestTaxDeductible": true,
"interestRate": 0.1,
"isAccountDetailsKnown": true,
"liabilityTypeId": 0,
"loanTerm": 0,
"liabilitySubTypeId": 0,
"repaymentFrequency": "string",
"liabilityCategory": "string",
"liabilitySubType": "string",
"liabilityType": "string",
"mortgagePriority": "string",
"updated": "2019-08-24T14:15:22Z",
"creditorName": "string",
"loanRepaymentType": "InterestOnly",
"liabilityCategoryId": 0
},
"relationships": {
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Liability | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilityRelationships
{
"linkedAsset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"ownership": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| linkedAsset | RelationshipsSingleDocument | false | none | none |
| ownership | RelationshipsMultipleDocument | false | none | none |
LiabilityRepaymentType
"InterestOnly"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | InterestOnly |
| anonymous | PrincipalInterest |
LiabilitySubType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | LiabilitySubTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | LiabilitySubTypeAttributes | false | none | none |
| relationships | LiabilitySubTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
LiabilitySubTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
LiabilitySubTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | LiabilitySubType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilitySubTypeRelationships
{}
Properties
None
LiabilitySubTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [LiabilitySubType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilitySubTypesEntityType
"liability-sub-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | liability-sub-types |
LiabilityType
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"liabilityCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liabilitySubTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | LiabilityTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | LiabilityTypeAttributes | false | none | none |
| relationships | LiabilityTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
LiabilityTypeAttributes
{
"name": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| name | string¦null | false | read-only | none |
LiabilityTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"liabilityCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liabilitySubTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | LiabilityType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilityTypeRelationships
{
"liabilityCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liabilitySubTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| liabilityCategory | RelationshipsSingleDocument | false | write-only | none |
| liabilitySubTypes | RelationshipsMultipleDocument | false | write-only | none |
LiabilityTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"name": "string"
},
"relationships": {
"liabilityCategory": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liabilitySubTypes": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [LiabilityType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
LiabilityTypesEntityType
"liability-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | liability-types |
LoanStructureImportantDateTypes
"InterestOnly"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | InterestOnly |
| anonymous | RepaymentHoliday |
LoanStructureType
"PrincipalInterest"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PrincipalInterest |
| anonymous | InterestOnly |
| anonymous | RevolvingCredit |
| anonymous | Offset |
MaritalStatus
"Single"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Single |
| anonymous | Married |
| anonymous | DeFacto |
| anonymous | Separated |
| anonymous | Divorced |
| anonymous | Widowed |
MortgagePriority
"First"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | First |
| anonymous | Second |
| anonymous | Third |
NtsGeometryServices
{
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| geometryOverlay | GeometryOverlay | false | none | none |
| coordinateEqualityComparer | CoordinateEqualityComparer | false | none | none |
| defaultSRID | integer(int32) | false | read-only | none |
| defaultCoordinateSequenceFactory | CoordinateSequenceFactory | false | none | none |
| defaultPrecisionModel | PrecisionModel | false | none | none |
OgcGeometryType
"Point"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Point |
| anonymous | LineString |
| anonymous | Polygon |
| anonymous | MultiPoint |
| anonymous | MultiLineString |
| anonymous | MultiPolygon |
| anonymous | GeometryCollection |
| anonymous | CircularString |
| anonymous | CompoundCurve |
| anonymous | CurvePolygon |
| anonymous | MultiCurve |
| anonymous | MultiSurface |
| anonymous | Curve |
| anonymous | Surface |
| anonymous | PolyhedralSurface |
| anonymous | TIN |
Opportunity
{
"proposedLoanAmount": 0.1,
"securityAmount": 0.1,
"summaryNotes": "string",
"loanPurpose": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| proposedLoanAmount | number(double)¦null | false | none | none |
| securityAmount | number(double)¦null | false | none | none |
| summaryNotes | string¦null | false | none | none |
| loanPurpose | string¦null | false | none | none |
Ordinates
"None"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | None |
| anonymous | X |
| anonymous | Y |
| anonymous | XY |
| anonymous | Z |
| anonymous | XYZ |
| anonymous | Spatial4 |
| anonymous | Spatial5 |
| anonymous | Spatial6 |
| anonymous | Spatial7 |
| anonymous | Spatial8 |
| anonymous | Spatial9 |
| anonymous | Spatial10 |
| anonymous | Spatial11 |
| anonymous | Spatial12 |
| anonymous | Spatial13 |
| anonymous | Spatial14 |
| anonymous | Spatial15 |
| anonymous | Spatial16 |
| anonymous | AllSpatialOrdinates |
| anonymous | M |
| anonymous | XYM |
| anonymous | XYZM |
| anonymous | Measure2 |
| anonymous | Measure3 |
| anonymous | Measure4 |
| anonymous | Measure5 |
| anonymous | Measure6 |
| anonymous | Measure7 |
| anonymous | Measure8 |
| anonymous | Measure9 |
| anonymous | Measure10 |
| anonymous | Measure11 |
| anonymous | Measure12 |
| anonymous | Measure13 |
| anonymous | Measure14 |
| anonymous | Measure15 |
| anonymous | Measure16 |
| anonymous | AllMeasureOrdinates |
| anonymous | AllOrdinates |
Organisation
{
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | OrganisationsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | OrganisationAttributes | false | none | none |
| relationships | OrganisationRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
OrganisationAddress
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isCustomAddress": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | OrganisationAddressesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | OrganisationAddressAttributes | false | none | none |
| relationships | OrganisationAddressRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
OrganisationAddressAttributes
{
"isMailing": true,
"isCustomAddress": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isMailing | boolean¦null | false | none | none |
| isCustomAddress | boolean¦null | false | none | none |
| formattedAddress | string¦null | false | read-only | none |
| streetAddress | string¦null | false | read-only | none |
| country | string¦null | false | read-only | none |
| suburb | string¦null | false | read-only | none |
| postCode | string¦null | false | read-only | none |
| state | string¦null | false | read-only | none |
OrganisationAddressDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isCustomAddress": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | OrganisationAddress | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OrganisationAddressRelationships
{}
Properties
None
OrganisationAddressesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"isMailing": true,
"isCustomAddress": true,
"formattedAddress": "string",
"streetAddress": "string",
"country": "string",
"suburb": "string",
"postCode": "string",
"state": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [OrganisationAddress] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OrganisationAddressesEntityType
"organisation-addresses"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | organisation-addresses |
OrganisationAttributes
{
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| brandedCategory | string¦null | false | read-only | none |
| primaryBrandColour | string¦null | false | read-only | none |
| name | string¦null | false | read-only | none |
| tradingName | string¦null | false | read-only | none |
| website | string¦null | false | read-only | none |
| companyEmail | string¦null | false | read-only | none |
| isBrokerSearchVisible | boolean¦null | false | read-only | none |
| status | string¦null | false | read-only | none |
| slug | string¦null | false | read-only | none |
| businessNumber | string¦null | false | read-only | none |
| companyNumber | string¦null | false | read-only | none |
| officeDisplayName | string¦null | false | read-only | none |
| emailForCommissions | string¦null | false | read-only | none |
| phone | string¦null | false | read-only | none |
| fax | string¦null | false | read-only | none |
| brandLogoUrl | string(uri)¦null | false | read-only | none |
OrganisationDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Organisation | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OrganisationRelationships
{
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| addresses | RelationshipsMultipleDocument | false | write-only | none |
OrganisationsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"brandedCategory": "string",
"primaryBrandColour": "string",
"name": "string",
"tradingName": "string",
"website": "string",
"companyEmail": "string",
"isBrokerSearchVisible": true,
"status": "string",
"slug": "string",
"businessNumber": "string",
"companyNumber": "string",
"officeDisplayName": "string",
"emailForCommissions": "string",
"phone": "string",
"fax": "string",
"brandLogoUrl": "http://example.com"
},
"relationships": {
"addresses": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Organisation] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OrganisationsEntityType
"organisations"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | organisations |
Owner
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"expense": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liability": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"income": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | OwnersEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | OwnerAttributes | false | none | none |
| relationships | OwnerRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
OwnerAttributes
{
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| updated | string(date-time)¦null | false | read-only | none |
| created | string(date-time)¦null | false | read-only | none |
| ownershipPercentage | number(double)¦null | false | read-only | none |
OwnerDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"expense": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liability": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"income": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Owner | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OwnerRelationships
{
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"expense": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liability": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"income": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contact | RelationshipsSingleDocument | false | none | none |
| business | RelationshipsSingleDocument | false | none | none |
| asset | RelationshipsSingleDocument | false | write-only | none |
| expense | RelationshipsSingleDocument | false | write-only | none |
| liability | RelationshipsSingleDocument | false | write-only | none |
| income | RelationshipsSingleDocument | false | write-only | none |
OwnersDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"updated": "2019-08-24T14:15:22Z",
"created": "2019-08-24T14:15:22Z",
"ownershipPercentage": 0.1
},
"relationships": {
"contact": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"business": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"asset": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"expense": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"liability": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
},
"income": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Owner] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
OwnersEntityType
"owners"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | owners |
Pagination
{
"size": 0,
"number": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| size | integer(int32) | false | none | none |
| number | integer(int32) | false | none | none |
Point
{
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
},
"envelope": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"geometryType": "string",
"ogcGeometryType": "Point",
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"isEmpty": true,
"area": 0.1,
"length": 0.1,
"centroid": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"interiorPoint": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"pointOnSurface": {
"factory": {
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {
"ordinates": "None"
},
"srid": 0,
"geometryServices": {
"geometryOverlay": {},
"coordinateEqualityComparer": {},
"defaultSRID": 0,
"defaultCoordinateSequenceFactory": {
"ordinates": "None"
},
"defaultPrecisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
},
"numGeometries": 0,
"isSimple": true,
"isValid": true,
"area": 0.1,
"length": 0.1,
"centroid": {},
"interiorPoint": {},
"pointOnSurface": {},
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true,
"coordinateSequence": {
"dimension": 0,
"measures": 0,
"spatial": 0,
"ordinates": "None",
"hasZ": true,
"hasM": true,
"zOrdinateIndex": 0,
"mOrdinateIndex": 0,
"first": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"last": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"count": 0
},
"coordinates": [
{
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
],
"numPoints": 0,
"isEmpty": true,
"dimension": "Point",
"boundaryDimension": "Point",
"x": 0.1,
"y": 0.1,
"coordinate": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
},
"geometryType": "string",
"ogcGeometryType": "Point",
"boundary": {},
"z": 0.1,
"m": 0.1
},
"dimension": "Point",
"boundary": {},
"boundaryDimension": "Point",
"envelope": {},
"envelopeInternal": {
"isNull": true,
"width": 0.1,
"height": 0.1,
"diameter": 0.1,
"minX": 0.1,
"maxX": 0.1,
"minY": 0.1,
"maxY": 0.1,
"area": 0.1,
"minExtent": 0.1,
"maxExtent": 0.1,
"centre": {
"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinateValue": {},
"isValid": true
}
},
"isRectangle": true
},
"z": 0.1,
"m": 0.1
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| factory | GeometryFactory | false | none | none |
| userData | any | false | none | none |
| srid | integer(int32) | false | none | none |
| precisionModel | PrecisionModel | false | none | none |
| numGeometries | integer(int32) | false | read-only | none |
| isSimple | boolean | false | read-only | none |
| isValid | boolean | false | read-only | none |
| area | number(double) | false | read-only | none |
| length | number(double) | false | read-only | none |
| centroid | Point | false | none | none |
| interiorPoint | Point | false | none | none |
| pointOnSurface | Point | false | none | none |
| envelope | Geometry | false | none | none |
| envelopeInternal | Envelope | false | none | none |
| isRectangle | boolean | false | read-only | none |
| coordinateSequence | CoordinateSequence | false | none | none |
| coordinates | [Coordinate]¦null | false | read-only | none |
| numPoints | integer(int32) | false | read-only | none |
| isEmpty | boolean | false | read-only | none |
| dimension | Dimension | false | none | none |
| boundaryDimension | Dimension | false | none | none |
| x | number(double) | false | none | none |
| y | number(double) | false | none | none |
| coordinate | Coordinate | false | none | none |
| geometryType | string¦null | false | read-only | none |
| ogcGeometryType | OgcGeometryType | false | none | none |
| boundary | Geometry | false | none | none |
| z | number(double) | false | none | none |
| m | number(double) | false | none | none |
PrecisionModel
{
"isFloating": true,
"maximumSignificantDigits": 0,
"scale": 0.1,
"gridSize": 0.1,
"precisionModelType": "Floating"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| isFloating | boolean | false | read-only | none |
| maximumSignificantDigits | integer(int32) | false | read-only | none |
| scale | number(double) | false | none | none |
| gridSize | number(double) | false | read-only | none |
| precisionModelType | PrecisionModels | false | none | none |
PrecisionModels
"Floating"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Floating |
| anonymous | FloatingSingle |
| anonymous | Fixed |
PropertyPrimaryPurpose
"PurchaseOwnerOccupied"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | PurchaseOwnerOccupied |
| anonymous | PurchaseInvestment |
PropertyType
{
"type": "string",
"id": "string",
"attributes": {
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | PropertyTypesEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | PropertyTypeAttributes | false | none | none |
| relationships | PropertyTypeRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
PropertyTypeAttributes
{
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| propertyZoningType | string¦null | false | read-only | none |
| name | string¦null | false | read-only | none |
| propertyZoningTypeId | integer(int32)¦null | false | read-only | none |
PropertyTypeDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | PropertyType | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
PropertyTypeRelationships
{}
Properties
None
PropertyTypesDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"propertyZoningType": "string",
"name": "string",
"propertyZoningTypeId": 0
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [PropertyType] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
PropertyTypesEntityType
"property-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | property-types |
PropertyValueEstimatedBasis
"ApplicantEstimate"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | ApplicantEstimate |
| anonymous | CertifiedValuation |
| anonymous | ActualValue |
PropertyZoningTypesEntityType
"property-zoning-types"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | property-zoning-types |
Referrer
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrganisationName": "string",
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ReferrersEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ReferrerAttributes | false | none | none |
| relationships | ReferrerRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ReferrerAttributes
{
"referrerOrganisationName": "string",
"referrerName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| referrerOrganisationName | string¦null | false | read-only | none |
| referrerName | string¦null | false | read-only | none |
ReferrerDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"referrerOrganisationName": "string",
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | Referrer | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrerMember
{
"type": "string",
"id": "string",
"attributes": {
"referrerName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ReferrerMembersEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ReferrerMemberAttributes | false | none | none |
| relationships | ReferrerMemberRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ReferrerMemberAttributes
{
"referrerName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| referrerName | string¦null | false | none | none |
ReferrerMemberDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"referrerName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ReferrerMember | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrerMemberRelationships
{
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactGroups | RelationshipsMultipleDocument | false | write-only | none |
ReferrerMembersDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ReferrerMember] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrerMembersEntityType
"referrer-members"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | referrer-members |
ReferrerOrganisation
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrgName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | ReferrerOrganisationEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | ReferrerOrganisationAttributes | false | none | none |
| relationships | ReferrerOrganisationRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ReferrerOrganisationAttributes
{
"referrerOrgName": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| referrerOrgName | string¦null | false | none | none |
ReferrerOrganisationDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"referrerOrgName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ReferrerOrganisation | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrerOrganisationEntityType
"referrer-organisation"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | referrer-organisation |
ReferrerOrganisationRelationships
{
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contactGroups | RelationshipsMultipleDocument | false | write-only | none |
ReferrerOrganisationsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrgName": "string"
},
"relationships": {
"contactGroups": {
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ReferrerOrganisation] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrerRelationships
{}
Properties
None
ReferrersDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"referrerOrganisationName": "string",
"referrerName": "string"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [Referrer] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ReferrersEntityType
"referrers"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | referrers |
RelationshipLinks
{
"self": "string",
"related": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| self | string¦null | false | none | none |
| related | string¦null | false | none | none |
RelationshipObject
{
"links": {
"self": "string",
"related": "string"
},
"data": {
"value": null
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| links | RelationshipLinks | false | none | none |
| data | SingleOrManyData`1 | false | none | none |
| meta | object¦null | false | none | none |
| » additionalProperties | any | false | none | none |
RelationshipsMultipleDocument
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| links | RelationshipLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| data | [ResourceIdentifier]¦null | true | none | none |
RelationshipsSingleDocument
{
"links": {
"self": "string",
"related": "string"
},
"meta": {
"property1": null,
"property2": null
},
"data": {
"type": "string",
"id": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| links | RelationshipLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| data | ResourceIdentifier | true | none | none |
ResourceIdentifier
{
"type": "string",
"id": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string | true | none | none |
| id | string | false | none | none |
ResourceLinks
{
"self": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| self | string¦null | false | none | none |
ResourceObject
{
"id": "string",
"attributes": {
"type": "string",
"lid": "string",
"links": {
"self": "string"
}
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| id | string¦null | false | none | none |
| attributes | ResourceObjectAttributes | false | none | none |
| relationships | ResourceObjectRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
ResourceObjectAttributes
{
"type": "string",
"lid": "string",
"links": {
"self": "string"
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | string¦null | false | none | none |
| lid | string¦null | false | none | none |
| links | ResourceLinks | false | none | none |
ResourceObjectDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"id": "string",
"attributes": {
"type": "string",
"lid": "string",
"links": {
"self": "string"
}
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | ResourceObject | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
ResourceObjectRelationships
{}
Properties
None
ResourceObjectsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"id": "string",
"attributes": {
"type": "string",
"lid": "string",
"links": {
"self": "string"
}
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [ResourceObject] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
SingleOrManyData`1
{
"value": null
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| value | any | false | none | none |
Split
{
"loanTermYears": 0.1,
"rateType": "string",
"loanStructureType": "PrincipalInterest",
"amount": 0.1,
"interestRate": 0.1,
"rateTypePeriodMonths": 0,
"paymentAmount": 0.1,
"fixedRateStartDate": "2019-08-24",
"fixedRateEndDate": "2019-08-24",
"interestOnlyStartDate": "2019-08-24",
"interestOnlyEndDate": "2019-08-24",
"repaymentHolidayStartDate": "2019-08-24",
"repaymentHolidayEndDate": "2019-08-24"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| loanTermYears | number(double)¦null | false | none | none |
| rateType | string¦null | false | none | none |
| loanStructureType | LoanStructureType | false | none | none |
| amount | number(double)¦null | false | none | none |
| interestRate | number(double)¦null | false | none | none |
| rateTypePeriodMonths | integer(int32)¦null | false | none | none |
| paymentAmount | number(double)¦null | false | none | none |
| fixedRateStartDate | string(date)¦null | false | none | none |
| fixedRateEndDate | string(date)¦null | false | none | none |
| interestOnlyStartDate | string(date)¦null | false | none | none |
| interestOnlyEndDate | string(date)¦null | false | none | none |
| repaymentHolidayStartDate | string(date)¦null | false | none | none |
| repaymentHolidayEndDate | string(date)¦null | false | none | none |
StructuredLead
{
"type": "string",
"id": "string",
"attributes": {
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| type | StructuredLeadsEntityType | true | none | none |
| id | string | true | read-only | none |
| attributes | StructuredLeadAttributes | false | none | none |
| relationships | StructuredLeadRelationships | false | none | none |
| links | ResourceLinks | false | read-only | none |
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
StructuredLeadAttributes
{
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| contacts | [LeadContact]¦null | false | write-only | none |
| addresses | [LeadAddress]¦null | false | write-only | none |
| assets | [LeadAsset]¦null | false | write-only | none |
| expenses | [LeadExpense]¦null | false | write-only | none |
| incomes | [LeadIncome]¦null | false | write-only | none |
| liabilities | [LeadLiability]¦null | false | write-only | none |
| employments | [LeadEmployment]¦null | false | write-only | none |
| utmSource | string¦null | false | write-only | none |
| utmMedium | string¦null | false | write-only | none |
| utmCampaign | string¦null | false | write-only | none |
| utmTerm | string¦null | false | write-only | none |
| utmContent | string¦null | false | write-only | none |
| sourceId | integer(int32)¦null | false | write-only | none |
| sourceCategoryId | integer(int32)¦null | false | write-only | none |
| sourceReferrerId | string¦null | false | write-only | none |
| sourceAdditionalDetails | string¦null | false | write-only | none |
| sourceSystemUrl | string¦null | false | write-only | none |
| dealName | string¦null | false | write-only | none |
| noteTitle | string¦null | false | write-only | none |
| noteDetails | string¦null | false | write-only | none |
| externalReference | string¦null | false | write-only | none |
| externalIntegration | string¦null | false | write-only | none |
| externalIntegrationAllowCreate | boolean | false | write-only | none |
| sendNotification | boolean | false | write-only | none |
| customStatusName | string¦null | false | read-only | none |
| dealStatus | SystemStatus | false | read-only | none |
StructuredLeadDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": {
"type": "string",
"id": "string",
"attributes": {
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
},
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | StructuredLead | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
StructuredLeadRelationships
{}
Properties
None
StructuredLeadsDocument
{
"meta": {
"property1": null,
"property2": null
},
"jsonApi": {
"property1": null,
"property2": null
},
"links": {
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"data": [
{
"type": "string",
"id": "string",
"attributes": {
"contacts": [
{
"lid": "string",
"title": "Mr",
"firstName": "string",
"preferredName": "string",
"lastName": "string",
"email": "string",
"mobile": "string",
"homePhone": "string",
"businessPhone": "string",
"dateOfBirthAsString": "2019-08-24",
"dateOfBirth": "2019-08-24T14:15:22Z",
"gender": "Male",
"maritalStatus": "Single",
"hasMarketingConsent": true,
"isGuarantor": true,
"isDependant": true,
"isPrimary": true,
"addresses": [
{
"lid": "string"
}
],
"employments": [
{
"lid": "string"
}
]
}
],
"addresses": [
{
"lid": "string",
"formattedAddress": "string",
"streetAddress": "string",
"suburb": "string",
"state": "string",
"postCode": "stri",
"country": "string",
"addressType": "Current"
}
],
"assets": [
{
"lid": "string",
"assetTypeId": 0,
"assetSubTypeId": 0,
"description": "string",
"value": 0.1,
"institution": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"vehicleMake": "string",
"vehicleYear": 0,
"propertyZoningId": 0,
"propertyTypeId": 0,
"propertyPrimaryPurpose": "PurchaseOwnerOccupied",
"valueBasis": "ApplicantEstimate",
"address": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"expenses": [
{
"lid": "string",
"expenseTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"ownership": [
{
"lid": "string"
}
]
}
],
"incomes": [
{
"lid": "string",
"incomeTypeId": 0,
"description": "string",
"value": 0.1,
"frequency": "Yearly",
"incomeVerification": "CurrentPayslips",
"ownership": [
{
"lid": "string"
}
],
"asset": {
"lid": "string"
},
"employment": {
"lid": "string"
}
}
],
"liabilities": [
{
"lid": "string",
"liabilityTypeId": 0,
"liabilitySubTypeId": 0,
"description": "string",
"accountName": "string",
"bsb": "string",
"accountNumber": "string",
"value": 0.1,
"limit": 0.1,
"repayments": 0.1,
"repaymentFrequency": "Yearly",
"interestRate": 0.1,
"interestTaxDeductible": true,
"creditorName": "string",
"loanTerm": 0,
"loanRepaymentType": "InterestOnly",
"mortgagePriority": "First",
"asset": {
"lid": "string"
},
"ownership": [
{
"lid": "string"
}
]
}
],
"employments": [
{
"lid": "string",
"employmentStatus": "PrimaryEmployment",
"employmentType": "PAYG",
"dateStartedAsString": "2019-08-24",
"dateStarted": "2019-08-24T14:15:22Z",
"dateEndedAsString": "2019-08-24",
"dateEnded": "2019-08-24T14:15:22Z",
"employmentRoleName": "string",
"employmentBasis": "FullTime",
"isProbation": true,
"businessNumber": "string",
"companyNumber": "string",
"employerName": "string",
"employerContactTitle": "Mr",
"employerContactFirstName": "string",
"employerContactLastName": "string",
"employerType": "Private",
"employerPhone": "string",
"address": {
"lid": "string"
}
}
],
"utmSource": "string",
"utmMedium": "string",
"utmCampaign": "string",
"utmTerm": "string",
"utmContent": "string",
"sourceId": 0,
"sourceCategoryId": 0,
"sourceReferrerId": "string",
"sourceAdditionalDetails": "string",
"sourceSystemUrl": "string",
"dealName": "string",
"noteTitle": "string",
"noteDetails": "string",
"externalReference": "string",
"externalIntegration": "string",
"externalIntegrationAllowCreate": true,
"sendNotification": true,
"customStatusName": "string",
"dealStatus": "NewLeads"
},
"relationships": {},
"links": {
"self": "string"
},
"meta": {
"property1": null,
"property2": null
}
}
],
"included": [
{
"type": "string",
"id": "string"
}
]
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| meta | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| jsonApi | object | false | read-only | none |
| » additionalProperties | any | false | none | none |
| links | TopLevelLinks | false | read-only | none |
| data | [StructuredLead] | true | none | none |
| included | [IncludedResource]¦null | false | read-only | none |
StructuredLeadsEntityType
"structured-leads"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | structured-leads |
SystemStatus
"NewLeads"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | NewLeads |
| anonymous | Researching |
| anonymous | PreApproved |
| anonymous | ConditionallyApproved |
| anonymous | UnconditionallyApproved |
| anonymous | Lodged |
| anonymous | InProgress |
| anonymous | PendingSettlement |
| anonymous | Varied |
| anonymous | Repaid |
| anonymous | Withdrawn |
| anonymous | Cancelled |
| anonymous | Settled |
Title
"Mr"
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| anonymous | string | false | none | none |
Enumerated Values
| Property | Value |
|---|---|
| anonymous | Mr |
| anonymous | Mrs |
| anonymous | Ms |
| anonymous | Miss |
| anonymous | Master |
| anonymous | Dr |
TopLevelLinks
{
"self": "string",
"related": "string",
"describedby": "string",
"first": "string",
"last": "string",
"prev": "string",
"next": "string"
}
Properties
| Name | Type | Required | Restrictions | Description |
|---|---|---|---|---|
| self | string¦null | false | none | none |
| related | string¦null | false | none | none |
| describedby | string¦null | false | none | none |
| first | string¦null | false | none | none |
| last | string¦null | false | none | none |
| prev | string¦null | false | none | none |
| next | string¦null | false | none | none |