{
"swagger": "2.0",
"info": {
"description": "Welcome to our PEXA Exchange API documentation. These APIs cover key facets of PEXA Exchange functionality. \n\nPEXA APIs use the OAuth 2.0 protocol for authentication and authorization. They support the following OAuth 2.0 flows: \n- Client Credentials \n- Authorization Code\n\nScopes are used to grant an application different levels of access to data. Each API endpoint will require specific scopes. \nThe scopes are listed against each API endpoint.\n\n Server URLs:\n - https://api.pexa.com.au/api/rest (prod)\n - https://api-tst.pexalabs.com.au/api/rest (non-prod) \n\nFor more information, see the following guides:\n - [Authentication](../../docs/documentation/)",
"version": "1.0.0",
"title": "PEXA Exchange API"
},
"tags": [
{
"name": "HealthCheck"
},
{
"name": "User"
},
{
"name": "Landtitle"
},
{
"name": "Subscriber"
},
{
"name": "Workspace"
},
{
"name": "Invitation"
},
{
"name": "Conversation"
},
{
"name": "Document"
},
{
"name": "Settlement"
}
],
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"paths": {
"/v2/health": {
"get": {
"tags": [
"HealthCheck"
],
"summary": "Health Check",
"description": "This API verifies whether the application is up and running.\n\n Scopes:\nau_pub_cert_pexa_healthcheck_api_v2_read (non-prod)\nau_pub_pexa_healthcheck_api_v2_read (prod)",
"operationId": "HealthCheck",
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/landRegistry/titleStatus": {
"get": {
"tags": [
"Landtitle"
],
"summary": "Land Title Registry Verification",
"description": "This API verifies whether the land title reference is 'in use' in other workspaces and whether the land title is eligible for electronic lodgement.\n\n Scopes:\nau_pub_cert_pexa_landtitle_api_v2_read (non-prod)\nau_pub_pexa_landtitle_api_v2_read (prod)",
"operationId": "LTRV",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "jurisdiction",
"in": "query",
"description": "Refer to [Jurisdiction](../../docs/guides/reference-data/#_jurisdiction_data) for valid values",
"required": true,
"type": "string",
"allowEmptyValue": false
},
{
"name": "landTitleReference",
"in": "query",
"description": "Land title reference (see [Land title reference format](../../docs/resources/#_land_title_reference_format) for valid formatting)",
"required": true,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/subscriber/conversation/{conversationId}/message": {
"post": {
"tags": [
"Conversation"
],
"summary": "Send a message to an existing conversation",
"description": "This API allows you to send a message to an existing conversation thread.\n\n Scopes:\nau_pub_cert_pexa_conversation_api_v2_write (non-prod)\nau_pub_pexa_conversation_api_v2_write (prod)",
"operationId": "postMessageUsingPOST",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "conversationId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "createMessageRequest",
"description": "createMessageRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateMessageRequest"
}
},
{
"name": "role",
"in": "query",
"description": "role",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateMessageResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/subscriber/conversations": {
"get": {
"tags": [
"Conversation"
],
"summary": "Retrieve Unread Conversations",
"description": "This API retrieves a list of unread conversations.\n\n Scopes:\nau_pub_cert_pexa_conversation_api_v2_read (non-prod)\nau_pub_pexa_conversation_api_v2_read (prod)",
"operationId": "retrieveUnreadConversationsUsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.ConversationsRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/subscriber/conversations/{conversationId}/markAsRead": {
"put": {
"tags": [
"Conversation"
],
"summary": "Mark as Read the Conversation for a specific Subscriber and Role",
"description": "This API allows to update/mark as read the conversation for a specific conversation id, subscriber id and role.\n\n Scopes:\nau_pub_cert_pexa_conversation_api_v2_write (non-prod)\nau_pub_pexa_conversation_api_v2_write (prod)",
"operationId": "markConversationAsReadUsingPUT",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "conversationId",
"in": "path",
"description": "conversationId",
"required": true,
"type": "integer",
"format": "int64"
},
{
"name": "role",
"in": "query",
"description": "role",
"required": false,
"type": "string"
},
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/subscriber/invitation": {
"put": {
"tags": [
"Invitation"
],
"summary": "Respond to invitation",
"description": "This API allows a subscriber (invitee) to respond to an invitation or a subscriber (invitor) to withdraw an invitation\n\n Scopes:\nau_pub_cert_pexa_invitation_api_v2_write (non-prod)\nau_pub_pexa_invitation_api_v2_write (prod)",
"operationId": "respondInvitationV1UsingPUT",
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "respondInvitationRequest",
"description": "respondInvitationRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.RespondInvitationRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/subscriber/invitations": {
"get": {
"tags": [
"Invitation"
],
"summary": "Retrieve outstanding invitations",
"description": "This API provides details of outstanding invitations.\n\n Scopes:\nau_pub_cert_pexa_invitation_api_v2_read (non-prod)\nau_pub_pexa_invitation_api_v2_read (prod)",
"operationId": "retrieveOutstandingInvitationsV1UsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "lastInviteId",
"in": "query",
"description": "Last Invite Id. Field is optional. When provided, only invitations received after this invite id will be returned.",
"required": false,
"type": "string"
},
{
"name": "subscriberId",
"in": "query",
"description": "Subscriber Id of the entity calling the API. Field is optional.",
"required": false,
"type": "string"
},
{
"name": "workgroupId",
"in": "query",
"description": "Workgroup Id. Field is optional. When provided, only invitations matching the workgroup defaults will be returned. The Workgroup Id must match a workgroup that is associated to the subscriber.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v3/subscriber/workgroups": {
"get": {
"tags": [
"Subscriber"
],
"summary": "Retrieve Workgroups",
"description": "This API retrieves PEXA workgroups and workgroup user assignments.\n\n Scopes:\nau_pub_cert_pexa_subscriber_api_v3_read (non-prod)\nau_pub_pexa_subscriber_api_v3_read (prod)",
"operationId": "retrieveworkgroups",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "subscriberId",
"in": "query",
"description": "The PEXA internal reference for the subscriber initiating the API service call. \nNote: Subscriber Id is optional for subscribers using token based authentication (OAuth 2.0 authorization code or client credentials flow). \nMaximum 19 characters",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v3/user": {
"get": {
"tags": [
"User"
],
"summary": "Retrieves user profile",
"description": "This API will return user profile which is belong to logged in user.\n\n Scopes:\nau_pub_cert_pexa_user_api_v3_read (non-prod)\nau_pub_pexa_user_api_v3_read (prod)",
"operationId": "getUserProfileUsingGET",
"produces": [
"application/xml",
"application/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.UserProfileRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v4/workspace": {
"put": {
"tags": [
"Workspace"
],
"summary": "Initiate Workspace Update",
"description": "This API allows you to update data within a workspace.\n\n Scopes:\nau_pub_cert_pexa_workspace_api_v4_write (non-prod)\nau_pub_pexa_workspace_api_v4_write (prod)",
"operationId": "workspacecreation_1",
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "workspaceUpdateRequest",
"description": "workspaceUpdateRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/documents": {
"get": {
"tags": [
"Document"
],
"summary": "Retrieve Lodged PEXA Workspace Documents",
"description": "This API retrieves the workspace documents that have been signed and lodged by the subscriber.\n\n Scopes:\nau_pub_cert_pexa_documents_api_v2_read (non-prod)\nau_pub_pexa_documents_api_v2_read (prod)",
"operationId": "retrieveLodgedDocumentsV1UsingGET",
"parameters": [
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "subscriberRole",
"in": "query",
"description": "subscriberRole",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "query",
"description": "workspaceId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/documents/dischargeMortgage": {
"post": {
"tags": [
"Document"
],
"summary": "Creates Discharge Document",
"description": "The create discharge document API provides the ability to create a discharge document in the workspace.\n\n Scopes:\nau_pub_cert_pexa_documents_api_v2_write (non-prod)\nau_pub_pexa_documents_api_v2_write (prod)",
"operationId": "createUsingPOST",
"consumes": [
"application/xml",
"application/json;charset=UTF-8"
],
"produces": [
"application/xml",
"application/json;charset=UTF-8"
],
"parameters": [
{
"in": "body",
"name": "createDischargeRequest",
"description": "createDischargeRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateDischargeOfMortgageResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v4/workspace/duty": {
"put": {
"tags": [
"Workspace"
],
"summary": "Manages Transfer Duty Data",
"description": "This API allows you to add or edit stamp duty within an existing workspace that contains a transfer document.\n\n Scopes:\nau_pub_cert_pexa_workspace_api_v4_write (non-prod)\nau_pub_pexa_workspace_api_v4_write (prod)",
"operationId": "updateV1UsingPUT",
"consumes": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "manageTransferDutyRequest",
"description": "manageTransferDutyRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.ManageTransferDutyRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/financial": {
"get": {
"tags": [
"Settlement"
],
"summary": "Retrieves settlement statement",
"description": "This API retrieves the financial settlement statement containing financial line items that belong to the subscriber.\n\n Scopes:\nau_pub_cert_pexa_financial_settlement_schedule_api_v2_read (non-prod)\nau_pub_pexa_financial_settlement_schedule_api_v2_read (prod)",
"operationId": "retrieveSetllementStatementV1UsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "subscriberRole",
"in": "query",
"description": "subscriberRole",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "query",
"description": "workspaceId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementStatementRetrieval"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": [
"Settlement"
],
"summary": "Upload Financial Settlement Line Items",
"description": "This API allows you to create a settlement schedule and add financial settlement line items to the settlement schedule.\n\n Scopes:\nau_pub_cert_pexa_financial_settlement_schedule_api_v2_write (non-prod)\nau_pub_pexa_financial_settlement_schedule_api_v2_write (prod)",
"operationId": "createUsingPOST_1",
"consumes": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "settlementUploadRequest",
"description": "settlementUploadRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/invitation": {
"post": {
"tags": [
"Invitation"
],
"summary": "Create workspace Invitation",
"description": "This API allows a user to create and send an invitation to another subscriber.\n\n Scopes:\nau_pub_cert_pexa_invitation_api_v2_write (non-prod)\nau_pub_pexa_invitation_api_v2_write (prod)",
"operationId": "createInvitationUsingPOST",
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "workspaceInvitationRequest",
"description": "workspaceInvitationRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateWorkspaceInvitationResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/settlement": {
"get": {
"tags": [
"Settlement"
],
"summary": "Retrieves Settlement Availability",
"description": "This API provides a list of settlement times for a given date.\n\n Scopes:\nau_pub_cert_pexa_settlement_api_v2_read (non-prod)\nau_pub_pexa_settlement_api_v2_read (prod)",
"operationId": "settlementAvailability",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "jurisdiction",
"in": "query",
"description": "Used if wanting to find out the available settlement times prior to creating a workspace in a certain jurisdiction.
This must not be provided if workspaceId is provided.
If workspaceId is not provided, this field is mandatory.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "settlementDate",
"in": "query",
"description": "All available times will be retrieved for the settlement date provided.",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "subscriberId",
"in": "query",
"description": "The PEXA internal reference for the subscriber initiating the API service call.
Maximum 19 characters",
"required": false,
"type": "string",
"allowEmptyValue": false
},
{
"name": "workspaceId",
"in": "query",
"description": "PEXA workspace number.
Used if wanting to find out the available settlement times for an existing created workspace.
This must not be provided if jurisdiction is also provided.
If jurisdiction is not provided, this field is mandatory.
Maximum 13 characters",
"required": false,
"type": "string",
"allowEmptyValue": false
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementAvailabilityResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"put": {
"tags": [
"Settlement"
],
"summary": "Maintain Settlement Date and Time",
"description": "This API allows you to manage the settlement date and time within a workspace.\n\n Scopes:\nau_pub_cert_pexa_settlement_api_v2_write (non-prod)\nau_pub_pexa_settlement_api_v2_write (prod)",
"operationId": "maintainsettlement_1",
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/settlementCompletionRecord": {
"get": {
"tags": [
"Settlement"
],
"summary": "Generate the Settlement Completion Record",
"description": "This API generates the settlement completion record for a completed workspace.\n\n \n [See details](../../docs/definitions/retrieve_settlement_completion_record/) to learn more about this API.\n\n Scopes:\nau_pub_cert_pexa_settlementcompletionrecord_api_v2_read (non-prod)\nau_pub_pexa_settlementcompletionrecord_api_v2_read (prod)",
"operationId": "retrieveSettlementCompletionRecordV1UsingGET",
"produces": [
"application/xml",
"application/pdf",
"application/json"
],
"parameters": [
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "subscriberRole",
"in": "query",
"description": "subscriberRole",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "query",
"description": "workspaceId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "string",
"format": "byte"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/{workspaceId}/conversations": {
"get": {
"tags": [
"Conversation"
],
"summary": "Retrieve Conversations List for a Workspace",
"description": "This API retrieves a list of conversations for a specific workspace.\n\n Scopes:\nau_pub_cert_pexa_conversation_api_v2_read (non-prod)\nau_pub_pexa_conversation_api_v2_read (prod)",
"operationId": "retrieveConversationsListUsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "role",
"in": "query",
"description": "role",
"required": false,
"type": "string"
},
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "path",
"description": "workspaceId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.ConversationsRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v2/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement": {
"get": {
"tags": [
"Settlement"
],
"summary": "Retrieve Balance due to effect Settlement",
"description": "This API allows you to retrieve the balance amount due to the vendor that is likely to effect the settlement. \n\n Scopes:\nau_pub_cert_pexa_settlement_api_v2_read (non-prod)\nau_pub_pexa_settlement_api_v2_read (prod)",
"operationId": "getBalanceDueToEffectSettlementUsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "role",
"in": "query",
"description": "role",
"required": true,
"type": "string"
},
{
"name": "workspaceId",
"in": "path",
"description": "workspaceId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"put": {
"tags": [
"Settlement"
],
"summary": "Add/Update/Agree Balance due to effect Settlement",
"description": "This API allows you to set the balance amount due to the vendor that is likely to effect the settlement. \n\n \n[See details](../../docs/definitions/set_balanceduetoeffect_settlement/) to learn more about this API.\n\n Scopes:\nau_pub_cert_pexa_settlement_api_v2_write (non-prod)\nau_pub_pexa_settlement_api_v2_write (prod)",
"operationId": "updateBalanceDueToEffectSettlementUsingPUT",
"consumes": [
"application/xml"
],
"produces": [
"application/xml"
],
"parameters": [
{
"in": "body",
"name": "balanceDueToEffectSettlementRequest",
"description": "balanceDueToEffectSettlementRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest"
}
},
{
"name": "role",
"in": "query",
"description": "role",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "path",
"description": "workspaceId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v4/subscriber": {
"get": {
"tags": [
"Subscriber"
],
"summary": "Search Subscriber",
"description": "The Subscriber API gives you the ability to search for active subscribers registered in PEXA.\n\n Scopes:\nau_pub_cert_pexa_subscriber_api_v4_read (non-prod)\nau_pub_pexa_subscriber_api_v4_read (prod)",
"operationId": "subscribersearch",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "searchSubscriberId",
"in": "query",
"description": "Subscriber's internal PEXA identifier \nThis must not be provided if subscriberName is also provided. \nIf subscriberName is not provided, this field is mandatory. \nMaximum 19 characters",
"required": true,
"type": "string",
"allowEmptyValue": false,
"x-example": "208"
},
{
"name": "subscriberName",
"in": "query",
"description": "Subscriber organisation name \nThis must not be provided if searchSubscriberId is provided. \nIf searchSubscriberId is not provided, this field is mandatory. \nMust be at least 3 characters \nMaximum 255 characters",
"required": true,
"type": "string",
"allowEmptyValue": false,
"x-example": "XYZ Bank"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.SubscriberSearchResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v4/subscriber/notifications": {
"get": {
"tags": [
"Subscriber"
],
"summary": "Retrieves Notifications",
"description": "This API retrieves a list of notifications a subscriber can access. \n \n\n[See details](../../docs/definitions/retrieve_notifications/) to learn more about this API.\n\n Scopes:\nau_pub_cert_pexa_subscriber_api_v4_read (non-prod)\nau_pub_pexa_subscriber_api_v4_read (prod)",
"operationId": "retrieveNotificationsV2UsingGET",
"produces": [
"application/xml"
],
"parameters": [
{
"name": "categoryList",
"in": "query",
"description": "The notification category the results will return. Each value must be separated with a comma (,) with no spaces. \nIf not provided, PEXA will return all notification category types.",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "Document"
},
{
"name": "lastEventId",
"in": "query",
"description": "The PEXA internal reference for the event. This value must match the last Event Id which was provided in the previous notification response from PEXA. \nNote: If a Last Event Id has yet to be obtained, the value must be 0. \nIf the Last Event ID value does not correspond to the Last Event Timestamp recorded in PEXA, an exception will be returned. \nMaximum 19 characters. ",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "1213"
},
{
"name": "lastEventTimestamp",
"in": "query",
"description": "The timestamp of the last event previously retrieved which the results will be filtered from (in UTC). \nNote: The Last Event Timestamp is used in conjunction with the Last Event ID for retrieving notifications. \nThe Last Event Timestamp value in the request should match the Last Event Timestamp value which was provided in the previous notification response from PEXA. \nIf the Last Event Timestamp value does not correspond to the Last Event Id recorded in PEXA, an exception will be returned. ",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "2018-11-18T02:30:20.283Z"
},
{
"name": "maxRecords",
"in": "query",
"description": "Used to specify the maximum number of notification records to be returned in a single service call. \nPEXA will set an internal threshold for a maximum number of records to be returned. \nIf the PEXA threshold is less than the max number of records provided, PEXA will return its threshold number of records (with the More Data flag set to indicate there are more notification records where applicable). \nIf no value is provided, the PEXA threshold will be used as the default number for notification records to be received. If a value is provided, it must be greater than 0. ",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "2"
},
{
"name": "severity",
"in": "query",
"description": "The notification severity the results will return. \nIf not provided, PEXA will return all notification severity types.",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "Error"
},
{
"name": "subscriberId",
"in": "query",
"description": "The PEXA internal reference for the subscriber. <br> Maximum 19 characters",
"required": false,
"type": "string",
"allowEmptyValue": false,
"x-example": "208"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.RetrieveNotificationsResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v5/workspace": {
"get": {
"tags": [
"Workspace"
],
"summary": "Retrieves workspace summary",
"description": "This API provides a summary of the workspace details.\n\n Scopes:\nau_pub_cert_pexa_workspace_api_v5_read (non-prod)\nau_pub_pexa_workspace_api_v5_read (prod)",
"operationId": "retrieveWorkspaceSummaryV2UsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "lastEventId",
"in": "query",
"description": "lastEventId",
"required": false,
"type": "string"
},
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "subscriberRole",
"in": "query",
"description": "subscriberRole",
"required": false,
"type": "string"
},
{
"name": "subset",
"in": "query",
"description": "subset",
"required": false,
"type": "string"
},
{
"name": "workspaceId",
"in": "query",
"description": "workspaceId",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
},
"post": {
"tags": [
"Workspace"
],
"summary": "Initiate Workspace Creation",
"description": "This API allows a user to create a new workspace.\n\n Scopes:\nau_pub_cert_pexa_workspace_api_v5_write (non-prod)\nau_pub_pexa_workspace_api_v5_write (prod)",
"operationId": "workspacecreation",
"consumes": [
"application/xml",
"application/json",
"application/json;charset=UTF-8"
],
"produces": [
"application/xml",
"application/json",
"application/json;charset=UTF-8"
],
"parameters": [
{
"in": "body",
"name": "workspaceCreationRequest",
"description": "workspaceCreationRequest",
"required": true,
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationRequest"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationResponse"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
},
"/v6/subscriber/workspaces": {
"get": {
"tags": [
"Workspace"
],
"summary": "Retrieve workspaces",
"description": "This API retrieves a list of the workspaces that a user can access. \n\n \n[See details](../../docs/definitions/retrieve_workspaces/) to learn more about this API.\n\n Scopes:\nau_pub_cert_pexa_workspace_api_v6_read (non-prod)\nau_pub_pexa_workspace_api_v6_read (prod)",
"operationId": "retrieveWorkspacesV3UsingGET",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"name": "jurisdiction",
"in": "query",
"description": "jurisdiction",
"required": false,
"type": "string"
},
{
"name": "settlementDateTime",
"in": "query",
"description": "settlementDateTime",
"required": false,
"type": "string"
},
{
"name": "subscriberId",
"in": "query",
"description": "subscriberId",
"required": false,
"type": "string"
},
{
"name": "workgroupId",
"in": "query",
"description": "workgroupId",
"required": false,
"type": "string"
},
{
"name": "workspaceLastActivityFrom",
"in": "query",
"description": "workspaceLastActivityFrom",
"required": false,
"type": "string"
},
{
"name": "workspaceRole",
"in": "query",
"description": "workspaceRole",
"required": false,
"type": "string"
},
{
"name": "workspaceStatus",
"in": "query",
"description": "workspaceStatus",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/au.net.pexa.api.schema._3.WorkspaceRetrievalResponse"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
}
},
"definitions": {
"au.net.pexa.api.schema._1.Address1OverseasAddress1AddressLineDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.Address1OverseasAddress1AddressLineDetailsType",
"xml": {
"name": "address1OverseasAddress1AddressLineDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1OverseasAddressDetailsType": {
"type": "object",
"properties": {
"addressLines": {
"type": "array",
"xml": {
"name": "AddressLine",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1OverseasAddress1AddressLineDetailsType"
}
},
"countryCode": {
"type": "string",
"xml": {
"name": "CountryCode",
"attribute": false,
"wrapped": false
}
},
"postalCode": {
"type": "string",
"xml": {
"name": "PostalCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address1OverseasAddressDetailsType",
"xml": {
"name": "address1OverseasAddressDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumbers": {
"type": "array",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadNumberType"
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadDetailsType",
"xml": {
"name": "address1StreetAddressComplexRoadDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadNumberType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadNumberType",
"xml": {
"name": "address1StreetAddressComplexRoadNumberType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressDetailsType": {
"type": "object",
"properties": {
"addressSiteName": {
"type": "string",
"xml": {
"name": "AddressSiteName",
"attribute": false,
"wrapped": false
}
},
"complexRoads": {
"type": "array",
"xml": {
"name": "ComplexRoad",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressComplexRoadDetailsType"
}
},
"level": {
"xml": {
"name": "Level",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressLevelDetailsType"
},
"localityName": {
"type": "string",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"postcode": {
"type": "string",
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressRoadDetailsType"
},
"secondaryComplex": {
"type": "string",
"xml": {
"name": "SecondaryComplex",
"attribute": false,
"wrapped": false
}
},
"state": {
"type": "string",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
},
"subDwellingUnitType": {
"xml": {
"name": "SubDwellingUnitType",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressSubDwellingUnitTypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressDetailsType",
"xml": {
"name": "address1StreetAddressDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressLevelDetailsType": {
"type": "object",
"properties": {
"levelNumber": {
"type": "string",
"xml": {
"name": "LevelNumber",
"attribute": false,
"wrapped": false
}
},
"levelTypeCode": {
"type": "string",
"xml": {
"name": "LevelTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressLevelDetailsType",
"xml": {
"name": "address1StreetAddressLevelDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressRoadDetailsType": {
"type": "object",
"properties": {
"lotNumber": {
"type": "string",
"xml": {
"name": "LotNumber",
"attribute": false,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumber": {
"type": "string",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressRoadDetailsType",
"xml": {
"name": "address1StreetAddressRoadDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1StreetAddressSubDwellingUnitTypeDetailsType": {
"type": "object",
"properties": {
"unitNumber": {
"type": "string",
"xml": {
"name": "UnitNumber",
"attribute": false,
"wrapped": false
}
},
"unitTypeCode": {
"type": "string",
"xml": {
"name": "UnitTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address1StreetAddressSubDwellingUnitTypeDetailsType",
"xml": {
"name": "address1StreetAddressSubDwellingUnitTypeDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address1Type": {
"type": "object",
"properties": {
"overseasAddress": {
"xml": {
"name": "OverseasAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1OverseasAddressDetailsType"
},
"streetAddress": {
"xml": {
"name": "StreetAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1StreetAddressDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.Address1Type",
"xml": {
"name": "address1Type",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.Address2CorrespondenceAddressDetailsType": {
"type": "object",
"properties": {
"localityName": {
"type": "string",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"postalDelivery": {
"xml": {
"name": "PostalDelivery",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2PostalDeliveryDetailsType"
},
"postcode": {
"type": "string",
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressRoadDetailsType"
},
"state": {
"type": "string",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2CorrespondenceAddressDetailsType"
},
"au.net.pexa.api.schema._1.Address2OverseasAddressAddressLineDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.Address2OverseasAddressAddressLineDetailsType"
},
"au.net.pexa.api.schema._1.Address2OverseasAddressDetailsType": {
"type": "object",
"properties": {
"addressLines": {
"type": "array",
"xml": {
"name": "AddressLine",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2OverseasAddressAddressLineDetailsType"
}
},
"countryCode": {
"type": "string",
"xml": {
"name": "CountryCode",
"attribute": false,
"wrapped": false
}
},
"postalCode": {
"type": "string",
"xml": {
"name": "PostalCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2OverseasAddressDetailsType"
},
"au.net.pexa.api.schema._1.Address2PostalDeliveryDetailsType": {
"type": "object",
"properties": {
"postalDeliveryNumber": {
"type": "string",
"xml": {
"name": "PostalDeliveryNumber",
"attribute": false,
"wrapped": false
}
},
"postalDeliveryTypeCode": {
"type": "string",
"xml": {
"name": "PostalDeliveryTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2PostalDeliveryDetailsType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumbers": {
"type": "array",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadNumberType"
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadDetailsType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadNumberType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadNumberType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressDetailsType": {
"type": "object",
"properties": {
"addressSiteName": {
"type": "string",
"xml": {
"name": "AddressSiteName",
"attribute": false,
"wrapped": false
}
},
"complexRoads": {
"type": "array",
"xml": {
"name": "ComplexRoad",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressComplexRoadDetailsType"
}
},
"level": {
"xml": {
"name": "Level",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressLevelDetailsType"
},
"localityName": {
"type": "string",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"postcode": {
"type": "string",
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressRoadDetailsType"
},
"secondaryComplex": {
"type": "string",
"xml": {
"name": "SecondaryComplex",
"attribute": false,
"wrapped": false
}
},
"state": {
"type": "string",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
},
"subDwellingUnitType": {
"xml": {
"name": "SubDwellingUnitType",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressSubDwellingUnitTypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressDetailsType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressLevelDetailsType": {
"type": "object",
"properties": {
"levelNumber": {
"type": "string",
"xml": {
"name": "LevelNumber",
"attribute": false,
"wrapped": false
}
},
"levelTypeCode": {
"type": "string",
"xml": {
"name": "LevelTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressLevelDetailsType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressRoadDetailsType": {
"type": "object",
"properties": {
"lotNumber": {
"type": "string",
"xml": {
"name": "LotNumber",
"attribute": false,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumber": {
"type": "string",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressRoadDetailsType"
},
"au.net.pexa.api.schema._1.Address2StreetAddressSubDwellingUnitTypeDetailsType": {
"type": "object",
"properties": {
"unitNumber": {
"type": "string",
"xml": {
"name": "UnitNumber",
"attribute": false,
"wrapped": false
}
},
"unitTypeCode": {
"type": "string",
"xml": {
"name": "UnitTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.Address2StreetAddressSubDwellingUnitTypeDetailsType"
},
"au.net.pexa.api.schema._1.Address2Type": {
"type": "object",
"properties": {
"correspondenceAddress": {
"xml": {
"name": "CorrespondenceAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2CorrespondenceAddressDetailsType"
},
"overseasAddress": {
"xml": {
"name": "OverseasAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2OverseasAddressDetailsType"
},
"streetAddress": {
"xml": {
"name": "StreetAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2StreetAddressDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.Address2Type"
},
"au.net.pexa.api.schema._1.AdministrationStatusDetailsType": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.AdministrationStatusDetailsType",
"xml": {
"name": "AdministrationStatus",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.AreaOfLandDetailType": {
"type": "object",
"properties": {
"area": {
"type": "number",
"xml": {
"name": "Area",
"attribute": false,
"wrapped": false
}
},
"measurement": {
"type": "string",
"xml": {
"name": "Measurement",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.AreaOfLandDetailType",
"xml": {
"name": "areaOfLandDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.AvailableSettlementTimeType": {
"type": "object",
"properties": {
"times": {
"type": "array",
"xml": {
"name": "Time",
"attribute": false,
"wrapped": false
},
"description": "Available settlement time (in UTC) for the date provided.
If Settlement Availability is No, then this will not be provided.
Result set will be ordered by time ascending.",
"items": {
"type": "string",
"format": "date-time"
}
}
},
"title": "au.net.pexa.api.schema._1.AvailableSettlementTimeType",
"xml": {
"name": "availableSettlementTimeType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"xml": {
"name": "Amount",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest",
"xml": {
"name": "BalanceDueToEffectSettlementRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"xml": {
"name": "Amount",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse",
"xml": {
"name": "BalanceDueToEffectSettlementResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.BusinessType": {
"type": "object",
"properties": {
"administrationStatuses": {
"type": "array",
"xml": {
"name": "AdministrationStatus",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.AdministrationStatusDetailsType"
}
},
"businessName": {
"type": "string",
"xml": {
"name": "BusinessName",
"attribute": false,
"wrapped": false
}
},
"businessUnit": {
"type": "string",
"xml": {
"name": "BusinessUnit",
"attribute": false,
"wrapped": false
}
},
"identifications": {
"type": "array",
"xml": {
"name": "Identification",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.IdentificationDetailsType"
}
},
"legalEntityName": {
"type": "string",
"xml": {
"name": "LegalEntityName",
"attribute": false,
"wrapped": false
}
},
"organisationType": {
"type": "string",
"xml": {
"name": "OrganisationType",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.BusinessType",
"xml": {
"name": "BusinessDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.ConstructionTypeDetailType": {
"type": "object",
"properties": {
"key": {
"type": "string",
"xml": {
"name": "Key",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ConstructionTypeDetailType",
"xml": {
"name": "constructionTypeDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.ConversationType": {
"type": "object",
"properties": {
"category": {
"type": "string",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
}
},
"conversationId": {
"type": "string",
"xml": {
"name": "ConversationId",
"attribute": false,
"wrapped": false
}
},
"fromSubscriber": {
"type": "string",
"xml": {
"name": "FromSubscriber",
"attribute": false,
"wrapped": false
}
},
"fromSubscriberId": {
"type": "string",
"xml": {
"name": "FromSubscriberId",
"attribute": false,
"wrapped": false
}
},
"highPriority": {
"type": "string",
"xml": {
"name": "HighPriority",
"attribute": false,
"wrapped": false
}
},
"messages": {
"xml": {
"name": "Messages",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.MessagesType"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subCategory": {
"type": "string",
"xml": {
"name": "SubCategory",
"attribute": false,
"wrapped": false
}
},
"subject": {
"type": "string",
"xml": {
"name": "Subject",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
},
"transactionType": {
"type": "string",
"xml": {
"name": "TransactionType",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ConversationType"
},
"au.net.pexa.api.schema._1.ConversationsRetrievalResponse": {
"type": "object",
"properties": {
"conversations": {
"xml": {
"name": "Conversations",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.ConversationsType"
}
},
"title": "au.net.pexa.api.schema._1.ConversationsRetrievalResponse"
},
"au.net.pexa.api.schema._1.ConversationsType": {
"type": "object",
"properties": {
"conversations": {
"type": "array",
"xml": {
"name": "Conversation",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.ConversationType"
}
}
},
"title": "au.net.pexa.api.schema._1.ConversationsType"
},
"au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest": {
"type": "object",
"properties": {
"mortgageDetails": {
"xml": {
"name": "MortgageDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest.MortgageDetails"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subscriberId": {
"type": "string",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest",
"xml": {
"name": "CreateDischargeOfMortgageRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest.MortgageDetails": {
"type": "object",
"properties": {
"mortgageNumbers": {
"type": "array",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.CreateDischargeOfMortgageRequest.MortgageDetails",
"xml": {
"name": "MortgageDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateDischargeOfMortgageResponse": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CreateDischargeOfMortgageResponse",
"xml": {
"name": "CreateDischargeOfMortgageResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateMessageRequest": {
"type": "object",
"properties": {
"actionRequired": {
"type": "string",
"xml": {
"name": "ActionRequired",
"attribute": false,
"wrapped": false
}
},
"message": {
"type": "string",
"xml": {
"name": "Message",
"attribute": false,
"wrapped": false
}
},
"subscriberId": {
"type": "string",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CreateMessageRequest",
"xml": {
"name": "CreateMessageRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateMessageResponse": {
"type": "object",
"properties": {
"message": {
"xml": {
"name": "Message",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.MessageType"
}
},
"title": "au.net.pexa.api.schema._1.CreateMessageResponse",
"xml": {
"name": "CreateMessageResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"description": "Subscriber id of the subscriber sending the invitation",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
},
"participantDetails": {
"xml": {
"name": "ParticipantDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.ParticipantDetailsDetailType"
},
"participantRole": {
"type": "string",
"xml": {
"name": "ParticipantRole",
"attribute": false,
"wrapped": false
}
},
"borrowersMortgagorsNames": {
"type": "string",
"description": "Borrowers/Mortgagors Names. Only applicable if the invitee role is Incoming Mortgagee (IM) or Source Funder (SF). The field is optional.",
"xml": {
"name": "BorrowersMortgagorsNames",
"attribute": false,
"wrapped": false
}
},
"customerAccountLoanNumber": {
"type": "string",
"description": "Customer/Loan Account Number. Only applicable if the invitee role is Incoming Mortgagee (IM), Mortgagee On Title (MOT), Source Funder (SF) or CT Controller (CT). The field is optional.",
"xml": {
"name": "CustomerAccountLoanNumber",
"attribute": false,
"wrapped": false
}
},
"notes": {
"type": "string",
"xml": {
"name": "Notes",
"attribute": false,
"wrapped": false
}
},
"partyDetails": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails"
}
},
"title": "au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest",
"xml": {
"name": "CreateWorkspaceInvitationRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.RespondInvitationRequest.ForwardedParticipantDetails": {
"type": "object",
"description": "Participant details of the subscriber that is being forwarded the invitation. Mandatory if invitation response is 'Forward to another Subscriber' or 'Forward to Panel Member'",
"properties": {
"subscriberId": {
"type": "string",
"description": "Subscriber id of the subscriber that is being forwarded the invitation. Mandatory if invitation response is 'Forward to another Subscriber' or 'Forward to Panel Member'",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"notes": {
"type": "string",
"description": "Notes/comments that can be provided to the participant receiving the forwarded invitation. Only applicable if invitation response is 'Forward to another Subscriber'. Field is optional",
"xml": {
"name": "Notes",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.RespondInvitationRequest.ForwardedParticipantDetails",
"xml": {
"name": "ForwardedParticipantDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateWorkspaceInvitationResponse": {
"type": "object",
"properties": {
"inviteId": {
"type": "string",
"xml": {
"name": "InviteId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CreateWorkspaceInvitationResponse",
"xml": {
"name": "CreateWorkspaceInvitationResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CurrentLandUseDetailType": {
"type": "object",
"properties": {
"commercial": {
"type": "string",
"xml": {
"name": "Commercial",
"attribute": false,
"wrapped": false
}
},
"dwelling": {
"type": "string",
"xml": {
"name": "Dwelling",
"attribute": false,
"wrapped": false
}
},
"farming": {
"type": "string",
"xml": {
"name": "Farming",
"attribute": false,
"wrapped": false
}
},
"flats": {
"type": "string",
"xml": {
"name": "Flats",
"attribute": false,
"wrapped": false
}
},
"guestHousePrivateHotel": {
"type": "string",
"xml": {
"name": "GuestHousePrivateHotel",
"attribute": false,
"wrapped": false
}
},
"industrial": {
"type": "string",
"xml": {
"name": "Industrial",
"attribute": false,
"wrapped": false
}
},
"multiUnit": {
"type": "string",
"xml": {
"name": "MultiUnit",
"attribute": false,
"wrapped": false
}
},
"other": {
"type": "string",
"xml": {
"name": "Other",
"attribute": false,
"wrapped": false
}
},
"vacantLandUse": {
"type": "string",
"xml": {
"name": "VacantLandUse",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CurrentLandUseDetailType",
"xml": {
"name": "currentLandUseDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.DocumentDetailsType": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
},
"documentStatus": {
"type": "string",
"xml": {
"name": "DocumentStatus",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"landTitleReferences": {
"type": "array",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
},
"lastModified": {
"type": "string",
"format": "date-time",
"xml": {
"name": "LastModified",
"attribute": false,
"wrapped": false
}
},
"lodgement": {
"xml": {
"name": "Lodgement",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.LodgementDetailsType"
},
"lodgementVerification": {
"xml": {
"name": "LodgementVerification",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.LodgementVerificationDetailsType"
},
"relatedDocumentId": {
"type": "string",
"xml": {
"name": "RelatedDocumentId",
"attribute": false,
"wrapped": false
}
},
"signaturesReceived": {
"type": "integer",
"xml": {
"name": "SignaturesReceived",
"attribute": false,
"wrapped": false
}
},
"signaturesRequired": {
"type": "integer",
"xml": {
"name": "SignaturesRequired",
"attribute": false,
"wrapped": false
}
},
"stampDuty": {
"xml": {
"name": "StampDuty",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.StampDutyDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.DocumentDetailsType",
"xml": {
"name": "documentDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.DutyDataDetailType": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
},
"revenueOfficeTransactionId": {
"type": "string",
"xml": {
"name": "RevenueOfficeTransactionId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.DutyDataDetailType",
"xml": {
"name": "dutyDataDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.EventDetailsType": {
"type": "object",
"properties": {
"category": {
"type": "string",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
}
},
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"detail": {
"type": "string",
"xml": {
"name": "Detail",
"attribute": false,
"wrapped": false
}
},
"eventId": {
"type": "string",
"xml": {
"name": "EventId",
"attribute": false,
"wrapped": false
}
},
"severity": {
"type": "string",
"xml": {
"name": "Severity",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.EventDetailsType",
"xml": {
"name": "eventDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.FeeItemDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"gstAmount": {
"type": "number",
"xml": {
"name": "GstAmount",
"attribute": false,
"wrapped": false
}
},
"netAmount": {
"type": "number",
"xml": {
"name": "NetAmount",
"attribute": false,
"wrapped": false
}
},
"signingSubscriber": {
"xml": {
"name": "SigningSubscriber",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SigningSubscriberDetailsType"
},
"totalAmount": {
"type": "number",
"xml": {
"name": "TotalAmount",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.FeeItemDetailsType",
"xml": {
"name": "feeItemDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.ForeignCountryShareDetailsType": {
"type": "object",
"properties": {
"foreignPercent": {
"type": "number",
"xml": {
"name": "ForeignPercent",
"attribute": false,
"wrapped": false
}
},
"foreignShareholderCountry": {
"type": "string",
"xml": {
"name": "ForeignShareholderCountry",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ForeignCountryShareDetailsType",
"xml": {
"name": "ForeignCountryShare",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.ForeignPartyDetailsType": {
"type": "object",
"properties": {
"foreignCountry": {
"type": "string",
"xml": {
"name": "ForeignCountry",
"attribute": false,
"wrapped": false
}
},
"foreignCountryShares": {
"type": "array",
"xml": {
"name": "ForeignCountryShare",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.ForeignCountryShareDetailsType"
}
},
"foreignPartyIndicator": {
"type": "string",
"xml": {
"name": "ForeignPartyIndicator",
"attribute": false,
"wrapped": false
}
},
"foreignPartyType": {
"type": "string",
"xml": {
"name": "ForeignPartyType",
"attribute": false,
"wrapped": false
}
},
"residentPartyIndicator": {
"type": "string",
"xml": {
"name": "ResidentPartyIndicator",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ForeignPartyDetailsType",
"xml": {
"name": "foreignPartyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.FullNameType": {
"type": "object",
"properties": {
"dateOfBirth": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateOfBirth",
"attribute": false,
"wrapped": false
}
},
"familyName": {
"type": "string",
"xml": {
"name": "FamilyName",
"attribute": false,
"wrapped": false
}
},
"familyNameOrder": {
"type": "string",
"xml": {
"name": "FamilyNameOrder",
"attribute": false,
"wrapped": false
}
},
"givenNames": {
"type": "array",
"xml": {
"name": "GivenName",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.GivenNameOrderType"
}
},
"nameSuffix": {
"type": "string",
"xml": {
"name": "NameSuffix",
"attribute": false,
"wrapped": false
}
},
"nameTitle": {
"type": "string",
"xml": {
"name": "NameTitle",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.FullNameType",
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.GivenNameOrderType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._1.GivenNameOrderType",
"xml": {
"name": "GivenName",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.IdentificationDetailsType": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"xml": {
"name": "Identifier",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.IdentificationDetailsType",
"xml": {
"name": "Identification",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse": {
"type": "object",
"properties": {
"moreData": {
"type": "string",
"xml": {
"name": "MoreData",
"attribute": false,
"wrapped": false
}
},
"invites": {
"type": "array",
"xml": {
"name": "Invite",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse",
"xml": {
"name": "InvitationRetrievalResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite": {
"type": "object",
"description": "Invite id",
"properties": {
"inviteId": {
"type": "string",
"xml": {
"name": "InviteId",
"attribute": false,
"wrapped": false
}
},
"forwardedBy": {
"type": "string",
"description": "The subscriber that forwarded the invitation. Only supplied if invite was forwarded by the panel master to the panel member.",
"xml": {
"name": "ForwardedBy",
"attribute": false,
"wrapped": false
}
},
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
},
"jurisdiction": {
"type": "string",
"description":"Jurisdiction of the workspace. Valid values are 'NSW', 'VIC', 'WA', 'QLD', 'SA', 'TAS', 'ACT', 'NT' and 'AUST'.",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
}
},
"transactionType": {
"type": "string",
"description":"Transaction type of the workspace. Valid values are 'TRANSFER' and 'NON_TRANSFER'.",
"xml": {
"name": "TransactionType",
"attribute": false,
"wrapped": false
}
},
"workspaceRole": {
"type": "string",
"xml": {
"name": "WorkspaceRole",
"attribute": false,
"wrapped": false
}
},
"settlementDate": {
"type": "string",
"format": "date-time",
"description":"Settlement date and time of the workspace. Format is UTC date/time.",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
}
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails"
},
"borrowersMortgagorsNames": {
"type": "string",
"description": "Borrowers/Mortgagors Names supplied by the invitor. Only returned if supplied. Only returned if the invitee role is Incoming Mortgagee (IM) or Source Funder (SF).",
"xml": {
"name": "BorrowersMortgagorsNames",
"attribute": false,
"wrapped": false
}
},
"customerAccountLoanNumber": {
"type": "string",
"description": "Customer/Loan Account Number supplied by the invitor. Only returned if supplied. Only returned if the invitee role is Incoming Mortgagee (IM), Mortgagee On Title (MOT), Source Funder (SF) or CT Controller (CT).",
"xml": {
"name": "CustomerAccountLoanNumber",
"attribute": false,
"wrapped": false
}
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails"
},
"inviterSubscriberName": {
"type": "string",
"xml": {
"name": "InviterSubscriberName",
"attribute": false,
"wrapped": false
}
},
"notes": {
"type": "string",
"xml": {
"name": "Notes",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite",
"xml": {
"name": "Invite",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"propertyDetails": {
"type": "string",
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
}
},
"proprietorDetails": {
"xml": {
"name": "ProprietorDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails"
},
"mortgageDetails": {
"xml": {
"name": "MortgageDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails"
},
"caveatDetails": {
"xml": {
"name": "CaveatDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails"
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails": {
"type": "object",
"properties": {
"party": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails.Party"
}
},
"title": "au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails.Party": {
"type": "object",
"properties": {
"fullName": {
"type": "string",
"description": "The client names or party represented names that is associated to the invitation. Can be optionally provided if subscriber being invited (invitee) is in the role of Caveator on Title, Proprietor on Title, Incoming Proprietor, To Deal with An Interest or CT Controller.",
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.CreateWorkspaceInvitationRequest.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails.Party"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails.Party": {
"type": "object",
"properties": {
"fullName": {
"type": "string",
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
}
},
"organisationName": {
"type": "string",
"xml": {
"name": "OrganisationName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails": {
"type": "object",
"description": "Proprietor details of the associated land title. Only returned if workspace role of the invitee is Incoming Proprietor (IP) and Mortgagee On Title (MOT).",
"properties": {
"proprietors": {
"type": "array",
"xml": {
"name": "Proprietor",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails.Proprietor"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails",
"xml": {
"name": "ProprietorDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails.Proprietor": {
"type": "object",
"description": "Proprietor name",
"properties": {
"proprietorName": {
"type": "string",
"xml": {
"name": "ProprietorName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.ProprietorDetails.Proprietor",
"xml": {
"name": "Proprietor",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails": {
"type": "object",
"description": "Registered mortgages on the associated land title. Only returned if the workspace role of the invitee is Mortgagee On Title (MOT).",
"properties": {
"mortgages": {
"type": "array",
"xml": {
"name": "Mortgage",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails.Mortgage"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails",
"xml": {
"name": "MortgageDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails.Mortgage": {
"type": "object",
"description": "Registered mortgage dealing number",
"properties": {
"dealingNumber": {
"type": "string",
"xml": {
"name": "DealingNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.MortgageDetails.Mortgage",
"xml": {
"name": "Mortgage",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails": {
"type": "object",
"description": "Registered caveats on the associated land title. Only returned if the workspace role of the invitee is Caveator On Title (COT).",
"properties": {
"caveats": {
"type": "array",
"xml": {
"name": "Caveat",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails.Caveat"
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails",
"xml": {
"name": "CaveatDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails.Caveat": {
"type": "object",
"description": "Registered caveat dealing number",
"properties": {
"dealingNumber": {
"type": "string",
"xml": {
"name": "DealingNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle.CaveatDetails.Caveat",
"xml": {
"name": "Caveat",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse": {
"type": "object",
"properties": {
"landTitleReferenceReport": {
"xml": {
"name": "LandTitleReferenceReport",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.LandTitleReferenceReport"
},
"warnings": {
"xml": {
"name": "Warnings",
"attribute": false,
"wrapped": false
},
"description": "Returned if there are other public workspaces or another private workspace where the same subscriber is a participant of is utilising the same land title reference",
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings"
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse",
"xml": {
"name": "LandTitleReferenceVerificationResponse",
"namespace": "http://api.pexa.net.au/schema/1/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.LandTitleReferenceReport": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"example": "12345/987",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
},
"description": "Land title reference sent in request"
},
"newLandTitleReference": {
"type": "string",
"example": "98745/987",
"xml": {
"name": "NewLandTitleReference",
"attribute": false,
"wrapped": false
},
"description": "Returned when the land title reference sent as part of request is obsolete. The new land title should be used going forward and must be re-verified."
},
"propertyDetails": {
"type": "string",
"example": "98 LITTLE CLEVELAND Street NSW 7894",
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
},
"description": "Maximum 300 characters
Returns the property address if available else returns a land description. If both unavailable then this element will not be sent back."
},
"electronicLodgement": {
"type": "string",
"example": "Yes",
"xml": {
"name": "ElectronicLodgement",
"attribute": false,
"wrapped": false
},
"description": "Suitability for electronic lodgement"
},
"notes": {
"type": "array",
"example": "Example Note",
"xml": {
"name": "Note",
"attribute": false,
"wrapped": false
},
"description": "Maximum 300 characters
Note from land registry which may include unsuitability reason or warnings regarding the land title reference.",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.LandTitleReferenceReport",
"xml": {
"name": "LandTitleReferenceReport",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings": {
"type": "object",
"properties": {
"workspaces": {
"type": "array",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace"
}
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings",
"xml": {
"name": "Warnings",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"example": "PEXA1900800789",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
},
"description": "PEXA workspace number. Maximum 13 characters"
},
"participantsList": {
"xml": {
"name": "ParticipantsList",
"attribute": false,
"wrapped": false
},
"description": "List of participants currently active in the workspace",
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList"
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList": {
"type": "object",
"properties": {
"participants": {
"type": "array",
"xml": {
"name": "Participants",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList.Participants"
}
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList",
"xml": {
"name": "ParticipantsList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList.Participants": {
"type": "object",
"properties": {
"subscriberName": {
"type": "string",
"example": "XYZ Bank",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 255 characters
Subscriber organisation name"
},
"role": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
},
"description": "Participants role in the workspace"
},
"contactName": {
"type": "string",
"example": "XYZ Manager",
"xml": {
"name": "ContactName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 100 characters
Subscriber public contact name"
},
"email": {
"type": "string",
"example": "XYZ.Manager@bank.com.au",
"xml": {
"name": "Email",
"attribute": false,
"wrapped": false
},
"description": "Maximum 100 characters
Subscriber public contact email"
},
"phone": {
"type": "string",
"example": "0421869784",
"xml": {
"name": "Phone",
"attribute": false,
"wrapped": false
},
"description": "Maximum 100 characters
Subscriber public contact phone"
}
},
"title": "au.net.pexa.api.schema._1.LandTitleReferenceVerificationResponse.Warnings.Workspace.ParticipantsList.Participants",
"xml": {
"name": "Workgroup",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LodgementCaseDetailsType": {
"type": "object",
"properties": {
"documents": {
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.LodgementCaseDocumentDetailsType"
},
"lodgementCaseId": {
"type": "string",
"xml": {
"name": "LodgementCaseId",
"attribute": false,
"wrapped": false
}
},
"lodgementCaseStatus": {
"type": "string",
"xml": {
"name": "LodgementCaseStatus",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.LodgementCaseDetailsType",
"xml": {
"name": "lodgementCaseDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LodgementCaseDocumentDetailsType": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.DocumentDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.LodgementCaseDocumentDetailsType",
"xml": {
"name": "lodgementCaseDocumentDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LodgementDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"dealingNumber": {
"type": "string",
"xml": {
"name": "DealingNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.LodgementDetailsType",
"xml": {
"name": "lodgementDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.LodgementVerificationDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"verificationResult": {
"type": "string",
"xml": {
"name": "VerificationResult",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.LodgementVerificationDetailsType",
"xml": {
"name": "lodgementVerificationDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber initiating the API service call.
Maximum 19 characters"
},
"workspaceId": {
"type": "string",
"example": "PEXA190080044",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
},
"description": "PEXA workspace number.
Maximum 13 characters"
},
"role": {
"type": "string",
"example": "Incoming Proprietor",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
},
"description": "Valid values are dependent on the subscriber type.
If the subscriber is acting in multiple roles within the workspace, only one role must be provided.
Only the following roles can be provided to maintain settlement date and time within the workspace: - Incoming Mortgagee
- Mortgagee on Title
- Incoming Proprietor
- Proprietor on Title
- Incoming Caveator "
},
"settlementActionType": {
"type": "string",
"example": "Propose new date and time",
"xml": {
"name": "SettlementActionType",
"attribute": false,
"wrapped": false
},
"description": "Valid values are
- Accept (Accept the Settlement Date/Time which has been proposed)
- Reset to pending (Reset prior acceptance of settlement date and time to the status of Pending. )
- Propose new date and time(Propose a new Settlement date and time with a reason of change set) "
},
"settlementDateAndTime": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDateAndTime",
"attribute": false,
"wrapped": false
},
"description": "The settlement date/time is provided (in UTC) to ensure the participant settlement acceptance status is being set against the settlement date/time which is currently in the workspace.
If the settlement date/time provided here differs to that of the workspace, an error will be returned advising that the settlement details are misaligned.
Must be provided when the Settlement Action Type is 'Accepted' or 'Reset to pending'. Must not be provided when the Settlement Action Type is Propose new date and time."
},
"settlementDetails": {
"xml": {
"name": "SettlementDetails",
"attribute": false,
"wrapped": false
},
"description": "The settlement date and time details to set/propose in the workspace.
Must be provided if the Settlement Action Type is Propose new date and time.
Must not be provided if Settlement Action Type is Reset to pending or Accepted.",
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest",
"xml": {
"name": "MaintainSettlementDateAndTimeRequest",
"namespace": "http://api.pexa.net.au/schema/1/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.ManageTransferDutyRequest": {
"type": "object",
"properties": {
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subscriberId": {
"type": "string",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"transferDutyDetails": {
"xml": {
"name": "TransferDutyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TransferDutyDetailType"
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ManageTransferDutyRequest",
"xml": {
"name": "ManageTransferDutyRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.MessageType": {
"type": "object",
"properties": {
"actionRequired": {
"type": "string",
"xml": {
"name": "ActionRequired",
"attribute": false,
"wrapped": false
}
},
"actionRequiredComplete": {
"type": "string",
"xml": {
"name": "ActionRequiredComplete",
"attribute": false,
"wrapped": false
}
},
"firstName": {
"type": "string",
"xml": {
"name": "FirstName",
"attribute": false,
"wrapped": false
}
},
"lastName": {
"type": "string",
"xml": {
"name": "LastName",
"attribute": false,
"wrapped": false
}
},
"message": {
"type": "string",
"xml": {
"name": "Message",
"attribute": false,
"wrapped": false
}
},
"messageCreated": {
"type": "string",
"xml": {
"name": "MessageCreated",
"attribute": false,
"wrapped": false
}
},
"messageId": {
"type": "string",
"xml": {
"name": "MessageId",
"attribute": false,
"wrapped": false
}
},
"subscriberName": {
"type": "string",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
}
},
"unread": {
"type": "string",
"xml": {
"name": "Unread",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.MessageType",
"xml": {
"name": "messageType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.MessagesType": {
"type": "object",
"properties": {
"messages": {
"type": "array",
"xml": {
"name": "Message",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.MessageType"
}
}
},
"title": "au.net.pexa.api.schema._1.MessagesType"
},
"au.net.pexa.api.schema._1.ParticipantDetailsDetailType": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.ParticipantDetailsDetailType",
"xml": {
"name": "ParticipantDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.PartyCapacityDetailsType": {
"type": "object",
"properties": {
"partyCapacityDetail": {
"type": "string",
"xml": {
"name": "PartyCapacityDetail",
"attribute": false,
"wrapped": false
}
},
"partyCapacityType": {
"type": "string",
"xml": {
"name": "PartyCapacityType",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.PartyCapacityDetailsType",
"xml": {
"name": "partyCapacityDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.PartyDetailsType": {
"type": "object",
"properties": {
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.BusinessType"
},
"currentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1Type"
},
"foreignPartyDetails": {
"xml": {
"name": "ForeignPartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.ForeignPartyDetailsType"
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.FullNameType"
},
"futureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address1Type"
},
"partyCapacityDetails": {
"xml": {
"name": "PartyCapacityDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.PartyCapacityDetailsType"
},
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"partyType": {
"type": "string",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"trustDetails": {
"xml": {
"name": "TrustDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TrustDetailsType"
},
"unrepresentedParty": {
"type": "string",
"xml": {
"name": "UnrepresentedParty",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.PartyDetailsType",
"xml": {
"name": "partyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.PrimaryLandUseDetailType": {
"type": "object",
"properties": {
"key": {
"type": "string",
"xml": {
"name": "Key",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.PrimaryLandUseDetailType",
"xml": {
"name": "primaryLandUseDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.PropertyDetailsDetailType": {
"type": "object",
"properties": {
"areaOfLand": {
"xml": {
"name": "AreaOfLand",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.AreaOfLandDetailType"
},
"constructionType": {
"xml": {
"name": "ConstructionType",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.ConstructionTypeDetailType"
},
"currentLandUse": {
"xml": {
"name": "CurrentLandUse",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.CurrentLandUseDetailType"
},
"localityName": {
"type": "string",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"municipalityName": {
"type": "string",
"xml": {
"name": "MunicipalityName",
"attribute": false,
"wrapped": false
}
},
"natureOfProperty": {
"type": "string",
"xml": {
"name": "NatureOfProperty",
"attribute": false,
"wrapped": false
}
},
"numberOfBedrooms": {
"type": "integer",
"xml": {
"name": "NumberOfBedrooms",
"attribute": false,
"wrapped": false
}
},
"primaryLandUse": {
"xml": {
"name": "PrimaryLandUse",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.PrimaryLandUseDetailType"
},
"safetySwitch": {
"xml": {
"name": "SafetySwitch",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SafetySwitchDetailType"
},
"smokeAlarm": {
"xml": {
"name": "SmokeAlarm",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SmokeAlarmDetailType"
}
},
"title": "au.net.pexa.api.schema._1.PropertyDetailsDetailType",
"xml": {
"name": "propertyDetailsDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.RespondInvitationRequest": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"description": "Subscriber id. If responding to an invitation, then provide the subscriber id of the invitee. If withdrawing an invitation, then provide the subscriber id of the invitor.",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"inviteId": {
"type": "string",
"description": "Invite id of the invitation",
"xml": {
"name": "InviteId",
"attribute": false,
"wrapped": false
}
},
"invitationResponse": {
"type": "string",
"description": "Invitation response. If responding to an invitation, valid values are 'Accept', 'Decline', 'Return to Panel Master', 'Forward to another Subscriber' and 'Forward to Panel Member'. If withdrawing an invitation, valid value is 'Withdrawn'.",
"xml": {
"name": "InvitationResponse",
"attribute": false,
"wrapped": false
}
},
"responseReason": {
"type": "string",
"description": "Invitation response reason. Only applicable if responding to an invitation. Mandatory if responding to an invitation. Valid values are 'Party on invitation is not known to the invitee', 'Transaction type is outside of invitee’s electronic transaction scope', 'Transaction value exceeds the invitee’s electronic transaction scope', 'Invitation sent to incorrect business unit', 'Transaction has already commenced on paper', 'This workspace is linked to another transaction that is outside of electronic conveyancing scope' and 'Other'.",
"xml": {
"name": "ResponseReason",
"attribute": false,
"wrapped": false
}
},
"additionalText": {
"type": "string",
"description": "Additional comments. If responding to an invitation and response reason is 'Other', then additionalText is mandatory. If withdrawing an invitation, the additionalText is optional.",
"xml": {
"name": "AdditionalText",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"description": "Subscriber Reference that will be set for the participant in the workspace. Only applicable if invitation response is 'Accept'. Mandatory if the invitation response is 'Accept'",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
},
"workgroupId": {
"type": "string",
"description": "Workgroup that the workspace will be assigned to. Only applicable if invitation response is 'Accept'. Optional if the invitation response is 'Accept'",
"xml": {
"name": "WorkgroupId",
"attribute": false,
"wrapped": false
}
},
"forwardedParticipantDetails": {
"xml": {
"name": "ForwardedParticipantDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.RespondInvitationRequest.ForwardedParticipantDetails"
},
"commercialTransaction": {
"type": "string",
"description": "The Commercial Transaction indicator to be set when accepting an invitation. Only can be provided if the the invitee role is CT Controller (CT), Source Funder (SF), Incoming Mortgagee (IM) or Mortgagee On Title (MOT). The field is optional. Possible values are 'yes' or 'no'",
"xml": {
"name": "CommercialTransaction",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.RespondInvitationRequest",
"xml": {
"name": "RespondInvitationRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SafetySwitchDetailType": {
"type": "object",
"properties": {
"safetySwitchInformed": {
"type": "string",
"xml": {
"name": "SafetySwitchInformed",
"attribute": false,
"wrapped": false
}
},
"safetySwitchInstalled": {
"type": "string",
"xml": {
"name": "SafetySwitchInstalled",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SafetySwitchDetailType",
"xml": {
"name": "safetySwitchDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementAvailabilityResponse": {
"type": "object",
"properties": {
"availableSettlementTime": {
"xml": {
"name": "AvailableSettlementTime",
"attribute": false,
"wrapped": false
},
"description": "List of the all available settlement times based on the settlement date above.
If Settlement Availability is No, then this will not be provided.",
"$ref": "#/definitions/au.net.pexa.api.schema._1.AvailableSettlementTimeType"
},
"settlementAvailability": {
"type": "string",
"xml": {
"name": "SettlementAvailability",
"attribute": false,
"wrapped": false
},
"description": "A flag to indicate if there are any available times based on the settlement date provided."
},
"settlementDate": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
},
"description": "The settlement date provided in the request which will be used to check available times."
}
},
"title": "au.net.pexa.api.schema._1.SettlementAvailabilityResponse",
"xml": {
"name": "SettlementAvailabilityResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementDetailsType": {
"type": "object",
"properties": {
"settlementDateAndTime": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDateAndTime",
"attribute": false,
"wrapped": false
},
"description": "The proposed date and time for settlement (in UTC)"
},
"participantSettlementAcceptanceStatus": {
"type": "string",
"example": "Accepted",
"xml": {
"name": "ParticipantSettlementAcceptanceStatus",
"attribute": false,
"wrapped": false
},
"description": "Ability to specify if the Settlement Date and Time should be considered accepted or pending when proposing a new date and time.
If no participant settlement acceptance status is provided, the subscribers default acceptance status will be used. Valid values are
- Accepted (Set the Participants Settlement Acceptance Status to the Accepted status.)
- Pending (Set the Participants Settlement Acceptance Status to the Pending status. )"
},
"reason": {
"type": "string",
"example": "Default settlement time is not my preferred Settlement time.",
"xml": {
"name": "Reason",
"attribute": false,
"wrapped": false
},
"description": "The reason for updating the settlement date/time in the workspace.
Maximum 100 characters"
}
},
"title": "au.net.pexa.api.schema._1.SettlementDetailsType",
"xml": {
"name": "SettlementDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementStatementRetrieval": {
"type": "object",
"properties": {
"documents": {
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents"
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementStatementRetrieval",
"xml": {
"name": "SettlementStatementRetrieval",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents": {
"type": "object",
"properties": {
"document": {
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document"
}
},
"title": "au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents",
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
},
"mimeType": {
"type": "string",
"xml": {
"name": "MimeType",
"attribute": false,
"wrapped": false
}
},
"renderedDocument": {
"type": "string",
"format": "byte",
"xml": {
"name": "RenderedDocument",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest": {
"type": "object",
"properties": {
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"schedule": {
"xml": {
"name": "Schedule",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule"
},
"subscriberId": {
"type": "string",
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest",
"xml": {
"name": "SettlementUploadRequest",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule": {
"type": "object",
"properties": {
"lineItems": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem"
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule",
"xml": {
"name": "Schedule",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem": {
"type": "object",
"properties": {
"accountDetails": {
"xml": {
"name": "AccountDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails"
},
"associatedSubscriber": {
"type": "string",
"xml": {
"name": "AssociatedSubscriber",
"attribute": false,
"wrapped": false
}
},
"category": {
"type": "string",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
}
},
"clientName": {
"type": "string",
"xml": {
"name": "ClientName",
"attribute": false,
"wrapped": false
}
},
"customCategory": {
"type": "string",
"xml": {
"name": "CustomCategory",
"attribute": false,
"wrapped": false
}
},
"transactionDescription": {
"type": "string",
"xml": {
"name": "TransactionDescription",
"attribute": false,
"wrapped": false
}
},
"type": {
"type": "string",
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "number",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
},
"verified": {
"type": "string",
"xml": {
"name": "Verified",
"attribute": false,
"wrapped": false
}
},
"verifiedBy": {
"type": "string",
"xml": {
"name": "VerifiedBy",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem",
"xml": {
"name": "LineItem",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails": {
"type": "object",
"properties": {
"destination": {
"xml": {
"name": "Destination",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination"
},
"source": {
"xml": {
"name": "Source",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source"
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails",
"xml": {
"name": "AccountDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination": {
"type": "object",
"properties": {
"account": {
"xml": {
"name": "Account",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account"
},
"bpay": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay"
},
"officeAccount": {
"type": "string",
"xml": {
"name": "OfficeAccount",
"attribute": false,
"wrapped": false
}
},
"preverifiedAccount": {
"type": "string",
"xml": {
"name": "PreverifiedAccount",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination",
"xml": {
"name": "Destination",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account": {
"type": "object",
"properties": {
"accountBsb": {
"type": "string",
"xml": {
"name": "AccountBsb",
"attribute": false,
"wrapped": false
}
},
"accountName": {
"type": "string",
"xml": {
"name": "AccountName",
"attribute": false,
"wrapped": false
}
},
"accountNumber": {
"type": "string",
"xml": {
"name": "AccountNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account",
"xml": {
"name": "Account",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay": {
"type": "object",
"properties": {
"billerCode": {
"type": "string",
"xml": {
"name": "BillerCode",
"attribute": false,
"wrapped": false
}
},
"reference": {
"type": "string",
"xml": {
"name": "Reference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay",
"xml": {
"name": "BPay",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source": {
"type": "object",
"properties": {
"defaultAccount": {
"type": "string",
"xml": {
"name": "DefaultAccount",
"attribute": false,
"wrapped": false
}
},
"preverifiedAccount": {
"type": "string",
"xml": {
"name": "PreverifiedAccount",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source",
"xml": {
"name": "Source",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SettlementUploadResponse": {
"type": "object",
"properties": {
"warning": {
"xml": {
"name": "Warning",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WarningResponseType"
}
},
"title": "au.net.pexa.api.schema._1.SettlementUploadResponse",
"xml": {
"name": "SettlementUploadResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SigningSubscriberDetailsType": {
"type": "object",
"properties": {
"subscriberNames": {
"type": "array",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.SigningSubscriberDetailsType",
"xml": {
"name": "signingSubscriberDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.SmokeAlarmDetailType": {
"type": "object",
"properties": {
"smokeAlarmInformed": {
"type": "string",
"xml": {
"name": "SmokeAlarmInformed",
"attribute": false,
"wrapped": false
}
},
"smokeAlarmInstalled": {
"type": "string",
"xml": {
"name": "SmokeAlarmInstalled",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.SmokeAlarmDetailType",
"xml": {
"name": "smokeAlarmDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.StampDutyDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"verificationResult": {
"type": "string",
"xml": {
"name": "VerificationResult",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.StampDutyDetailsType",
"xml": {
"name": "stampDutyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.TaskDetailsType": {
"type": "object",
"properties": {
"dateCompleted": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateCompleted",
"attribute": false,
"wrapped": false
}
},
"dateCreated": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateCreated",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"taskId": {
"type": "string",
"xml": {
"name": "TaskId",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.TaskDetailsType",
"xml": {
"name": "taskDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.TransactionDetailsDetailType": {
"type": "object",
"properties": {
"cashAmount": {
"type": "number",
"xml": {
"name": "CashAmount",
"attribute": false,
"wrapped": false
}
},
"considerationAmount": {
"type": "number",
"xml": {
"name": "ConsiderationAmount",
"attribute": false,
"wrapped": false
}
},
"considerationLessThanValue": {
"type": "string",
"xml": {
"name": "ConsiderationLessThanValue",
"attribute": false,
"wrapped": false
}
},
"contractOfSaleDate": {
"type": "string",
"format": "date-time",
"xml": {
"name": "ContractOfSaleDate",
"attribute": false,
"wrapped": false
}
},
"contractRebateAmount": {
"type": "number",
"xml": {
"name": "ContractRebateAmount",
"attribute": false,
"wrapped": false
}
},
"covenantMcpExpiryDate": {
"type": "string",
"format": "date-time",
"xml": {
"name": "CovenantMcpExpiryDate",
"attribute": false,
"wrapped": false
}
},
"covenantMcpReference": {
"type": "string",
"xml": {
"name": "CovenantMcpReference",
"attribute": false,
"wrapped": false
}
},
"dateOfPossession": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateOfPossession",
"attribute": false,
"wrapped": false
}
},
"depositPaid": {
"type": "number",
"xml": {
"name": "DepositPaid",
"attribute": false,
"wrapped": false
}
},
"gstAmount": {
"type": "number",
"xml": {
"name": "GstAmount",
"attribute": false,
"wrapped": false
}
},
"liabilitiesAmount": {
"type": "number",
"xml": {
"name": "LiabilitiesAmount",
"attribute": false,
"wrapped": false
}
},
"marginScheme": {
"type": "string",
"xml": {
"name": "MarginScheme",
"attribute": false,
"wrapped": false
}
},
"nonAustralianEntity": {
"type": "string",
"xml": {
"name": "NonAustralianEntity",
"attribute": false,
"wrapped": false
}
},
"otherDutiableTransactions": {
"type": "string",
"xml": {
"name": "OtherDutiableTransactions",
"attribute": false,
"wrapped": false
}
},
"partiesRelated": {
"type": "string",
"xml": {
"name": "PartiesRelated",
"attribute": false,
"wrapped": false
}
},
"phoneNumber": {
"type": "string",
"xml": {
"name": "PhoneNumber",
"attribute": false,
"wrapped": false
}
},
"termsSaleIndicator": {
"type": "string",
"xml": {
"name": "TermsSaleIndicator",
"attribute": false,
"wrapped": false
}
},
"vendorTermsAmount": {
"type": "number",
"xml": {
"name": "VendorTermsAmount",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.TransactionDetailsDetailType",
"xml": {
"name": "transactionDetailsDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.TransferDutyDetailType": {
"type": "object",
"properties": {
"dutyDatas": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.DutyDataDetailType"
}
}
},
"title": "au.net.pexa.api.schema._1.TransferDutyDetailType",
"xml": {
"name": "transferDutyDetailType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.TrustDetailsType": {
"type": "object",
"properties": {
"trustIndicator": {
"type": "string",
"xml": {
"name": "TrustIndicator",
"attribute": false,
"wrapped": false
}
},
"trustName": {
"type": "string",
"xml": {
"name": "TrustName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.TrustDetailsType",
"xml": {
"name": "trustDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.TypeDetailsType": {
"type": "object",
"properties": {
"key": {
"type": "string",
"xml": {
"name": "Key",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.TypeDetailsType",
"xml": {
"name": "typeDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.UserProfileRetrievalResponse": {
"type": "object",
"properties": {
"userProfile": {
"xml": {
"name": "UserProfile",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile"
}
},
"title": "au.net.pexa.api.schema._1.UserProfileRetrievalResponse",
"xml": {
"name": "UserProfileRetrievalResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 212,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
}
},
"subscriberName": {
"type": "string",
"example": "Law Conveyancing",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
}
},
"subscriberType": {
"type": "string",
"example": "Conveyancer",
"xml": {
"name": "SubscriberType",
"attribute": false,
"wrapped": false
}
},
"subscriberDualSignFss": {
"type": "string",
"example": false,
"xml": {
"name": "SubscriberDualSignFss",
"attribute": false,
"wrapped": false
}
},
"subscriberDualSignDoc": {
"type": "string",
"example": false,
"xml": {
"name": "SubscriberDualSignDoc",
"attribute": false,
"wrapped": false
}
},
"userId": {
"type": "string",
"example": 100,
"xml": {
"name": "UserId",
"attribute": false,
"wrapped": false
}
},
"username": {
"type": "string",
"example": "conveyancer@pexa.com.au",
"xml": {
"name": "Username",
"attribute": false,
"wrapped": false
}
},
"userType": {
"type": "string",
"example": "ROLE_SUBSCRIBER_MANAGER",
"xml": {
"name": "UserType",
"attribute": false,
"wrapped": false
}
},
"userFirstName": {
"type": "string",
"example": "Gwen",
"xml": {
"name": "UserFirstName",
"attribute": false,
"wrapped": false
}
},
"userLastName": {
"type": "string",
"example": "Last",
"xml": {
"name": "UserLastName",
"attribute": false,
"wrapped": false
}
},
"workgroupList": {
"xml": {
"name": "WorkgroupList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList"
},
"userPermissionsList": {
"xml": {
"name": "UserPermissionsList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList"
}
},
"title": "au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile",
"xml": {
"name": "UserProfile",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList": {
"type": "object",
"properties": {
"userPermissions": {
"type": "array",
"xml": {
"name": "UserPermission",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.UserPermissionsList",
"xml": {
"name": "UserPermissionsList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList": {
"type": "object",
"properties": {
"workgroups": {
"type": "array",
"xml": {
"name": "Workgroup",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup"
}
}
},
"title": "au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList",
"xml": {
"name": "WorkgroupList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup": {
"type": "object",
"properties": {
"workgroupId": {
"type": "string",
"xml": {
"name": "WorkgroupId",
"attribute": false,
"wrapped": false
}
},
"workgroupName": {
"type": "string",
"xml": {
"name": "WorkgroupName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.UserProfileRetrievalResponse.UserProfile.WorkgroupList.Workgroup",
"xml": {
"name": "Workgroup",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WarningResponseType": {
"type": "object",
"properties": {
"code": {
"type": "string",
"xml": {
"name": "Code",
"attribute": false,
"wrapped": false
}
},
"message": {
"type": "string",
"xml": {
"name": "Message",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WarningResponseType",
"xml": {
"name": "warningResponseType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkgroupRetrievalResponse": {
"type": "object",
"properties": {
"workgroups": {
"type": "array",
"xml": {
"name": "Workgroup",
"attribute": false,
"wrapped": false
},
"description": "Must not be populated if there are no workgroup(s) for the subscriber.",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkgroupRetrievalResponse",
"xml": {
"name": "WorkgroupRetrievalResponse",
"namespace": "http://api.pexa.net.au/schema/1/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup": {
"type": "object",
"properties": {
"workgroupId": {
"type": "string",
"example": 212,
"xml": {
"name": "WorkgroupId",
"attribute": false,
"wrapped": false
},
"description": "Maximum 19 characters"
},
"workgroupName": {
"type": "string",
"example": "Default workgroup",
"xml": {
"name": "WorkgroupName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 250 characters"
},
"isParent": {
"type": "string",
"example": "Yes",
"xml": {
"name": "IsParent",
"attribute": false,
"wrapped": false
},
"description": "Whether the workgroup is a parent"
},
"childWorkgroupList": {
"xml": {
"name": "ChildWorkgroupList",
"attribute": false,
"wrapped": false
},
"description": "The workgroups child workgroup
Must only be provided if Is Parent is 'Yes' and child workgroups exist.",
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ChildWorkgroupList"
},
"parentWorkgroupList": {
"xml": {
"name": "ParentWorkgroupList",
"attribute": false,
"wrapped": false
},
"description": "The workgroups parent workgroup",
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ParentWorkgroupList"
},
"assignedUsers": {
"example": "xyz.bank@bank.com.au",
"xml": {
"name": "AssignedUsers",
"attribute": false,
"wrapped": false
},
"description": "Users assigned to the workgroup",
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.AssignedUsers"
}
},
"title": "au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup",
"xml": {
"name": "Workgroup",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.AssignedUsers": {
"type": "object",
"properties": {
"usernames": {
"type": "array",
"example": "xyz.bank@bank.com.au",
"xml": {
"name": "Username",
"attribute": false,
"wrapped": false
},
"description": "User's email address
Maximum 100 characters",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.AssignedUsers",
"xml": {
"name": "AssignedUsers",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ChildWorkgroupList": {
"type": "object",
"properties": {
"childWorkgroupIds": {
"type": "array",
"example": 231,
"xml": {
"name": "ChildWorkgroupId",
"attribute": false,
"wrapped": false
},
"description": "PEXA workgroup number
Maximum 19 characters",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ChildWorkgroupList",
"xml": {
"name": "ChildWorkgroupList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ParentWorkgroupList": {
"type": "object",
"properties": {
"parentWorkgroupIds": {
"type": "array",
"example": 332,
"xml": {
"name": "ParentWorkgroupId",
"attribute": false,
"wrapped": false
},
"description": "PEXA workgroup number
Maximum 19 characters",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkgroupRetrievalResponse.Workgroup.ParentWorkgroupList",
"xml": {
"name": "ParentWorkgroupList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval": {
"type": "object",
"properties": {
"lodgementCases": {
"type": "array",
"xml": {
"name": "LodgementCase",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval",
"xml": {
"name": "WorkspaceDocumentRetrieval",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase": {
"type": "object",
"properties": {
"documents": {
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents"
},
"lodgementCaseId": {
"type": "string",
"xml": {
"name": "LodgementCaseId",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase",
"xml": {
"name": "LodgementCase",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents.Document"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents",
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents.Document": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"lrDocumentId": {
"type": "string",
"xml": {
"name": "LrDocumentId",
"attribute": false,
"wrapped": false
}
},
"mimeType": {
"type": "string",
"xml": {
"name": "MimeType",
"attribute": false,
"wrapped": false
}
},
"renderedDocument": {
"type": "string",
"format": "byte",
"xml": {
"name": "RenderedDocument",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceDocumentRetrieval.LodgementCase.Documents.Document",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryBusinessEventsListDetailsType": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"xml": {
"name": "Count",
"attribute": false,
"wrapped": false
}
},
"events": {
"type": "array",
"xml": {
"name": "Event",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.EventDetailsType"
}
},
"moreData": {
"type": "string",
"xml": {
"name": "MoreData",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryBusinessEventsListDetailsType",
"xml": {
"name": "workspaceSummaryBusinessEventsListDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryDocumentSummaryDetailsType": {
"type": "object",
"properties": {
"lodgementCases": {
"type": "array",
"xml": {
"name": "LodgementCase",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.LodgementCaseDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryDocumentSummaryDetailsType",
"xml": {
"name": "workspaceSummaryDocumentSummaryDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryFeesDetailsType": {
"type": "object",
"properties": {
"feeItems": {
"type": "array",
"xml": {
"name": "FeeItem",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.FeeItemDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryFeesDetailsType",
"xml": {
"name": "workspaceSummaryFeesDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryLandTitleDetailsType": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryLandTitlesType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryLandTitleDetailsType",
"xml": {
"name": "workspaceSummaryLandTitleDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryLandTitlesType": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"parentTitle": {
"type": "string",
"xml": {
"name": "ParentTitle",
"attribute": false,
"wrapped": false
}
},
"propertyDetails": {
"type": "string",
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryLandTitlesType",
"xml": {
"name": "workspaceSummaryLandTitlesType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryParticipantDetailsType": {
"type": "object",
"properties": {
"participants": {
"type": "array",
"xml": {
"name": "Participant",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryParticipantType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryParticipantDetailsType",
"xml": {
"name": "workspaceSummaryParticipantDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryParticipantType": {
"type": "object",
"properties": {
"contactDetails": {
"xml": {
"name": "ContactDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspacesummaryParticipantContactDetailsType"
},
"subscriberName": {
"type": "string",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
}
},
"workspaces": {
"type": "array",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryWorkspaceDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryParticipantType",
"xml": {
"name": "workspaceSummaryParticipantType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryPartyDetailsType": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.PartyDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryPartyDetailsType",
"xml": {
"name": "workspaceSummaryPartyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryPartyType": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"representingSelf": {
"type": "string",
"xml": {
"name": "RepresentingSelf",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryPartyType",
"xml": {
"name": "workspaceSummaryPartyType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryRepresentedPartyDetailsType": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryPartyType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryRepresentedPartyDetailsType",
"xml": {
"name": "workspaceSummaryRepresentedPartyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryResponse": {
"type": "object",
"properties": {
"businessEventsList": {
"xml": {
"name": "BusinessEventsList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryBusinessEventsListDetailsType"
},
"documentSummary": {
"xml": {
"name": "DocumentSummary",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryDocumentSummaryDetailsType"
},
"fees": {
"xml": {
"name": "Fees",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryFeesDetailsType"
},
"jurisdiction": {
"type": "string",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
}
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryLandTitleDetailsType"
},
"participantDetails": {
"xml": {
"name": "ParticipantDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryParticipantDetailsType"
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryPartyDetailsType"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"settlementSchedule": {
"xml": {
"name": "SettlementSchedule",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummarySettlementScheduleDetailsType"
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"taskList": {
"xml": {
"name": "TaskList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryTaskListDetailsType"
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryResponse",
"xml": {
"name": "WorkspaceSummaryResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummarySettlementScheduleDetailsType": {
"type": "object",
"properties": {
"lastModified": {
"type": "string",
"format": "date-time",
"xml": {
"name": "LastModified",
"attribute": false,
"wrapped": false
}
},
"overallSettlementAcceptanceStatus": {
"type": "string",
"xml": {
"name": "OverallSettlementAcceptanceStatus",
"attribute": false,
"wrapped": false
}
},
"settlementDate": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
}
},
"settlementScheduleId": {
"type": "string",
"xml": {
"name": "SettlementScheduleId",
"attribute": false,
"wrapped": false
}
},
"signaturesReceived": {
"type": "integer",
"xml": {
"name": "SignaturesReceived",
"attribute": false,
"wrapped": false
}
},
"signaturesRequired": {
"type": "integer",
"xml": {
"name": "SignaturesRequired",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummarySettlementScheduleDetailsType",
"xml": {
"name": "workspaceSummarySettlementScheduleDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryTaskListDetailsType": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"xml": {
"name": "Task",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.TaskDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryTaskListDetailsType",
"xml": {
"name": "workspaceSummaryTaskListDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceSummaryWorkspaceDetailsType": {
"type": "object",
"properties": {
"representedParty": {
"xml": {
"name": "RepresentedParty",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceSummaryRepresentedPartyDetailsType"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceSummaryWorkspaceDetailsType",
"xml": {
"name": "workspaceSummaryWorkspaceDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber initiating the API service call.
Note: Subscriber Id is optional for subscribers using token based authentication (OAuth 2.0 authorization code or client credentials flow).
Maximum 19 characters"
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails"
},
"newSubscriberReference": {
"type": "string",
"xml": {
"name": "NewSubscriberReference",
"attribute": false,
"wrapped": false
}
},
"additionalRoleDetails": {
"xml": {
"name": "AdditionalRoleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails"
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails"
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest",
"xml": {
"name": "WorkspaceUpdateRequest",
"namespace": "http://api.pexa.net.au/schema/1/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails": {
"type": "object",
"properties": {
"otherRoles": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails.OtherRole"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails",
"xml": {
"name": "AdditionalRoleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails.OtherRole": {
"type": "object",
"properties": {
"roleActionType": {
"type": "string",
"xml": {
"name": "RoleActionType",
"attribute": false,
"wrapped": false
}
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
},
"isDefaultRole": {
"type": "string",
"xml": {
"name": "IsDefaultRole",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.AdditionalRoleDetails.OtherRole",
"xml": {
"name": "OtherRole",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails.LandTitle"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails.LandTitle": {
"type": "object",
"properties": {
"landTitleActionType": {
"type": "string",
"xml": {
"name": "LandTitleActionType",
"attribute": false,
"wrapped": false
}
},
"landTitleReference": {
"type": "string",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"unregisteredLotReference": {
"type": "string",
"xml": {
"name": "UnregisteredLotReference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.LandTitleDetails.LandTitle",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails.Party"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails.Party": {
"type": "object",
"properties": {
"partyActionType": {
"type": "string",
"xml": {
"name": "PartyActionType",
"attribute": false,
"wrapped": false
}
},
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"representingParty": {
"type": "string",
"xml": {
"name": "RepresentingParty",
"attribute": false,
"wrapped": false
}
},
"partyType": {
"type": "string",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.FullNameType"
},
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.BusinessType"
},
"currentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2Type"
},
"futureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2Type"
},
"partyCapacityDetails": {
"xml": {
"name": "PartyCapacityDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.PartyCapacityDetailsType"
},
"trustDetails": {
"xml": {
"name": "TrustDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.TrustDetailsType"
},
"foreignPartyDetails": {
"xml": {
"name": "ForeignPartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.ForeignPartyDetailsType"
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateRequest.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateResponse": {
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails"
},
"workspaceStatus": {
"type": "string",
"xml": {
"name": "WorkspaceStatus",
"attribute": false,
"wrapped": false
}
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails"
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateResponse",
"xml": {
"name": "WorkspaceUpdateResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails.LandTitle"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails.LandTitle": {
"type": "object",
"properties": {
"obsoleteLandTitleReference": {
"type": "string",
"xml": {
"name": "ObsoleteLandTitleReference",
"attribute": false,
"wrapped": false
}
},
"newLandTitleReference": {
"type": "string",
"xml": {
"name": "NewLandTitleReference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateResponse.LandTitleDetails.LandTitle",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails.Party"
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails.Party": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"partyType": {
"type": "string",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.FullNameType"
},
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.BusinessType"
},
"currentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2Type"
},
"futureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._1.Address2Type"
}
},
"title": "au.net.pexa.api.schema._1.WorkspaceUpdateResponse.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._1.WorkspacesummaryParticipantContactDetailsType": {
"type": "object",
"properties": {
"email": {
"type": "string",
"xml": {
"name": "Email",
"attribute": false,
"wrapped": false
}
},
"phone": {
"type": "string",
"xml": {
"name": "Phone",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._1.WorkspacesummaryParticipantContactDetailsType",
"xml": {
"name": "workspacesummaryParticipantContactDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1OverseasAddress1AddressLineDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._2.Address1OverseasAddress1AddressLineDetailsType",
"xml": {
"name": "address1OverseasAddress1AddressLineDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1OverseasAddressDetailsType": {
"type": "object",
"properties": {
"addressLines": {
"type": "array",
"xml": {
"name": "AddressLine",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1OverseasAddress1AddressLineDetailsType"
}
},
"countryCode": {
"type": "string",
"xml": {
"name": "CountryCode",
"attribute": false,
"wrapped": false
}
},
"postalCode": {
"type": "string",
"xml": {
"name": "PostalCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address1OverseasAddressDetailsType",
"xml": {
"name": "address1OverseasAddressDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadDetailsType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumbers": {
"type": "array",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadNumberType"
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadDetailsType",
"xml": {
"name": "address1StreetAddressComplexRoadDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadNumberType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadNumberType",
"xml": {
"name": "address1StreetAddressComplexRoadNumberType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressDetailsType": {
"type": "object",
"properties": {
"addressSiteName": {
"type": "string",
"xml": {
"name": "AddressSiteName",
"attribute": false,
"wrapped": false
}
},
"complexRoads": {
"type": "array",
"xml": {
"name": "ComplexRoad",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressComplexRoadDetailsType"
}
},
"level": {
"xml": {
"name": "Level",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressLevelDetailsType"
},
"localityName": {
"type": "string",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"postcode": {
"type": "string",
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressRoadDetailsType"
},
"secondaryComplex": {
"type": "string",
"xml": {
"name": "SecondaryComplex",
"attribute": false,
"wrapped": false
}
},
"state": {
"type": "string",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
},
"subDwellingUnitType": {
"xml": {
"name": "SubDwellingUnitType",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressSubDwellingUnitTypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressDetailsType",
"xml": {
"name": "address1StreetAddressDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressLevelDetailsType": {
"type": "object",
"properties": {
"levelNumber": {
"type": "string",
"xml": {
"name": "LevelNumber",
"attribute": false,
"wrapped": false
}
},
"levelTypeCode": {
"type": "string",
"xml": {
"name": "LevelTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressLevelDetailsType",
"xml": {
"name": "address1StreetAddressLevelDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressRoadDetailsType": {
"type": "object",
"properties": {
"lotNumber": {
"type": "string",
"xml": {
"name": "LotNumber",
"attribute": false,
"wrapped": false
}
},
"roadName": {
"type": "string",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
}
},
"roadNumber": {
"type": "string",
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
}
},
"roadSuffixCode": {
"type": "string",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
},
"roadTypeCode": {
"type": "string",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressRoadDetailsType",
"xml": {
"name": "address1StreetAddressRoadDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1StreetAddressSubDwellingUnitTypeDetailsType": {
"type": "object",
"properties": {
"unitNumber": {
"type": "string",
"xml": {
"name": "UnitNumber",
"attribute": false,
"wrapped": false
}
},
"unitTypeCode": {
"type": "string",
"xml": {
"name": "UnitTypeCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address1StreetAddressSubDwellingUnitTypeDetailsType",
"xml": {
"name": "address1StreetAddressSubDwellingUnitTypeDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address1Type": {
"type": "object",
"properties": {
"overseasAddress": {
"xml": {
"name": "OverseasAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1OverseasAddressDetailsType"
},
"streetAddress": {
"xml": {
"name": "StreetAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1StreetAddressDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.Address1Type",
"xml": {
"name": "address1Type",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.Address2CorrespondenceAddressDetailsType": {
"type": "object",
"properties": {
"PostalDelivery": {
"xml": {
"name": "PostalDelivery",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2PostalDeliveryDetailsType"
},
"Road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressRoadDetailsType"
},
"localityName": {
"type": "string",
"example": "Caroline Springs",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
}
},
"postcode": {
"type": "string",
"example": 3023,
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"state": {
"type": "string",
"example": "VIC",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2CorrespondenceAddressDetailsType"
},
"au.net.pexa.api.schema._2.Address2OverseasAddressAddressLineDetailsType": {
"type": "object",
"properties": {
"value": {
"type": "string"
},
"order": {
"type": "integer",
"example": 1,
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2OverseasAddressAddressLineDetailsType"
},
"au.net.pexa.api.schema._2.Address2OverseasAddressDetailsType": {
"type": "object",
"properties": {
"AddressLine": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2OverseasAddressAddressLineDetailsType"
}
},
"postalCode": {
"type": "string",
"example": "SE1",
"xml": {
"name": "PostalCode",
"attribute": false,
"wrapped": false
},
"description": "Maximum 6 characters.
Valid character set: alphanumeric"
},
"countryCode": {
"type": "string",
"example": "UK",
"xml": {
"name": "CountryCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2OverseasAddressDetailsType"
},
"au.net.pexa.api.schema._2.Address2PostalDeliveryDetailsType": {
"type": "object",
"properties": {
"postalDeliveryTypeCode": {
"type": "string",
"example": "PO BOX",
"xml": {
"name": "PostalDeliveryTypeCode",
"attribute": false,
"wrapped": false
}
},
"postalDeliveryNumber": {
"type": "string",
"example": 2,
"xml": {
"name": "PostalDeliveryNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2PostalDeliveryDetailsType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadDetailsType": {
"type": "object",
"properties": {
"RoadNumber": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadNumberType"
}
},
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"roadName": {
"type": "string",
"example": "Gladesville",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
},
"description": " Maximum 100 characters
Valid character set: alphabetic, hyphens, apostrophes and spaces only."
},
"roadTypeCode": {
"type": "string",
"example": "BVD",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
},
"roadSuffixCode": {
"type": "string",
"example": "DV",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadDetailsType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadNumberType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadNumberType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressDetailsType": {
"type": "object",
"properties": {
"ComplexRoad": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressComplexRoadDetailsType"
}
},
"SubDwellingUnitType": {
"xml": {
"name": "SubDwellingUnitType",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressSubDwellingUnitTypeDetailsType"
},
"Level": {
"xml": {
"name": "Level",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressLevelDetailsType"
},
"secondaryComplex": {
"type": "string",
"example": "Riverside Gardens",
"xml": {
"name": "SecondaryComplex",
"attribute": false,
"wrapped": false
},
"description": " Maximum 100 characters
Valid character set: alphanumeric and spaces only.
For complex addresses "
},
"addressSiteName": {
"type": "string",
"example": "care of",
"xml": {
"name": "AddressSiteName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 30 characters
Valid character set: alphanumeric and spaces only."
},
"Road": {
"xml": {
"name": "Road",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressRoadDetailsType"
},
"localityName": {
"type": "string",
"example": "Aintree",
"xml": {
"name": "LocalityName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 100 characters
Valid character set: alphabetic and spaces only."
},
"postcode": {
"type": "string",
"example": 3023,
"xml": {
"name": "Postcode",
"attribute": false,
"wrapped": false
}
},
"state": {
"type": "string",
"example": "VIC",
"xml": {
"name": "State",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressDetailsType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressLevelDetailsType": {
"type": "object",
"properties": {
"levelTypeCode": {
"type": "string",
"example": "G",
"xml": {
"name": "LevelTypeCode",
"attribute": false,
"wrapped": false
}
},
"levelNumber": {
"type": "string",
"example": 5,
"xml": {
"name": "LevelNumber",
"attribute": false,
"wrapped": false
},
"description": "Maximum 5 characters
Valid character set: numeric only."
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressLevelDetailsType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressRoadDetailsType": {
"type": "object",
"properties": {
"lotNumber": {
"type": "string",
"example": 5,
"xml": {
"name": "LotNumber",
"attribute": false,
"wrapped": false
},
"description": "Maximum 6 characters
Valid character set: numeric and spaces only."
},
"roadNumber": {
"type": "string",
"example": 12,
"xml": {
"name": "RoadNumber",
"attribute": false,
"wrapped": false
},
"description": "Maximum 6 characters. Valid character set: alphanumeric only."
},
"roadName": {
"type": "string",
"example": "The esplanade",
"xml": {
"name": "RoadName",
"attribute": false,
"wrapped": false
},
"description": " Maximum 100 characters
Valid character set: alphabetic, hyphens, apostrophes and spaces only."
},
"roadTypeCode": {
"type": "string",
"example": "ALLY",
"xml": {
"name": "RoadTypeCode",
"attribute": false,
"wrapped": false
}
},
"roadSuffixCode": {
"type": "string",
"example": "EX",
"xml": {
"name": "RoadSuffixCode",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressRoadDetailsType"
},
"au.net.pexa.api.schema._2.Address2StreetAddressSubDwellingUnitTypeDetailsType": {
"type": "object",
"properties": {
"unitTypeCode": {
"type": "string",
"example": "UNIT",
"xml": {
"name": "UnitTypeCode",
"attribute": false,
"wrapped": false
}
},
"unitNumber": {
"type": "string",
"example": 22,
"xml": {
"name": "UnitNumber",
"attribute": false,
"wrapped": false
},
"description": "Maximum 7 characters
Valid character set: numeric, slashes and spaces only."
}
},
"title": "au.net.pexa.api.schema._2.Address2StreetAddressSubDwellingUnitTypeDetailsType"
},
"au.net.pexa.api.schema._2.Address2Type": {
"type": "object",
"properties": {
"StreetAddress": {
"xml": {
"name": "StreetAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2StreetAddressDetailsType"
},
"OverseasAddress": {
"xml": {
"name": "OverseasAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2OverseasAddressDetailsType"
},
"CorrespondenceAddress": {
"xml": {
"name": "CorrespondenceAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2CorrespondenceAddressDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.Address2Type"
},
"au.net.pexa.api.schema._2.AdministrationStatusDetailsType": {
"type": "object",
"properties": {
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._2.AdministrationStatusDetailsType",
"xml": {
"name": "AdministrationStatus",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.BusinessType": {
"type": "object",
"properties": {
"legalEntityName": {
"type": "string",
"example": "National Australia Bank",
"xml": {
"name": "LegalEntityName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 150 characters"
},
"businessName": {
"type": "string",
"example": "NAB",
"xml": {
"name": "BusinessName",
"attribute": false,
"wrapped": false
},
"description": " Maximum 255 characters
The business name registered with ASIC.
This will only be returned where available for subscriber details. "
},
"businessUnit": {
"type": "string",
"example": "Mortgage processing",
"xml": {
"name": "BusinessUnit",
"attribute": false,
"wrapped": false
},
"description": " Maximum 70 characters
The business unit within the organisation.
This will only be returned where available for subscriber details. "
},
"organisationType": {
"type": "string",
"example": "Registered Company",
"xml": {
"name": "OrganisationType",
"attribute": false,
"wrapped": false
},
"description": "Must be provided if Party Type is Organisation"
},
"administrationStatuses": {
"type": "array",
"example": "Subject to a deed of company arrangement",
"xml": {
"name": "AdministrationStatus",
"attribute": false,
"wrapped": false
},
"description": " Must be provided if Organisation Type is 'Registered company in external administration' ",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.AdministrationStatusDetailsType"
}
},
"identifications": {
"type": "array",
"xml": {
"name": "Identification",
"attribute": false,
"wrapped": false
},
"description": " External identification of the party through a registered organisation.",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.IdentificationDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.BusinessType",
"xml": {
"name": "BusinessDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.DocumentDetailsType": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
}
},
"documentStatus": {
"type": "string",
"xml": {
"name": "DocumentStatus",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"landTitleReferences": {
"type": "array",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
},
"lastModified": {
"type": "string",
"format": "date-time",
"xml": {
"name": "LastModified",
"attribute": false,
"wrapped": false
}
},
"lodgement": {
"xml": {
"name": "Lodgement",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.LodgementDetailsType"
},
"lodgementVerification": {
"xml": {
"name": "LodgementVerification",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.LodgementVerificationDetailsType"
},
"relatedDocumentId": {
"type": "string",
"xml": {
"name": "RelatedDocumentId",
"attribute": false,
"wrapped": false
}
},
"signaturesReceived": {
"type": "integer",
"xml": {
"name": "SignaturesReceived",
"attribute": false,
"wrapped": false
}
},
"signaturesRequired": {
"type": "integer",
"xml": {
"name": "SignaturesRequired",
"attribute": false,
"wrapped": false
}
},
"stampDuty": {
"xml": {
"name": "StampDuty",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.StampDutyDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.DocumentDetailsType",
"xml": {
"name": "documentDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.EventDetailsType": {
"type": "object",
"properties": {
"category": {
"type": "string",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
}
},
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"detail": {
"type": "string",
"xml": {
"name": "Detail",
"attribute": false,
"wrapped": false
}
},
"eventId": {
"type": "string",
"xml": {
"name": "EventId",
"attribute": false,
"wrapped": false
}
},
"severity": {
"type": "string",
"xml": {
"name": "Severity",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.EventDetailsType",
"xml": {
"name": "eventDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.FeeItemDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"gstAmount": {
"type": "number",
"xml": {
"name": "GstAmount",
"attribute": false,
"wrapped": false
}
},
"netAmount": {
"type": "number",
"xml": {
"name": "NetAmount",
"attribute": false,
"wrapped": false
}
},
"signingSubscriber": {
"xml": {
"name": "SigningSubscriber",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.SigningSubscriberDetailsType"
},
"totalAmount": {
"type": "number",
"xml": {
"name": "TotalAmount",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.FeeItemDetailsType",
"xml": {
"name": "feeItemDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.ForeignCountryShareDetailsType": {
"type": "object",
"properties": {
"foreignShareholderCountry": {
"type": "string",
"example": "CA",
"xml": {
"name": "ForeignShareholderCountry",
"attribute": false,
"wrapped": false
},
"description": "The foreign country."
},
"foreignPercent": {
"type": "number",
"example": 70,
"xml": {
"name": "ForeignPercent",
"attribute": false,
"wrapped": false
},
"description": "The percentage that is foreign."
}
},
"title": "au.net.pexa.api.schema._2.ForeignCountryShareDetailsType",
"xml": {
"name": "ForeignCountryShare",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.ForeignPartyDetailsType": {
"type": "object",
"properties": {
"foreignPartyIndicator": {
"type": "string",
"example": "No",
"xml": {
"name": "ForeignPartyIndicator",
"attribute": false,
"wrapped": false
}
},
"foreignPartyType": {
"type": "string",
"example": "Natural Person",
"xml": {
"name": "ForeignPartyType",
"attribute": false,
"wrapped": false
}
},
"foreignCountry": {
"type": "string",
"example": "CA",
"xml": {
"name": "ForeignCountry",
"attribute": false,
"wrapped": false
}
},
"residentPartyIndicator": {
"type": "string",
"example": "Yes",
"xml": {
"name": "ResidentPartyIndicator",
"attribute": false,
"wrapped": false
}
},
"foreignCountryShares": {
"type": "array",
"xml": {
"name": "ForeignCountryShare",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.ForeignCountryShareDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.ForeignPartyDetailsType",
"xml": {
"name": "ForeignPartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.FullNameType": {
"type": "object",
"properties": {
"nameTitle": {
"type": "string",
"example": "Mr",
"xml": {
"name": "NameTitle",
"attribute": false,
"wrapped": false
},
"description": " Title (e.g. 'Mr', 'Ms', 'Prof') "
},
"givenNames": {
"type": "array",
"example": "Jhon Snow",
"xml": {
"name": "GivenName",
"attribute": false,
"wrapped": false
},
"description": " Maximum 100 characters
Valid character set: alphabetic, hyphens, apostrophes and spaces only.
One or more given names in order.
Mandatory attribute: order",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.GivenNameOrderType"
}
},
"familyName": {
"type": "string",
"example": "Stark",
"xml": {
"name": "FamilyName",
"attribute": false,
"wrapped": false
},
"description": " Maximum 100 characters
Valid character set: alphabetic, hyphens, apostrophes and spaces only. "
},
"familyNameOrder": {
"type": "string",
"example": 1,
"xml": {
"name": "FamilyNameOrder",
"attribute": false,
"wrapped": false
},
"description": " Identifies where the family name is placed in relation to the given name. If not supplied, defaults to Last "
},
"nameSuffix": {
"type": "string",
"example": "Jr",
"xml": {
"name": "NameSuffix",
"attribute": false,
"wrapped": false
},
"description": " Maximum 50 characters
Valid character set: alphabetic and period only.
e.g. Jr (for Junior)"
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"example": "1984-02-02",
"xml": {
"name": "DateOfBirth",
"attribute": false,
"wrapped": false
},
"description": " This must be provided when creating or editing a party when Representing Party is Yes.
This is only provided outbound if Representing Party is Yes. PEXA will only return this value if the Party is Represented by the Subscriber / Role. "
}
},
"title": "au.net.pexa.api.schema._2.FullNameType",
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.GivenNameOrderType": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"xml": {
"name": "order",
"attribute": true,
"wrapped": false
}
},
"value": {
"type": "string"
}
},
"title": "au.net.pexa.api.schema._2.GivenNameOrderType",
"xml": {
"name": "GivenName",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.IdentificationDetailsType": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"example": "ABN",
"xml": {
"name": "Identifier",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"example": "0421568963",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
},
"description": "Maximum 20 characters
Must be provided without whitespaces."
}
},
"title": "au.net.pexa.api.schema._2.IdentificationDetailsType",
"xml": {
"name": "Identification",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.LodgementCaseDetailsType": {
"type": "object",
"properties": {
"documents": {
"xml": {
"name": "Documents",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.LodgementCaseDocumentDetailsType"
},
"lodgementCaseId": {
"type": "string",
"xml": {
"name": "LodgementCaseId",
"attribute": false,
"wrapped": false
}
},
"lodgementCaseStatus": {
"type": "string",
"xml": {
"name": "LodgementCaseStatus",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.LodgementCaseDetailsType",
"xml": {
"name": "lodgementCaseDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.LodgementCaseDocumentDetailsType": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.DocumentDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.LodgementCaseDocumentDetailsType",
"xml": {
"name": "lodgementCaseDocumentDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.LodgementDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"dealingNumber": {
"type": "string",
"xml": {
"name": "DealingNumber",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.LodgementDetailsType",
"xml": {
"name": "lodgementDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.LodgementVerificationDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"verificationResult": {
"type": "string",
"xml": {
"name": "VerificationResult",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.LodgementVerificationDetailsType",
"xml": {
"name": "lodgementVerificationDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType": {
"type": "object",
"properties": {
"administrativeActionTimestamp": {
"type": "string",
"format": "date-time",
"xml": {
"name": "AdministrativeActionTimestamp",
"attribute": false,
"wrapped": false
}
},
"administrativeActionType": {
"type": "string",
"xml": {
"name": "AdministrativeActionType",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType",
"xml": {
"name": "notificationAdministrativeActionReferenceDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationConversationDetailsType": {
"type": "object",
"properties": {
"conversationId": {
"type": "string",
"example": 456,
"xml": {
"name": "ConversationId",
"attribute": false,
"wrapped": false
},
"description": "The unique identifier of the conversation
Maximum 19 characters"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "Timestamp",
"attribute": false,
"wrapped": false
},
"description": "The timestamp that the conversation was created in PEXA (in UTC)."
}
},
"title": "au.net.pexa.api.schema._2.NotificationConversationDetailsType",
"xml": {
"name": "Conversation",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationDetailsType": {
"type": "object",
"properties": {
"financialLineItem": {
"xml": {
"name": "FinancialLineItem",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationFinancialLineItemType"
},
"invitation": {
"xml": {
"name": "Invitation",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to invitations.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationDetailsType"
},
"landTitle": {
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to the land title references in the workspace.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationLandTitleDetailsType"
},
"party": {
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to the party details in the workspace.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationPartyDetailsType"
},
"document": {
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to the documents in the workspace.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationDocumentDetailsType"
},
"settlementSchedule": {
"xml": {
"name": "SettlementSchedule",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to the settlement schedule in the workspace.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationSettlementScheduleDetailsType"
},
"workspaceStatus": {
"type": "string",
"xml": {
"name": "WorkspaceStatus",
"attribute": false,
"wrapped": false
},
"description": " Notification detail related to the workspace status. "
},
"settlement": {
"xml": {
"name": "Settlement",
"attribute": false,
"wrapped": false
},
"description": "Notification details related to settlement.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationSettlementDetailsType"
},
"lodgement": {
"xml": {
"name": "Lodgement",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to lodgement. ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationLodgementDetailsType"
},
"participant": {
"xml": {
"name": "Participant",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to participants in the workspace. ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationParticipantDetailsType"
},
"conversation": {
"xml": {
"name": "Conversation",
"attribute": false,
"wrapped": false
},
"description": " Notification details related to conversations in the workspace. ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationConversationDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationDetailsType",
"xml": {
"name": "Details",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationDocumentDetailsType": {
"type": "object",
"properties": {
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"documentId": {
"type": "string",
"example": 664,
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal document identifier.
Maximum 19 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationDocumentDetailsType",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationDocumentReferenceDetailsType": {
"type": "object",
"properties": {
"documentType": {
"type": "string",
"example": "Mortgage",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
},
"description": " Jurisdiction specific document name or document type e.g. 'Mortgage', 'Caveat', 'Settlement Notice' etc."
},
"lrDocumentId": {
"type": "string",
"example": "DC123456",
"xml": {
"name": "LrDocumentId",
"attribute": false,
"wrapped": false
},
"description": " Where a dealing number was allocated to the document by the LR, the dealing number associated with this document.
Where a dealing number is not allocated, this may contain an alternate identifier"
},
"documentStatusDetails": {
"type": "array",
"xml": {
"name": "DocumentStatusDetails",
"attribute": false,
"wrapped": false
},
"description": "Internal LR document status",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationDocumentStatusDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationDocumentReferenceDetailsType",
"xml": {
"name": "DocumentReference",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationDocumentStatusDetailsType": {
"type": "object",
"properties": {
"documentStatusTimestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "DocumentStatusTimestamp",
"attribute": false,
"wrapped": false
},
"description": " The date and time at which the status occurred (in UTC).
This provides the equivalent of lodgement date, registration date or another appropriate document date"
},
"documentStatus": {
"type": "string",
"example": "Verifying",
"xml": {
"name": "DocumentStatus",
"attribute": false,
"wrapped": false
},
"description": "Information that specifies the current state of a Document in a Land Registry"
}
},
"title": "au.net.pexa.api.schema._2.NotificationDocumentStatusDetailsType",
"xml": {
"name": "DocumentStatusDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationFinancialLineItemType": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"xml": {
"name": "Amount",
"attribute": false,
"wrapped": false
}
},
"category": {
"type": "string",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
}
},
"owningSubscriberId": {
"type": "string",
"xml": {
"name": "OwningSubscriberId",
"attribute": false,
"wrapped": false
}
},
"owningSubscriberName": {
"type": "string",
"xml": {
"name": "OwningSubscriberName",
"attribute": false,
"wrapped": false
}
},
"type": {
"type": "string",
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationFinancialLineItemType",
"xml": {
"name": "FinancialLineItem",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationDetailsType": {
"type": "object",
"properties": {
"outstanding": {
"xml": {
"name": "Outstanding",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingDetailsType"
},
"response": {
"xml": {
"name": "Response",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationResponseDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationDetailsType",
"xml": {
"name": "Invitation",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingDetailsType": {
"type": "object",
"properties": {
"inviteId": {
"type": "string",
"example": 123,
"xml": {
"name": "InviteId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal reference for the invitation.
Maximum 19 characters"
},
"forwardedBy": {
"type": "string",
"example": "XYZ Bank",
"xml": {
"name": "ForwardedBy",
"attribute": false,
"wrapped": false
},
"description": " If the invitation has been forwarded by a panel master, this must be provided with the panel master subscribers organisation name.
Alternately, if the invitation has been forwarded by another subscriber (via the Forward to another Subscriber invitation response) then this will be the subscribers organisation name.
Maximum 255 characters"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "Timestamp",
"attribute": false,
"wrapped": false
},
"description": "The date and time the invitation was created (in UTC)."
},
"jurisdiction": {
"type": "string",
"example": "VIC",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
},
"description": "The jurisdiction of the workspace."
},
"workspaceRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "WorkspaceRole",
"attribute": false,
"wrapped": false
},
"description": " The workspace role the subscriber user has been invited to participate in. "
},
"settlementDate": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
},
"description": "The date and time of settlement if the workspace is marked as requiring financial settlement (in UTC). Must be provided if financial settlement required unless in the scenario where a workspace has been created with a parent title and no settlement date/time has been set by the participant yet."
},
"expressRefinance": {
"type": "string",
"example": "Yes",
"xml": {
"name": "ExpressRefinance",
"attribute": false,
"wrapped": false
},
"description": " A flag used to specify whether the invitation is for a workspace that is marked as an express refinance.
Maximum 3 characters"
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"description": " Provided if the land titles are not marked as parent land titles.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleType"
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"description": " For Principal Subscribers, this will provide the party details of all Proprietor(s) on Title and/or Incoming Proprietor(s) within the workspace at the time the invitation is sent.
If land title data has not been retrieved in the workspace at the time the invitation is sent, no Proprietor on Title details will be provided.
Similarly, if the Proprietor on Title party is of an Indeterminate party type at the time the invitation is sent, no Proprietor on Title party details will be provided.
For Representative Subscribers, if available, this will provide the details of the party that the invited subscriber user will be representing upon joining the workspace.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyType"
},
"inviterSubscriberDetails": {
"xml": {
"name": "InviterSubscriberDetails",
"attribute": false,
"wrapped": false
},
"description": "Details of the subscriber who has initiated the invite",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingDetailsType",
"xml": {
"name": "Outstanding",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresentingPartyType"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting",
"xml": {
"name": "Representing",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresentingPartyType": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"partyName": {
"xml": {
"name": "PartyName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyNameDetailsType"
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresentingPartyType",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsType": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal reference for the inviter subscriber.
Maximum 19 characters"
},
"subscriberType": {
"type": "string",
"example": "Financial Institution",
"xml": {
"name": "SubscriberType",
"attribute": false,
"wrapped": false
},
"description": "The type of subscriber the inviter is registered as within PEXA."
},
"subscriberName": {
"type": "string",
"example": "XYZ Bank",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"description": " The subscriber who has initiated the invite.
Maximum 255 characters"
},
"subscriberWorkspaceRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "SubscriberWorkspaceRole",
"attribute": false,
"wrapped": false
},
"description": " The workspace role of the subscriber who has initiated the invite.
If Inviter subscriber is acting in multiple roles, the primary role will be provided"
},
"representing": {
"xml": {
"name": "Representing",
"attribute": false,
"wrapped": false
},
"description": "Details of any party(s) the inviter subscriber is representing at the time the invitation is sent.
If the subscriber type of the Inviter Subscriber is Financial Institution, no representation details will be provided in the invitation.
Alternatively, if the subscriber type of the Inviter Subscriber is not Financial Institution and the subscriber is not representing any party(s) at the time the invitation is sent, no representation details will be provided in the invitation.
If the Inviter subscriber is representing a Proprietor on Title party who is an Indeterminate party type at the time the invitation is sent, no representing party details will be provided.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting"
},
"notes": {
"type": "string",
"example": "Additional notes",
"xml": {
"name": "Notes",
"attribute": false,
"wrapped": false
},
"description": " Notes entered in by the subscriber who initiated the invite.
Any forwarding notes which may have been provided by the Subscriber who has forwarded the invitation will appear here.
May contain line feeds Maximum 160 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingInviterSubscriberDetailsType",
"xml": {
"name": "notificationInvitationOutstandingInviterSubscriberDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleDetailsType": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"example": "123/654",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"propertyDetails": {
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
},
"description": " The property details associated to the land title reference.
Note that depending on the workspace jurisdiction and whether land title data has been procured; there may be no property details. ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.PropertyDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleDetailsType",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleType": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"description": " Provided if the land titles are not marked as parent land titles. ",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingLandTitleType",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyDetailsType": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"example": 654,
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
},
"description": " Maximum 19 characters"
},
"partyRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"partyName": {
"xml": {
"name": "PartyName",
"attribute": false,
"wrapped": false
},
"description": " Must be one of the following: Full Name, Business Detail ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyNameDetailsType"
},
"associatedLandTitleReferences": {
"type": "array",
"example": "98745/987",
"xml": {
"name": "AssociatedLandTitleReference",
"attribute": false,
"wrapped": false
},
"description": "This is the land title reference that the party within the invitation is associated to.
Note: This value must be provided for parties in the role of Proprietor on Title. For other party roles (such as Incoming Proprietors) it will not be provided.",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyDetailsType",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyType": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationOutstandingPartyType",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationInvitationResponseDetailsType": {
"type": "object",
"properties": {
"inviteId": {
"type": "string",
"example": 654,
"xml": {
"name": "InviteId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal reference for the invitation.
Maximum 19 characters"
},
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber who was invited to participate in the workspace.
For forwarded invitations, this will be the subscriber id of the subscriber who has received and actioned the forwarded invitation.
Maximum 19 characters"
},
"subscriberName": {
"type": "string",
"example": "XYZ bank",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"description": " The subscribers PEXA organisation name
Maximum 255 characters "
},
"workspaceRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "WorkspaceRole",
"attribute": false,
"wrapped": false
},
"description": " The workspace role the subscriber user has been invited to participate in. "
},
"responseReason": {
"type": "string",
"example": "Additional documents required",
"xml": {
"name": "ResponseReason",
"attribute": false,
"wrapped": false
},
"description": " The subscribers response reason. "
},
"additionalText": {
"type": "string",
"example": "More information",
"xml": {
"name": "AdditionalText",
"attribute": false,
"wrapped": false
},
"description": "Additional text entered by the invited subscriber.
Must be provided if the response reason is Other.
Maximum 250 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationInvitationResponseDetailsType",
"xml": {
"name": "Response",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationLandTitleDetailsType": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"titleActivityCheck": {
"xml": {
"name": "TitleActivityCheck",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationTitleActivityCheck"
},
"propertyDetails": {
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
},
"description": "The property details associated to the land title reference.
Note that depending on the workspace jurisdiction and whether land title data has been procured; there may be no property details.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.PropertyDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationLandTitleDetailsType",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationLodgementDetailsType": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationLodgementDocumentDetailsType"
}
},
"lodgementCaseStatus": {
"type": "string",
"xml": {
"name": "LodgementCaseStatus",
"attribute": false,
"wrapped": false
}
},
"lodgementCaseId": {
"type": "string",
"example": 123,
"xml": {
"name": "LodgementCaseId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal lodgement case identifier.
Maximum 19 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationLodgementDetailsType",
"xml": {
"name": "Lodgement",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationLodgementDocumentDetailsType": {
"type": "object",
"properties": {
"documentStatus": {
"type": "string",
"xml": {
"name": "DocumentStatus",
"attribute": false,
"wrapped": false
}
},
"documentType": {
"type": "string",
"xml": {
"name": "DocumentType",
"attribute": false,
"wrapped": false
}
},
"landTitleReferences": {
"type": "array",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
},
"documentId": {
"type": "string",
"example": 664,
"xml": {
"name": "DocumentId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal document identifier.
Maximum 19 characters"
},
"dealingNumber": {
"type": "string",
"example": 987,
"xml": {
"name": "DealingNumber",
"attribute": false,
"wrapped": false
},
"description": "Maximum 30 characters "
},
"mortgageDate": {
"type": "string",
"format": "date-time",
"example": "2019-02-02",
"xml": {
"name": "MortgageDate",
"attribute": false,
"wrapped": false
},
"description": "Will only be provided if the document type is Mortgage."
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "Timestamp",
"attribute": false,
"wrapped": false
},
"description": " The date and time the document status last changed (in UTC)."
}
},
"title": "au.net.pexa.api.schema._2.NotificationLodgementDocumentDetailsType",
"xml": {
"name": "Document",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationParticipantDetailsType": {
"type": "object",
"properties": {
"subscriberName": {
"type": "string",
"example": "XYZ bank",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"description": "The subscribers PEXA organisation name.
Maximum 255 characters"
},
"workspaceRoles": {
"type": "array",
"example": "Incoming Mortgagee",
"xml": {
"name": "WorkspaceRole",
"attribute": false,
"wrapped": false
},
"description": "The workspace role the subscriber was performing in.",
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationParticipantDetailsType",
"xml": {
"name": "Participant",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationPartyDetailsType": {
"type": "object",
"properties": {
"partyName": {
"xml": {
"name": "PartyName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyNameDetailsType"
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"partyId": {
"type": "string",
"example": 989,
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
},
"description": " Maximum 19 characters "
}
},
"title": "au.net.pexa.api.schema._2.NotificationPartyDetailsType",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationSettlementDetailsType": {
"type": "object",
"properties": {
"settlementDate": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
},
"description": "The date and time of the settlement (in UTC). "
},
"reason": {
"type": "string",
"example": "Settlement completed",
"xml": {
"name": "Reason",
"attribute": false,
"wrapped": false
},
"description": "Maximum 255 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationSettlementDetailsType",
"xml": {
"name": "Settlement",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationSettlementScheduleDetailsType": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "Signed",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
},
"description": " The status of the settlement schedule."
}
},
"title": "au.net.pexa.api.schema._2.NotificationSettlementScheduleDetailsType",
"xml": {
"name": "SettlementSchedule",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationTitleActivityCheck": {
"type": "object",
"properties": {
"administrativeActionReferences": {
"type": "array",
"xml": {
"name": "AdministrativeActionReference",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationAdministrativeActionReferenceDetailsType"
}
},
"documentReferences": {
"type": "array",
"xml": {
"name": "DocumentReference",
"attribute": false,
"wrapped": false
},
"description": "A document that has been lodged or registered against the Land Title in question within the period in question",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationDocumentReferenceDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationTitleActivityCheck",
"xml": {
"name": "TitleActivityCheck",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationType": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber.
Maximum 19 characters"
},
"systemGenerated": {
"type": "string",
"example": "No",
"xml": {
"name": "SystemGenerated",
"attribute": false,
"wrapped": false
},
"description": "A flag used to delineate whether a business event/notification has been generated by either a subscriber user (flag = no) or the PEXA system (flag=yes).
Maximum 3 characters"
},
"initiatingSubscriberId": {
"type": "string",
"example": 290,
"xml": {
"name": "InitiatingSubscriberId",
"attribute": false,
"wrapped": false
},
"description": "If System Generated flag is set to no then this will be the Subscriber Id who has initiated the business event/notification being triggered.
Maximum 19 characters"
},
"initiatingSubscriberName": {
"type": "string",
"example": "XYZ bank",
"xml": {
"name": "InitiatingSubscriberName",
"attribute": false,
"wrapped": false
},
"description": "The legal entity name of the initiating subscriber which correlates to the initiating subscriber id above.
Must be provided if System Generated is set to no.
Must not be provided if System Generated flag is set to yes.
Maximum 255 characters"
},
"workspaceId": {
"type": "string",
"example": "PEXA1900800123",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA workspace number. Maximum 13 characters"
},
"subscriberReferences": {
"type": "array",
"example": "Matter-123312",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
},
"description": "The subscribers workspace reference. Users may utilise this to associate the workspace with an internal customers application.
Where a subscriber is acting in multiple roles in a workspace, the subscriber reference will be provided for each role.",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.SubscriberReferenceType"
}
},
"eventId": {
"type": "string",
"example": 2,
"xml": {
"name": "EventId",
"attribute": false,
"wrapped": false
},
"description": " The PEXA internal reference for the event.
Maximum 19 characters"
},
"timestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "Timestamp",
"attribute": false,
"wrapped": false
},
"description": " The timestamp the event occurred (in UTC). "
},
"severity": {
"type": "string",
"example": "Information",
"xml": {
"name": "Severity",
"attribute": false,
"wrapped": false
},
"description": " The severity of the event that has occurred.
The severity is determined from a workspace perspective."
},
"category": {
"type": "string",
"example": "Settlement Execution",
"xml": {
"name": "Category",
"attribute": false,
"wrapped": false
},
"description": "The category the event belongs to. "
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"description": "The event type code and description.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationTypeKeyValue"
},
"description": {
"type": "string",
"example": "Settlement completed",
"xml": {
"name": "Description",
"attribute": false,
"wrapped": false
},
"description": "Freeform field containing additional details on the notification."
},
"details": {
"example": "Settlement",
"xml": {
"name": "Details",
"attribute": false,
"wrapped": false
},
"description": "Notification details for the event that has occurred.
Note that different details structures are populated depending on the event type code/description. Refer to 0 for the message structure population rules.
Must be one of the following: Invitation, Land Title, Party, Document, Settlement Schedule, Workspace Status, Settlement, Lodgement, Participant",
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.NotificationType",
"xml": {
"name": "Notification",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationTypeKeyValue": {
"type": "object",
"properties": {
"key": {
"type": "string",
"xml": {
"name": "Key",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.NotificationTypeKeyValue",
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.NotificationsListType": {
"type": "object",
"properties": {
"notifications": {
"type": "array",
"xml": {
"name": "Notification",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationType"
}
},
"count": {
"type": "integer",
"example": 20,
"xml": {
"name": "Count",
"attribute": false,
"wrapped": false
},
"description": "Total number of notifications in the response.
A count threshold will be provided once confirmed."
},
"moreData": {
"type": "string",
"example": "Yes",
"xml": {
"name": "MoreData",
"attribute": false,
"wrapped": false
},
"description": "Used to indicate that there is more data to retrieve.
This field will be set to Yes when the Count threshold has been exceeded."
},
"lastEventTimestamp": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "LastEventTimestamp",
"attribute": false,
"wrapped": false
},
"description": "The latest event timestamp the response contains (in UTC). This value should match the Timestamp' value from the latest notification retrieved in the below structure.
This value can be used as the Last Event Timestamp in the subsequent request message.
If no notifications exist for the time period requested then this should be set to the Last Event Timestamp from the original Request message."
},
"lastEventId": {
"type": "string",
"example": 1,
"xml": {
"name": "LastEventId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the event. This value should match the Event Id value for the latest notification retrieved in the below structure.
This value should be used as the Last Event Id in the subsequent request message.
If no notifications exist for the time period requested then this should be set to the Last Event Id from the original Request message.
Maximum 19 characters"
}
},
"title": "au.net.pexa.api.schema._2.NotificationsListType",
"xml": {
"name": "NotificationsList",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.OperatingInDetailsType": {
"type": "object",
"properties": {
"jurisdictions": {
"type": "array",
"example": "VIC",
"xml": {
"name": "Jurisdictions",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string",
"enum": [
"VIC",
"NSW",
"SA"
]
}
}
},
"title": "au.net.pexa.api.schema._2.OperatingInDetailsType",
"xml": {
"name": "OperatingIn",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.PartyCapacityDetailsType": {
"type": "object",
"properties": {
"partyCapacityType": {
"type": "string",
"example": "Executor",
"xml": {
"name": "PartyCapacityType",
"attribute": false,
"wrapped": false
}
},
"partyCapacityDetail": {
"type": "string",
"example": "UNDER INSTRUMENT 717058293",
"xml": {
"name": "PartyCapacityDetail",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.PartyCapacityDetailsType",
"xml": {
"name": "PartyCapacityDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.PartyDetailsType": {
"type": "object",
"properties": {
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.BusinessType"
},
"currentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1Type"
},
"foreignPartyDetails": {
"xml": {
"name": "ForeignPartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.ForeignPartyDetailsType"
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.FullNameType"
},
"futureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address1Type"
},
"partyCapacityDetails": {
"xml": {
"name": "PartyCapacityDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyCapacityDetailsType"
},
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"partyType": {
"type": "string",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"trustDetails": {
"xml": {
"name": "TrustDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.TrustDetailsType"
},
"unrepresentedParty": {
"type": "string",
"xml": {
"name": "UnrepresentedParty",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.PartyDetailsType",
"xml": {
"name": "partyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.PartyNameDetailsType": {
"type": "object",
"properties": {
"businessDetails": {
"xml": {
"name": "BusinessDetails",
"attribute": false,
"wrapped": false
},
"description": " The organisation details of the party.
Must be provided if the party is an organisation.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.BusinessType"
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"description": " The structured full name of the party.
Must be provided if the party is an individual.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.FullNameType"
}
},
"title": "au.net.pexa.api.schema._2.PartyNameDetailsType",
"xml": {
"name": "PartyName",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.PropertyDetailsType": {
"type": "object",
"properties": {
"landDescription": {
"type": "string",
"xml": {
"name": "LandDescription",
"attribute": false,
"wrapped": false
},
"description": " The land description associated to the land title reference.
Maximum 300 characters"
},
"propertyAddress": {
"type": "string",
"xml": {
"name": "PropertyAddress",
"attribute": false,
"wrapped": false
},
"description": "Where available, the property address associated to the land title reference.
Maximum 300 characters"
}
},
"title": "au.net.pexa.api.schema._2.PropertyDetailsType",
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.RetrieveNotificationsResponse": {
"type": "object",
"properties": {
"notificationsList": {
"xml": {
"name": "NotificationsList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationsListType"
}
},
"title": "au.net.pexa.api.schema._2.RetrieveNotificationsResponse",
"xml": {
"name": "RetrieveNotificationsResponse",
"namespace": "http://api.pexa.net.au/schema/2/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.SigningSubscriberDetailsType": {
"type": "object",
"properties": {
"subscriberNames": {
"type": "array",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"items": {
"type": "string"
}
}
},
"title": "au.net.pexa.api.schema._2.SigningSubscriberDetailsType",
"xml": {
"name": "signingSubscriberDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.StampDutyDetailsType": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"xml": {
"name": "Date",
"attribute": false,
"wrapped": false
}
},
"verificationResult": {
"type": "string",
"xml": {
"name": "VerificationResult",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.StampDutyDetailsType",
"xml": {
"name": "stampDutyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.SubscriberDetailsType": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber. \\n Maximum 19 characters"
},
"subscriberName": {
"type": "string",
"example": "XYZ Bank",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
},
"description": "Maximum 255 characters \\n Subscriber Organisation Name"
},
"email": {
"type": "string",
"example": "xyz.bank@email.com",
"xml": {
"name": "Email",
"attribute": false,
"wrapped": false
},
"description": "Maximum 100 characters \\n Subscriber public contact email"
},
"identification": {
"xml": {
"name": "Identification",
"attribute": false,
"wrapped": false
},
"description": "External identification of the party through a registered organisation",
"$ref": "#/definitions/au.net.pexa.api.schema._2.IdentificationDetailsType"
},
"phone": {
"type": "string",
"example": "0421568963",
"xml": {
"name": "Phone",
"attribute": false,
"wrapped": false
},
"description": "Maximum 30 characters \\n Subscriber public contact phone"
},
"operatingIn": {
"xml": {
"name": "OperatingIn",
"attribute": false,
"wrapped": false
},
"description": "Subscribers operating jurisdiction",
"$ref": "#/definitions/au.net.pexa.api.schema._2.OperatingInDetailsType"
},
"subscriberTransactionLimitations": {
"xml": {
"name": "SubscriberTransactionLimitations",
"attribute": false,
"wrapped": false
},
"description": "Any transaction limitations the subscriber has indicated in PEXA.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.SubscriberTransactionLimitations"
}
},
"title": "au.net.pexa.api.schema._2.SubscriberDetailsType",
"xml": {
"name": "Subscriber",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.SubscriberReferenceType": {
"type": "object",
"properties": {
"workspaceRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "WorkspaceRole",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"example": "Matter-123312",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
},
"description": "The subscriber reference for the workspace based on the subscribers role
Maximum 30 characters"
}
},
"title": "au.net.pexa.api.schema._2.SubscriberReferenceType",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.SubscriberSearchResponse": {
"type": "object",
"properties": {
"onboardingLink": {
"type": "string",
"example": "https://api.pexa.com.au/pexa_web/showSubscriberLeadForm.html",
"xml": {
"name": "OnboardingLink",
"attribute": false,
"wrapped": false
},
"description": "Maximum 2000 characters
Absolute URL into the on boarding request form in PEXA. Used for deep linking."
},
"subscribers": {
"type": "array",
"xml": {
"name": "Subscriber",
"attribute": false,
"wrapped": false
},
"description": "List of the possible matches found. When subscriberName is used to search, only the first 50 will be sent in the response. Where More Results = 'Yes', the subscriberName query parameter must be refined if the first 50 results do not contain the subscriber required. \\n When searchSubscriberId is used to search, the details of the subscriber who is assigned to that internal PEXA identifier will be returned. \\n Must not be populated if there are no results.",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.SubscriberDetailsType"
}
},
"moreResults": {
"type": "string",
"example": "Yes",
"xml": {
"name": "MoreResults",
"attribute": false,
"wrapped": false
},
"description": "Set to Yes when results exceed 50 results else must not be provided."
}
},
"title": "au.net.pexa.api.schema._2.SubscriberSearchResponse",
"xml": {
"name": "SubscriberSearchResponse",
"namespace": "http://api.pexa.net.au/schema/2/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.SubscriberTransactionLimitations": {
"type": "object",
"properties": {
"receivingInvitations": {
"type": "string",
"example": "Yes",
"xml": {
"name": "ReceivingInvitations",
"attribute": false,
"wrapped": false
},
"description": "A yes/no flag to indicate whether the subscriber can receive invitations to join PEXA workspaces."
},
"limitationDetail": {
"type": "string",
"example": "Transactions include discharges",
"xml": {
"name": "LimitationDetail",
"attribute": false,
"wrapped": false
},
"description": "Maximum 300 characters \\n Must be provided if Receiving Invitations flag is set to No. \\n Can be optionally provided if Receiving Invitations flag is set to Yes and only if the subscriber returned is of a subscriber type 'Financial Institution' or 'Non-Transactional Panel Master'."
}
},
"title": "au.net.pexa.api.schema._2.SubscriberTransactionLimitations",
"xml": {
"name": "SubscriberTransactionLimitations",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.TaskDetailsType": {
"type": "object",
"properties": {
"dateCompleted": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateCompleted",
"attribute": false,
"wrapped": false
}
},
"dateCreated": {
"type": "string",
"format": "date-time",
"xml": {
"name": "DateCreated",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"taskId": {
"type": "string",
"xml": {
"name": "TaskId",
"attribute": false,
"wrapped": false
}
},
"type": {
"xml": {
"name": "Type",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.TypeDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.TaskDetailsType",
"xml": {
"name": "taskDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.TitleActivityResponse": {
"type": "object",
"properties": {
"documentReferences": {
"type": "array",
"xml": {
"name": "DocumentReference",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.NotificationDocumentReferenceDetailsType"
}
},
"lastPositiveTitleActivity": {
"type": "string",
"xml": {
"name": "LastPositiveTitleActivity",
"attribute": false,
"wrapped": false
}
},
"titleActivityEndTime": {
"type": "string",
"xml": {
"name": "TitleActivityEndTime",
"attribute": false,
"wrapped": false
}
},
"titleActivityIndicator": {
"type": "string",
"xml": {
"name": "TitleActivityIndicator",
"attribute": false,
"wrapped": false
}
},
"titleActivityStartTime": {
"type": "string",
"xml": {
"name": "TitleActivityStartTime",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.TitleActivityResponse",
"xml": {
"name": "TitleActivityResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.TrustDetailsType": {
"type": "object",
"properties": {
"trustIndicator": {
"type": "string",
"example": "Yes",
"xml": {
"name": "TrustIndicator",
"attribute": false,
"wrapped": false
}
},
"trustName": {
"type": "string",
"example": "MLC Super Fund",
"xml": {
"name": "TrustName",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.TrustDetailsType",
"xml": {
"name": "TrustDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.TypeDetailsType": {
"type": "object",
"properties": {
"key": {
"type": "string",
"xml": {
"name": "Key",
"attribute": false,
"wrapped": false
}
},
"value": {
"type": "string",
"xml": {
"name": "Value",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.TypeDetailsType",
"xml": {
"name": "typeDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationRequest": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"example": 208,
"xml": {
"name": "SubscriberId",
"attribute": false,
"wrapped": false
},
"description": "The PEXA internal reference for the subscriber initiating the API service call.
Note: Subscriber Id is optional for subscribers using token based authentication (OAuth 2.0 authorization code or client credentials flow).
Maximum 19 characters"
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails"
},
"requestLandTitleData": {
"type": "string",
"example": "Yes",
"xml": {
"name": "RequestLandTitleData",
"attribute": false,
"wrapped": false
},
"description": "Whether to obtain land title data as part of workspace creation.
Must be set to No if Parent Title is Yes or Role is CT Controller or Consentor. "
},
"jurisdiction": {
"type": "string",
"example": "VIC",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
}
},
"role": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
},
"description": "Valid values are dependent on the subscriber type."
},
"subscriberReference": {
"type": "string",
"example": "MAtter-1321",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
},
"description": " Maximum 200 characters
Subscribers workspace reference. Users may utilise this to associate the workspace with an internal file or matter. "
},
"workgroupId": {
"type": "string",
"example": 654,
"xml": {
"name": "WorkgroupId",
"attribute": false,
"wrapped": false
},
"description": " Maximum 19 characters
The identifier of the workgroup which the subscriber wishes to assign to the workspace upon creation.
If no workgroup is provided, the subscribers default workgroup will be assigned to the workspace being created. "
},
"financialSettlement": {
"type": "string",
"example": "Yes",
"xml": {
"name": "FinancialSettlement",
"attribute": false,
"wrapped": false
},
"description": " Must be set to No if Role is CT Controller or Consentor.
Can be set to Yes or No if Parent Title is 'Yes'. "
},
"settlementDate": {
"type": "string",
"format": "date-time",
"example": "2020-02-02",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
},
"description": " Must be populated if Financial Settlement is Yes and Parent Title = No.
If Financial Settlement is Yes and Parent Title is Yes a date can be optionally provided for the workspace.
Must not be provided when Financial Settlement is No.
The settlement date cannot be greater than 6 months into the future and must not be prior to the current date.
The settlement time will default to the first available time on the specified settlement date."
},
"settlementDateAndTime": {
"type": "string",
"format": "date-time",
"example": "2018-11-18T02:30:20.283Z",
"xml": {
"name": "SettlementDateAndTime",
"attribute": false,
"wrapped": false
},
"description": "Must be populated if Financial Settlement is Yes and Parent Title = No.
f Financial Settlement is Yes and Parent Title is Yes a date can be optionally provided for the workspace.
Must not be provided when Financial Settlement is No.
Must not be provided when SettlementDate is provided.
The settlement date cannot be greater than 6 months into the future and must not be prior to the current date.
The settlement time must be on the hour or half hour."
},
"participantSettlementAcceptanceStatus": {
"type": "string",
"example": "Accepted",
"xml": {
"name": "ParticipantSettlementAcceptanceStatus",
"attribute": false,
"wrapped": false
},
"description": "Ability to specify if the Settlement Date and Time should be considered accepted or pending when creating a workspace with settlement.
If the workspace does not require settlement, the participant settlement acceptance status must not be provided.
If the workspace does have settlement but no participant settlement acceptance status is provided, the subscribers default acceptance status will be used."
},
"transactionType": {
"type": "string",
"example": "Transfer",
"xml": {
"name": "TransactionType",
"attribute": false,
"wrapped": false
},
"description": "One of the following - Transfer or Non-Transfer. If not provided, it will be derived based on Role and FinancialSettlement."
},
"businessUnitType": {
"type": "string",
"example": "Retail",
"xml": {
"name": "BusinessUnitType",
"attribute": false,
"wrapped": false
},
"description": "One of the following - 'Commercial' or 'Retail'. Optional."
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"description": "Details of the client(s) being represented.
Party details must not be provided where Request Land Title Data is No with the exception of when Parent Title is Yes and the Role is Incoming Proprietor or Proprietor on Title.
If subscriber creating the party is of the Role Proprietor on Title, only an Incoming Proprietor party can be created.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails"
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationRequest",
"xml": {
"name": "WorkspaceCreationRequest",
"namespace": "http://api.pexa.net.au/schema/2/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails.LandTitle"
}
},
"parentTitle": {
"type": "string",
"example": "Yes",
"xml": {
"name": "ParentTitle",
"attribute": false,
"wrapped": false
},
"description": " Whether the land title reference is a parent title awaiting sub-division. This indicator applies to all land title references.
Must be set to No if Role is CT Controller or Consentor."
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails.LandTitle": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"example": "12345/987",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"unregisteredLotReference": {
"type": "string",
"example": "12345/982",
"xml": {
"name": "UnregisteredLotReference",
"attribute": false,
"wrapped": false
},
"description": " Maximum 333 characters
Valid character set: alphanumeric, hyphens, apostrophes, slashes, spaces, commas, brackets, colons, semi-colons and full stops only.
The unregistered lot references pending against the parent land title specified.
This field can be provided when the Parent Title is 'Yes' else must not be provided. "
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationRequest.LandTitleDetails.LandTitle",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails.Party"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails.Party": {
"type": "object",
"properties": {
"representingParty": {
"type": "string",
"example": "Yes",
"xml": {
"name": "RepresentingParty",
"attribute": false,
"wrapped": false
},
"description": "Indicator that the party is being represented by the subscriber. Only parties that are represented by the subscriber can be created except for the Proprietor on Title who can create an Incoming Proprietor party whom they dont represent.
When the Role Proprietor on Title creates an Incoming Proprietor party, this value must be set to No
For any other Role creating a party, this value must be set to Yes. "
},
"partyType": {
"type": "string",
"example": "Individual",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
},
"description": "All '%on Title' roles are invalid values."
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"description": "Must be provided if Party Type is Individual else must not be provided",
"$ref": "#/definitions/au.net.pexa.api.schema._2.FullNameType"
},
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"description": "Must be provided if Party Type is 'Organisation' else must not be provided",
"$ref": "#/definitions/au.net.pexa.api.schema._2.BusinessType"
},
"CurrentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"description": "One of the following 'Street Address' or Overseas Address",
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2Type"
},
"FutureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"description": "One of the following Street Address or Overseas Address",
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2Type"
},
"partyCapacityDetails": {
"xml": {
"name": "PartyCapacityDetails",
"attribute": false,
"wrapped": false
},
"description": "The capacity that the Incoming Proprietor or Proprietor on Title party is acting in. Provided as input to VIC transfer supporting document.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyCapacityDetailsType"
},
"trustDetails": {
"xml": {
"name": "TrustDetails",
"attribute": false,
"wrapped": false
},
"description": "The details of the trust for the Incoming Proprietor or Proprietor on Title party.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.TrustDetailsType"
},
"foreignPartyDetails": {
"xml": {
"name": "ForeignPartyDetails",
"attribute": false,
"wrapped": false
},
"description": "The foreign details of the Incoming Proprietor party who is foreign to Australia. Provided as input to QLD transfer supporting documents. If Foreign Party Details complex is not provided where jurisdiction of the workspace is QLD, Resident Party Indicator will default to Yes for Individuals and Foreign Party Indicator will default to No for all parties.",
"$ref": "#/definitions/au.net.pexa.api.schema._2.ForeignPartyDetailsType"
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationRequest.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationResponse": {
"type": "object",
"properties": {
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails"
},
"workspaceId": {
"type": "string",
"example": "PEXA2000456897",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
},
"description": " Maximum 13 characters
PEXA workspace number"
},
"workspaceStatus": {
"type": "string",
"example": "In Preparation",
"xml": {
"name": "WorkspaceStatus",
"attribute": false,
"wrapped": false
}
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails"
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationResponse",
"xml": {
"name": "WorkspaceCreationResponse",
"namespace": "http://api.pexa.net.au/schema/2/",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails.LandTitle"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails",
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails.LandTitle": {
"type": "object",
"properties": {
"obsoleteLandTitleReference": {
"type": "string",
"example": "12345/878",
"xml": {
"name": "ObsoleteLandTitleReference",
"attribute": false,
"wrapped": false
},
"description": "The land title reference sent as part of the request which is now obsolete."
},
"newLandTitleReference": {
"type": "string",
"example": "123456/987",
"xml": {
"name": "NewLandTitleReference",
"attribute": false,
"wrapped": false
},
"description": "The new land title reference which has superseded the obsolete land title reference."
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationResponse.LandTitleDetails.LandTitle",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"description": " Upon successful adding of the party to the workspace, return the newly added party detail record with a Party Id.
In the scenario this structure is not returned, this indicates the new party detail contains an error and the party has not been added to the workspace.
If the subscriber creates a workspace in the role of Proprietor on Title and Request Land Title Data is Yes, the list of Proprietor on Title parties will be returned. ",
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails.Party"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails",
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails.Party": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"example": 300,
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
},
"description": "Maximum 19 characters"
},
"partyType": {
"type": "string",
"example": "Individual",
"xml": {
"name": "PartyType",
"attribute": false,
"wrapped": false
}
},
"partyRole": {
"type": "string",
"example": "Incoming Mortgagee",
"xml": {
"name": "PartyRole",
"attribute": false,
"wrapped": false
}
},
"fullName": {
"xml": {
"name": "FullName",
"attribute": false,
"wrapped": false
},
"description": " Provided if Party Type is Individual
Not provided if on title party is an indeterminate party type",
"$ref": "#/definitions/au.net.pexa.api.schema._2.FullNameType"
},
"business": {
"xml": {
"name": "Business",
"attribute": false,
"wrapped": false
},
"description": "Provided if Party Type is Organisation
Not provided if on title party is an indeterminate party type",
"$ref": "#/definitions/au.net.pexa.api.schema._2.BusinessType"
},
"CurrentAddress": {
"xml": {
"name": "CurrentAddress",
"attribute": false,
"wrapped": false
},
"description": " One of the following Street Address or Overseas Address
Not provided for on title parties ",
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2Type"
},
"FutureAddress": {
"xml": {
"name": "FutureAddress",
"attribute": false,
"wrapped": false
},
"description": "One of the following Street Address or Overseas Address
Not provided for on title parties",
"$ref": "#/definitions/au.net.pexa.api.schema._2.Address2Type"
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceCreationResponse.PartyDetails.Party",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryBusinessEventsListDetailsType": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"xml": {
"name": "Count",
"attribute": false,
"wrapped": false
}
},
"events": {
"type": "array",
"xml": {
"name": "Event",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.EventDetailsType"
}
},
"moreData": {
"type": "string",
"xml": {
"name": "MoreData",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryBusinessEventsListDetailsType",
"xml": {
"name": "workspaceSummaryBusinessEventsListDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryDocumentSummaryDetailsType": {
"type": "object",
"properties": {
"lodgementCases": {
"type": "array",
"xml": {
"name": "LodgementCase",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.LodgementCaseDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryDocumentSummaryDetailsType",
"xml": {
"name": "workspaceSummaryDocumentSummaryDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryFeesDetailsType": {
"type": "object",
"properties": {
"feeItems": {
"type": "array",
"xml": {
"name": "FeeItem",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.FeeItemDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryFeesDetailsType",
"xml": {
"name": "workspaceSummaryFeesDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryLandTitleDetailsType": {
"type": "object",
"properties": {
"landTitles": {
"type": "array",
"xml": {
"name": "LandTitle",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryLandTitlesType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryLandTitleDetailsType",
"xml": {
"name": "workspaceSummaryLandTitleDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryLandTitlesType": {
"type": "object",
"properties": {
"landTitleReference": {
"type": "string",
"xml": {
"name": "LandTitleReference",
"attribute": false,
"wrapped": false
}
},
"parentTitle": {
"type": "string",
"xml": {
"name": "ParentTitle",
"attribute": false,
"wrapped": false
}
},
"propertyDetails": {
"type": "string",
"xml": {
"name": "PropertyDetails",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryLandTitlesType",
"xml": {
"name": "workspaceSummaryLandTitlesType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryParticipantDetailsType": {
"type": "object",
"properties": {
"participants": {
"type": "array",
"xml": {
"name": "Participant",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryParticipantType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryParticipantDetailsType",
"xml": {
"name": "workspaceSummaryParticipantDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryParticipantType": {
"type": "object",
"properties": {
"contactDetails": {
"xml": {
"name": "ContactDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspacesummaryParticipantContactDetailsType"
},
"subscriberName": {
"type": "string",
"xml": {
"name": "SubscriberName",
"attribute": false,
"wrapped": false
}
},
"workspaces": {
"type": "array",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryWorkspaceDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryParticipantType",
"xml": {
"name": "workspaceSummaryParticipantType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryPartyDetailsType": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.PartyDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryPartyDetailsType",
"xml": {
"name": "workspaceSummaryPartyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryPartyType": {
"type": "object",
"properties": {
"partyId": {
"type": "string",
"xml": {
"name": "PartyId",
"attribute": false,
"wrapped": false
}
},
"representingSelf": {
"type": "string",
"xml": {
"name": "RepresentingSelf",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryPartyType",
"xml": {
"name": "workspaceSummaryPartyType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryRepresentedPartyDetailsType": {
"type": "object",
"properties": {
"parties": {
"type": "array",
"xml": {
"name": "Party",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryPartyType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryRepresentedPartyDetailsType",
"xml": {
"name": "workspaceSummaryRepresentedPartyDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryResponse": {
"type": "object",
"properties": {
"businessEventsList": {
"xml": {
"name": "BusinessEventsList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryBusinessEventsListDetailsType"
},
"documentSummary": {
"xml": {
"name": "DocumentSummary",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryDocumentSummaryDetailsType"
},
"fees": {
"xml": {
"name": "Fees",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryFeesDetailsType"
},
"jurisdiction": {
"type": "string",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
}
},
"landTitleDetails": {
"xml": {
"name": "LandTitleDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryLandTitleDetailsType"
},
"participantDetails": {
"xml": {
"name": "ParticipantDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryParticipantDetailsType"
},
"partyDetails": {
"xml": {
"name": "PartyDetails",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryPartyDetailsType"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"settlementSchedule": {
"xml": {
"name": "SettlementSchedule",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummarySettlementScheduleDetailsType"
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"taskList": {
"xml": {
"name": "TaskList",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryTaskListDetailsType"
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryResponse",
"xml": {
"name": "WorkspaceSummaryResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummarySettlementScheduleDetailsType": {
"type": "object",
"properties": {
"lastModified": {
"type": "string",
"format": "date-time",
"xml": {
"name": "LastModified",
"attribute": false,
"wrapped": false
}
},
"overallSettlementAcceptanceStatus": {
"type": "string",
"xml": {
"name": "OverallSettlementAcceptanceStatus",
"attribute": false,
"wrapped": false
}
},
"settlementDate": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDate",
"attribute": false,
"wrapped": false
}
},
"settlementScheduleId": {
"type": "string",
"xml": {
"name": "SettlementScheduleId",
"attribute": false,
"wrapped": false
}
},
"signaturesReceived": {
"type": "integer",
"xml": {
"name": "SignaturesReceived",
"attribute": false,
"wrapped": false
}
},
"signaturesRequired": {
"type": "integer",
"xml": {
"name": "SignaturesRequired",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummarySettlementScheduleDetailsType",
"xml": {
"name": "workspaceSummarySettlementScheduleDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryTaskListDetailsType": {
"type": "object",
"properties": {
"tasks": {
"type": "array",
"xml": {
"name": "Task",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._2.TaskDetailsType"
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryTaskListDetailsType",
"xml": {
"name": "workspaceSummaryTaskListDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspaceSummaryWorkspaceDetailsType": {
"type": "object",
"properties": {
"representedParty": {
"xml": {
"name": "RepresentedParty",
"attribute": false,
"wrapped": false
},
"$ref": "#/definitions/au.net.pexa.api.schema._2.WorkspaceSummaryRepresentedPartyDetailsType"
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"settlementDateTimeAcceptance": {
"type": "string",
"xml": {
"name": "SettlementDateTimeAcceptance",
"attribute": false,
"wrapped": false
}
},
"status": {
"type": "string",
"xml": {
"name": "Status",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspaceSummaryWorkspaceDetailsType",
"xml": {
"name": "workspaceSummaryWorkspaceDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._2.WorkspacesummaryParticipantContactDetailsType": {
"type": "object",
"properties": {
"email": {
"type": "string",
"xml": {
"name": "Email",
"attribute": false,
"wrapped": false
}
},
"phone": {
"type": "string",
"xml": {
"name": "Phone",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._2.WorkspacesummaryParticipantContactDetailsType",
"xml": {
"name": "workspacesummaryParticipantContactDetailsType",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._3.WorkspaceRetrievalResponse": {
"type": "object",
"properties": {
"moreData": {
"type": "string",
"xml": {
"name": "MoreData",
"attribute": false,
"wrapped": false
}
},
"workspaces": {
"type": "array",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace"
}
}
},
"title": "au.net.pexa.api.schema._3.WorkspaceRetrievalResponse",
"xml": {
"name": "WorkspaceRetrievalResponse",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace": {
"type": "object",
"properties": {
"jurisdiction": {
"type": "string",
"xml": {
"name": "Jurisdiction",
"attribute": false,
"wrapped": false
}
},
"lastActivity": {
"type": "string",
"format": "date-time",
"xml": {
"name": "LastActivity",
"attribute": false,
"wrapped": false
}
},
"settlementDateAndTime": {
"type": "string",
"format": "date-time",
"xml": {
"name": "SettlementDateAndTime",
"attribute": false,
"wrapped": false
}
},
"subscribers": {
"type": "array",
"xml": {
"name": "Subscriber",
"attribute": false,
"wrapped": false
},
"items": {
"$ref": "#/definitions/au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace.Subscriber"
}
},
"workgroupId": {
"type": "string",
"xml": {
"name": "WorkgroupId",
"attribute": false,
"wrapped": false
}
},
"workspaceId": {
"type": "string",
"xml": {
"name": "WorkspaceId",
"attribute": false,
"wrapped": false
}
},
"workspaceStatus": {
"type": "string",
"xml": {
"name": "WorkspaceStatus",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace",
"xml": {
"name": "Workspace",
"attribute": false,
"wrapped": false
}
},
"au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace.Subscriber": {
"type": "object",
"properties": {
"participantSettlementAcceptanceStatus": {
"type": "string",
"xml": {
"name": "ParticipantSettlementAcceptanceStatus",
"attribute": false,
"wrapped": false
}
},
"role": {
"type": "string",
"xml": {
"name": "Role",
"attribute": false,
"wrapped": false
}
},
"subscriberReference": {
"type": "string",
"xml": {
"name": "SubscriberReference",
"attribute": false,
"wrapped": false
}
}
},
"title": "au.net.pexa.api.schema._3.WorkspaceRetrievalResponse.Workspace.Subscriber",
"xml": {
"name": "ChildWorkgroupList",
"attribute": false,
"wrapped": false
}
}
}
}