{ "swagger": "2.0", "info": { "description": "Welcome to our Exchange documentation! For best results, please download the current XSD definitions: [Link to our XSDs](../../docs/assets/pexa-xsd.zip). \n\nFor a short tutorial on navigating our API reference documentation [Click here](https://youtu.be/B0dYqYJiWfc).", "version": "1.0", "title": "PEXA Exchange API" }, "host": "localhost", "basePath": "/", "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": { "/health": { "get": { "tags": ["HealthCheck"], "summary": "Health Check", "description": "This API verifies whether the application is up and running.", "operationId": "HealthCheck", "produces": ["application/xml"], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/v1/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.", "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 } }, "/v1/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 Click here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/subscriber/conversations": { "get": { "tags": ["Conversation"], "summary": "Retrieve Unread Conversations", "description": "This API retrieves a list of unread conversations. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/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.", "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 } }, "/v1/subscriber/invitation": { "put": { "tags": ["Invitation"], "summary": "Respond to invitation received", "description": "This API allows a subscriber to respond to a workspace invitation.", "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 } }, "/v1/subscriber/invitations": { "get": { "tags": ["Invitation"], "summary": "Retrieves outstanding invitations", "description": "This API provides details of outstanding invitations within a workgroup. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "operationId": "retrieveOutstandingInvitationsV1UsingGET", "produces": ["application/xml"], "parameters": [ { "name": "lastInviteId", "in": "query", "description": "lastInviteId", "required": false, "type": "string" }, { "name": "subscriberId", "in": "query", "description": "subscriberId", "required": false, "type": "string" }, { "name": "workgroupId", "in": "query", "description": "workgroupId", "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 } }, "/v1/subscriber/workgroups": { "get": { "tags": ["Subscriber"], "summary": "Retrieve Workgroups", "description": "This API retrieves PEXA workgroups and workgroup user assignments. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 not required for any subscribers using token based authentication (OAuth, SAML etc.). \nFor mutual SSL authentication, the Subscriber Id must be provided. \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 } }, "/v1/user": { "get": { "tags": ["User"], "summary": "Retrieves user profile", "description": "This API will return user profile which is belong to logged in user. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/workspace": { "put": { "tags": ["Workspace"], "summary": "Initiate Workspace Update", "description": "This API allows you to update data within a workspace. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/workspace/data": { "put": { "tags": ["Workspace"], "summary": "Manage default workspace data", "description": "This API gives the ability to change the default data within an API. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "operationId": "updateUsingPUT", "consumes": ["application/xml"], "produces": ["application/xml", "application/json"], "parameters": [ { "in": "body", "name": "manageWorkspaceDataRequest", "description": "manageWorkspaceDataRequest", "required": true, "schema": { "$ref": "#/definitions/au.net.pexa.api.schema._1.ManageWorkspaceDataRequest" } } ], "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" } }, "deprecated": false } }, "/v1/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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/workspace/invitation": { "post": { "tags": ["Invitation"], "summary": "Create Workspace Invitation", "description": "This API allows a user to create and send an invitation to another subscriber to join a workspace. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v1/workspace/settlement": { "get": { "tags": ["Settlement"], "summary": "Retrieves Settlement Availability", "description": "This API provides a list of settlement times for a given date. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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.", "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 } }, "/v1/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.", "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 } }, "/v1/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.", "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 } }, "/v1/workspace/{workspaceId}/settlement/balanceDueToEffectSettlement": { "get": { "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.", "operationId": "createUsingGET", "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" } }, "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.", "operationId": "createUsingPUT", "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 } }, "/v2/subscriber": { "get": { "tags": ["Subscriber"], "summary": "Search Subscriber", "description": "The Subscriber API gives you the ability to search for active subscribers registered in PEXA.", "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 } }, "/v2/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.", "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 } }, "/v2/workspace": { "get": { "tags": ["Workspace"], "summary": "Retrieves workspace summary", "description": "This API provides a summary of the workspace details.", "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. \nClick here for [XSDs](../../docs/assets/pexa-xsd.zip).", "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 } }, "/v3/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.", "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" }, "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": { "borrowersMortgagorsNames": { "type": "string", "xml": { "name": "BorrowersMortgagorsNames", "attribute": false, "wrapped": false } }, "customerAccountLoanNumber": { "type": "string", "xml": { "name": "CustomerAccountLoanNumber", "attribute": false, "wrapped": false } }, "notes": { "type": "string", "xml": { "name": "Notes", "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 } }, "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.CreateWorkspaceInvitationRequest", "xml": { "name": "CreateWorkspaceInvitationRequest", "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", "properties": { "inviteId": { "type": "string", "xml": { "name": "InviteId", "attribute": false, "wrapped": false } }, "forwardedBy": { "type": "string", "xml": { "name": "ForwardedBy", "attribute": false, "wrapped": false } }, "date": { "type": "string", "format": "date-time", "xml": { "name": "Date", "attribute": false, "wrapped": false } }, "status": { "type": "string", "xml": { "name": "Status", "attribute": false, "wrapped": false } }, "workspaceId": { "type": "string", "xml": { "name": "WorkspaceId", "attribute": false, "wrapped": false } }, "workspaceRole": { "type": "string", "xml": { "name": "WorkspaceRole", "attribute": false, "wrapped": false } }, "landTitleDetails": { "xml": { "name": "LandTitleDetails", "attribute": false, "wrapped": false }, "$ref": "#/definitions/au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails" }, "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 } }, "inviteeSubscriberName": { "type": "string", "xml": { "name": "InviteeSubscriberName", "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 } } }, "title": "au.net.pexa.api.schema._1.InvitationRetrievalResponse.Invite.LandTitleDetails.LandTitle", "xml": { "name": "LandTitle", "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.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: