PEXA Exchange API

{
  "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 - <i>https://api.pexa.com.au/api/rest</i> (prod)\n - <i>https://api-tst.pexalabs.com.au/api/rest</i> (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:\n<i>au_pub_cert_pexa_healthcheck_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_healthcheck_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_landtitle_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_landtitle_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_conversation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_conversation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_conversation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_invitation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_invitation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_subscriber_api_v3_read</i> (non-prod)\n<i>au_pub_pexa_subscriber_api_v3_read</i> (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:\n<i>au_pub_cert_pexa_user_api_v3_read</i> (non-prod)\n<i>au_pub_pexa_user_api_v3_read</i> (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:\n<i>au_pub_cert_pexa_workspace_api_v4_write</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v4_write</i> (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:\n<i>au_pub_cert_pexa_documents_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_documents_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_documents_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_documents_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_workspace_api_v4_write</i> (non-prod)\n<i>au_pub_pexa_workspace_api_v4_write</i> (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:\n<i>au_pub_cert_pexa_financial_settlement_schedule_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_financial_settlement_schedule_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_financial_settlement_schedule_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_financial_settlement_schedule_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_invitation_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_invitation_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_settlement_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_read</i> (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.<br/>This must not be provided if workspaceId is provided.<br/>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. <br/> Maximum 19 characters",
            "required": false,
            "type": "string",
            "allowEmptyValue": false
          },
          {
            "name": "workspaceId",
            "in": "query",
            "description": "PEXA workspace number.<br/>Used if wanting to find out the available settlement times for an existing created workspace.<br/>This must not be provided if jurisdiction is also provided.<br/>If jurisdiction is not provided, this field is mandatory.<br/>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:\n<i>au_pub_cert_pexa_settlement_api_v2_write</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_write</i> (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:\n<i>au_pub_cert_pexa_settlementcompletionrecord_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlementcompletionrecord_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_conversation_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_conversation_api_v2_read</i> (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:\n<i>au_pub_cert_pexa_settlement_api_v2_read</i> (non-prod)\n<i>au_pub_pexa_settlement_api_v2_read</i> (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": {
    

# --- truncated at 32 KB (350 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pexa/refs/heads/main/openapi/pexa-exchange-api-swagger.json