PEXA Projects API is one of 5 APIs that PEXA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
14 operations
across 10 paths,
organized into 3 resource areas,
and defines 87 schemas.
It is described by OpenAPI 3.0.3, at version v4.
Requests are made against a single base URL, {{ service.url }}.
The identity and technical contract details declared by the specification.
Errors
object
List of errors related to the API
1 property
Error
object
Error related to the API
3 properties
Project
object
Object with all required details for a Project
20 properties
9 required
QldPropertyDetails
object
Property details for the QLD jurisdiction
4 properties
NswPropertyDetails
object
Property details for the NSW jurisdiction
2 properties
VicPropertyDetails
object
Property details for the VIC jurisdiction
7 properties
1 required
QldWorkspaceDetails
object
Workspace details for the QLD jurisdiction
7 properties
Jurisdiction
string
Jurisdiction
SupplierDetails
object
Details for the supplier
9 properties
8 required
SafetySwitch
object
A safety switch is a device that quickly switches off the electric supply if an electric fault is detected, to minimise the risk of electricity -related fires,…
2 properties
SmokeAlarm
object
Smoke alarm are the devices that are able to detect smoke in the event of a fire and sound an alarm to alert people to the potential danger. In QLD, it's a leg…
2 properties
MotParticipants
object
Details on incoming mortgagees
4 properties
3 required
CurrentLandUse
string
Current land use
PrimaryConstructionType
string
Material used to construct the property. Example - Timber, Brick etc
PrimaryLandUse
string
For which purpose the land will be used for. Example - dwelling, carpark, flat multi-storey etc
ProjectStatus
object
Status details of a project
8 properties
WorkspaceCountsByStatuses
object
Counts for various properties of workspaces under the project
6 properties
InvitationAcceptanceStatus
object
Counts of the various statuses for an invitation
4 properties
SettlementDateAcceptanceStatus
object
Counts for settlement date acceptance
2 properties
ProjectsWorkspace
object
Details of a workspace
11 properties
Workspace
object
Object with all required details for a workspace
8 properties
2 required
GstWithholdingStatus
string
The status of GST withholding. Can be one of the following: MATCHING - Form one lodged via PEXA and GST line item created MANUAL - Form one not lodged via PEXA…
SettlementDateStatus
string
The overall status of settlement date acceptance. Can be one of the following: ACCEPTED - All Accepted PARTIALLYACCEPTED - Pending others PENDING - Pending NOA…
ParticipantSettlementDateStatus
string
The status of settlement date acceptance by a participant. Can be one of the following: ACCEPTED - Accepted PENDING - Awaiting Response
IncomingProprietor
object
Details for an Incoming Proprietor
2 properties
2 required
UpdateWorkspaceRequest
object
Request to update a workspace
2 properties
UpdateWorkspaceResponse
object
Response to updating a workspace
3 properties
SettlementUploadRequest
object
2 properties
Schedule
object
1 property
Schedule.LineItem
object
10 properties
Schedule.LineItem.AccountDetails
object
2 properties
Schedule.LineItem.AccountDetails.Destination
object
4 properties
Schedule.LineItem.AccountDetails.Destination.Account
object
3 properties
Schedule.LineItem.AccountDetails.Destination.BPay
object
2 properties
Schedule.LineItem.AccountDetails.Source
object
2 properties
SettlementUploadResponse
object
1 property
WarningResponseType
object
2 properties
AddPartiesRequest
object
Request to add parties to an existing workspace
1 property
Party
object
A party
9 properties
3 required
AddPartiesResponse
object
Response when adding parties
2 properties
PartyResponse
object
Response object for a party
4 properties
UpdatePartiesRequest
object
Request to update parties on an existing workspace
1 property
1 required
UpdateParty
object
A party
10 properties
4 required
DeletePartiesRequest
object
Request to delete parties on an existing workspace
1 property
1 required
DeleteParty
object
Party to be deleted
1 property
1 required
AddParticipantsRequest
object
Request to add participants to an existing workspace
1 property
AddParticipantsResponse
object
Response when adding participants
2 properties
ResponseParticipant
object
Response object when adding a participant
6 properties
DeleteParticipantsRequest
object
Request to delete participants
1 property
ProposeSettlementRequest
object
Request to propose settlement dates
2 properties
RetrieveNotificationsResponse
object
The response containing notifications
1 property
NotificationsListType
object
A list of notifications
5 properties
NotificationType
object
Notification type
13 properties
NotificationTypeKeyValue
object
Key/Value of the notification type
2 properties
SubscriberReferenceType
object
The subscriber reference
2 properties
NotificationDetailsType
object
Details about the notification
11 properties
NotificationFinancialLineItemType
object
A financial line item
5 properties
NotificationInvitationDetailsType
object
Details on an invitation
2 properties
NotificationInvitationOutstandingDetailsType
object
Details on a outstanding invitation
10 properties
NotificationInvitationOutstandingLandTitleDetailsType
object
Details on invitations outstanding land title
2 properties
NotificationInvitationOutstandingLandTitleType
object
The outstanding land titles
1 property
NotificationInvitationOutstandingPartyType
object
The outstanding party type
1 property
NotificationInvitationOutstandingPartyDetailsType
object
Details on an outstanding party invitation
4 properties
PartyNameDetailsType
object
Details for a party name
2 properties
BusinessType
object
The business type
6 properties
AdministrationStatusDetailsType
object
Details on administration status
1 property
FullNameType
object
A full name including titles, suffixes and date of birth
6 properties
GivenNameOrderType
object
The given name order
2 properties
NotificationInvitationOutstandingInviterSubscriberDetailsType
object
Details on an outstanding inviter
6 properties
NotificationInvitationOutstandingInviterSubscriberDetailsRepresenting
object
Details on outstanding inviter subscriber details for a representing party
1 property
NotificationInvitationOutstandingInviterSubscriberDetailsRepresentingPartyType
object
Details on outstanding inviter subscriber details for a representing party
3 properties
NotificationInvitationResponseDetailsType
object
Details on invitation responses
6 properties
NotificationLandTitleDetailsType
object
Details on the land title
3 properties
NotificationTitleActivityCheck
object
Title activity check details
2 properties
NotificationAdministrativeActionReferenceDetailsType
object
Details on the administrative action reference
2 properties
NotificationDocumentReferenceDetailsType
object
Details on the document reference
3 properties
NotificationDocumentStatusDetailsType
object
Details on the document status
2 properties
PropertyDetailsType
object
Details on a property
2 properties
NotificationPartyDetailsType
object
Details on parties
3 properties
NotificationDocumentDetailsType
object
Details on Documents
3 properties
NotificationSettlementScheduleDetailsType
object
Details about settlement schedules
1 property
NotificationSettlementDetailsType
object
Details about settlement
2 properties
NotificationLodgementDetailsType
object
Details on lodgements
3 properties
NotificationLodgementDocumentDetailsType
object
Details about lodgement documents
7 properties
NotificationParticipantDetailsType
object
Details about conversation participants
2 properties
NotificationConversationDetailsType
object
Details about a conversation
2 properties
IdentificationDetailsType
object
An object describing how to identify an external party
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs PEXA publishes across the network.
