openapi: 3.2.0
info:
  title: Pexa Settlement API
  version: '1.0'
  description: 'Operations tagged Settlement across 2 of this provider''s published API definitions: pexa-exchange-api-legacy-swagger.json, pexa-exchange-api-swagger.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://localhost/
tags:
- name: Settlement
paths:
  /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
      parameters:
      - name: subscriberId
        in: query
        description: subscriberId
        required: false
        schema:
          type: string
      - name: subscriberRole
        in: query
        description: subscriberRole
        required: false
        schema:
          type: string
      - name: workspaceId
        in: query
        description: workspaceId
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/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
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest'
        description: settlementUploadRequest
        required: true
    servers:
    - url: https://localhost/
  /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
      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
        allowEmptyValue: false
        schema:
          type: string
      - name: settlementDate
        in: query
        description: All available times will be retrieved for the settlement date provided.
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - name: subscriberId
        in: query
        description: The PEXA internal reference for the subscriber initiating the API service call. <br/> Maximum 19 characters
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - 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
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/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
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest'
        description: request
        required: true
    servers:
    - url: https://localhost/
  /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
      parameters:
      - name: subscriberId
        in: query
        description: subscriberId
        required: false
        schema:
          type: string
      - name: subscriberRole
        in: query
        description: subscriberRole
        required: false
        schema:
          type: string
      - name: workspaceId
        in: query
        description: workspaceId
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: string
                format: byte
            application/pdf:
              schema:
                type: string
                format: byte
            application/json:
              schema:
                type: string
                format: byte
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    servers:
    - url: https://localhost/
  /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
      parameters:
      - name: role
        in: query
        description: role
        required: false
        schema:
          type: string
      - name: workspaceId
        in: path
        description: workspaceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest'
        description: balanceDueToEffectSettlementRequest
        required: true
    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
      parameters:
      - name: role
        in: query
        description: role
        required: false
        schema:
          type: string
      - name: workspaceId
        in: path
        description: workspaceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest'
        description: balanceDueToEffectSettlementRequest
        required: true
    servers:
    - url: https://localhost/
  /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
      parameters:
      - name: subscriberId
        in: query
        description: subscriberId
        required: false
        schema:
          type: string
      - name: subscriberRole
        in: query
        description: subscriberRole
        required: false
        schema:
          type: string
      - name: workspaceId
        in: query
        description: workspaceId
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/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
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadResponse'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest'
        description: settlementUploadRequest
        required: true
  /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
      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
        allowEmptyValue: false
        schema:
          type: string
      - name: settlementDate
        in: query
        description: All available times will be retrieved for the settlement date provided.
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - name: subscriberId
        in: query
        description: The PEXA internal reference for the subscriber initiating the API service call. <br/> Maximum 19 characters
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - 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
        allowEmptyValue: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/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
      responses:
        '200':
          description: OK
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest'
        description: request
        required: true
  /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
      parameters:
      - name: subscriberId
        in: query
        description: subscriberId
        required: false
        schema:
          type: string
      - name: subscriberRole
        in: query
        description: subscriberRole
        required: false
        schema:
          type: string
      - name: workspaceId
        in: query
        description: workspaceId
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: string
                format: byte
            application/pdf:
              schema:
                type: string
                format: byte
            application/json:
              schema:
                type: string
                format: byte
        '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
      parameters:
      - name: role
        in: query
        description: role
        required: true
        schema:
          type: string
      - name: workspaceId
        in: path
        description: workspaceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse_2'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
    put:
      tags:
      - Settlement
      summary: Add/Update/Agree Balance due to effect Settlement
      description: "This API allows you to set the balance amount due to the vendor that is likely to effect the settlement.  \n\n \n[See details](../../docs/definitions/set_balanceduetoeffect_settlement/) to learn more about this API.\n\n Scopes:\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: updateBalanceDueToEffectSettlementUsingPUT
      parameters:
      - name: role
        in: query
        description: role
        required: false
        schema:
          type: string
      - name: workspaceId
        in: path
        description: workspaceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse_2'
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
      requestBody:
        content:
          application/xml:
            schema:
              $ref: '#/components/schemas/au.net.pexa.api.schema._1.BalanceDueToEffectSettlementRequest'
        description: balanceDueToEffectSettlementRequest
        required: true
components:
  schemas:
    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.SettlementStatementRetrieval.Documents.Document:
      type: object
      properties:
        documentId:
          type: string
          xml:
            name: DocumentId
            attribute: false
            wrapped: false
        mimeType:
          type: string
          xml:
            name: MimeType
            attribute: false
            wrapped: false
        renderedDocument:
          type: string
          format: byte
          xml:
            name: RenderedDocument
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document
      xml:
        name: Document
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails:
      type: object
      properties:
        destination:
          xml:
            name: Destination
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination'
        source:
          xml:
            name: Source
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source'
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails
      xml:
        name: AccountDetails
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementAvailabilityResponse:
      type: object
      properties:
        availableSettlementTime:
          xml:
            name: AvailableSettlementTime
            attribute: false
            wrapped: false
          description: List of the all available settlement times based on the settlement date above. <br/> If Settlement Availability is No, then this will not be provided.
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.AvailableSettlementTimeType'
        settlementAvailability:
          type: string
          xml:
            name: SettlementAvailability
            attribute: false
            wrapped: false
          description: A flag to indicate if there are any available times based on the settlement date provided.
        settlementDate:
          type: string
          format: date-time
          xml:
            name: SettlementDate
            attribute: false
            wrapped: false
          description: The settlement date provided in the request which will be used to check available times.
      title: au.net.pexa.api.schema._1.SettlementAvailabilityResponse
      xml:
        name: SettlementAvailabilityResponse
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay:
      type: object
      properties:
        billerCode:
          type: string
          xml:
            name: BillerCode
            attribute: false
            wrapped: false
        reference:
          type: string
          xml:
            name: Reference
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay
      xml:
        name: BPay
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents:
      type: object
      properties:
        document:
          xml:
            name: Document
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents.Document'
      title: au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents
      xml:
        name: Documents
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.AvailableSettlementTimeType:
      type: object
      properties:
        times:
          type: array
          xml:
            name: Time
            attribute: false
            wrapped: false
          description: Available settlement time (in UTC) for the date provided. <br/> If Settlement Availability is No, then this will not be provided. <br/> 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.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source:
      type: object
      properties:
        defaultAccount:
          type: string
          xml:
            name: DefaultAccount
            attribute: false
            wrapped: false
        preverifiedAccount:
          type: string
          xml:
            name: PreverifiedAccount
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Source
      xml:
        name: Source
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account:
      type: object
      properties:
        accountBsb:
          type: string
          xml:
            name: AccountBsb
            attribute: false
            wrapped: false
        accountName:
          type: string
          xml:
            name: AccountName
            attribute: false
            wrapped: false
        accountNumber:
          type: string
          xml:
            name: AccountNumber
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account
      xml:
        name: Account
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementDetailsType:
      type: object
      properties:
        settlementDateAndTime:
          type: string
          format: date-time
          xml:
            name: SettlementDateAndTime
            attribute: false
            wrapped: false
          description: The proposed date and time for settlement (in UTC)
        participantSettlementAcceptanceStatus:
          type: string
          example: Accepted
          xml:
            name: ParticipantSettlementAcceptanceStatus
            attribute: false
            wrapped: false
          description: Ability to specify if the Settlement Date and Time should be considered accepted or pending when proposing a new date and time. <br/> If no participant settlement acceptance status is provided, the subscribers default acceptance status will be used. Valid values are <br/> <li> Accepted (Set the Participants Settlement Acceptance Status to the Accepted status.) <li> Pending (Set the Participants Settlement Acceptance Status to the Pending status. )
        reason:
          type: string
          example: Default settlement time is not my preferred Settlement time.
          xml:
            name: Reason
            attribute: false
            wrapped: false
          description: The reason for updating the settlement date/time in the workspace. <br/> Maximum 100 characters
      title: au.net.pexa.api.schema._1.SettlementDetailsType
      xml:
        name: SettlementDetails
        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. <br/> Maximum 19 characters
        workspaceId:
          type: string
          example: PEXA190080044
          xml:
            name: WorkspaceId
            attribute: false
            wrapped: false
          description: PEXA workspace number. <br/> 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. <br/> If the subscriber is acting in multiple roles within the workspace, only one role must be provided. <br/> Only the following roles can be provided to maintain settlement date and time within the workspace: <ul> <li> Incoming Mortgagee <li> Mortgagee on Title  <li> Incoming Proprietor  <li> Proprietor on Title  <li> Incoming Caveator <ul/>'
        settlementActionType:
          type: string
          example: Propose new date and time
          xml:
            name: SettlementActionType
            attribute: false
            wrapped: false
          description: 'Valid values are <br/> <li> Accept (Accept the Settlement Date/Time which has been proposed) <li> Reset to pending (Reset prior acceptance of settlement date and time to the status of Pending. )  <li> Propose new date and time(Propose a new Settlement date and time with a reason of change set) '
        settlementDateAndTime:
          type: string
          format: date-time
          xml:
            name: SettlementDateAndTime
            attribute: false
            wrapped: false
          description: The settlement date/time is provided (in UTC) to ensure the participant settlement acceptance status is being set against the settlement date/time which is currently in the workspace. <br/> If the settlement date/time provided here differs to that of the workspace, an error will be returned advising that the settlement details are misaligned. <br/> Must be provided when the Settlement Action Type is 'Accepted' or 'Reset to pending'. Must not be provided when the Settlement Action Type is Propose new date and time.
        settlementDetails:
          xml:
            name: SettlementDetails
            attribute: false
            wrapped: false
          description: The settlement date and time details to set/propose in the workspace. <br/> Must be provided if the Settlement Action Type is Propose new date and time. <br/> Must not be provided if Settlement Action Type is Reset to pending or Accepted.
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementDetailsType'
      title: au.net.pexa.api.schema._1.MaintainSettlementDateAndTimeRequest
      xml:
        name: MaintainSettlementDateAndTimeRequest
        namespace: http://api.pexa.net.au/schema/1/
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementStatementRetrieval:
      type: object
      properties:
        documents:
          xml:
            name: Documents
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementStatementRetrieval.Documents'
        workspaceId:
          type: string
          xml:
            name: WorkspaceId
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementStatementRetrieval
      xml:
        name: SettlementStatementRetrieval
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadResponse:
      type: object
      properties:
        warning:
          xml:
            name: Warning
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.WarningResponseType'
      title: au.net.pexa.api.schema._1.SettlementUploadResponse
      xml:
        name: SettlementUploadResponse
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.WarningResponseType:
      type: object
      properties:
        code:
          type: string
          xml:
            name: Code
            attribute: false
            wrapped: false
        message:
          type: string
          xml:
            name: Message
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.WarningResponseType
      xml:
        name: warningResponseType
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination:
      type: object
      properties:
        account:
          xml:
            name: Account
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.Account'
        bpay:
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination.BPay'
        officeAccount:
          type: string
          xml:
            name: OfficeAccount
            attribute: false
            wrapped: false
        preverifiedAccount:
          type: string
          xml:
            name: PreverifiedAccount
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails.Destination
      xml:
        name: Destination
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem:
      type: object
      properties:
        accountDetails:
          xml:
            name: AccountDetails
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem.AccountDetails'
        associatedSubscriber:
          type: string
          xml:
            name: AssociatedSubscriber
            attribute: false
            wrapped: false
        category:
          type: string
          xml:
            name: Category
            attribute: false
            wrapped: false
        clientName:
          type: string
          xml:
            name: ClientName
            attribute: false
            wrapped: false
        customCategory:
          type: string
          xml:
            name: CustomCategory
            attribute: false
            wrapped: false
        transactionDescription:
          type: string
          xml:
            name: TransactionDescription
            attribute: false
            wrapped: false
        type:
          type: string
          xml:
            name: Type
            attribute: false
            wrapped: false
        value:
          type: number
          xml:
            name: Value
            attribute: false
            wrapped: false
        verified:
          type: string
          xml:
            name: Verified
            attribute: false
            wrapped: false
        verifiedBy:
          type: string
          xml:
            name: VerifiedBy
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem
      xml:
        name: LineItem
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule:
      type: object
      properties:
        lineItems:
          type: array
          items:
            $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule.LineItem'
      title: au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule
      xml:
        name: Schedule
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.SettlementUploadRequest:
      type: object
      properties:
        role:
          type: string
          xml:
            name: Role
            attribute: false
            wrapped: false
        schedule:
          xml:
            name: Schedule
            attribute: false
            wrapped: false
          $ref: '#/components/schemas/au.net.pexa.api.schema._1.SettlementUploadRequest.Schedule'
        subscriberId:
          type: string
          xml:
            name: SubscriberId
            attribute: false
            wrapped: false
        workspaceId:
          type: string
          xml:
            name: WorkspaceId
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.SettlementUploadRequest
      xml:
        name: SettlementUploadRequest
        attribute: false
        wrapped: false
    au.net.pexa.api.schema._1.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_2:
      type: object
      properties:
        amount:
          type: number
          xml:
            name: Amount
            attribute: false
            wrapped: false
        status:
          type: string
          xml:
            name: Status
            attribute: false
            wrapped: false
      title: au.net.pexa.api.schema._1.BalanceDueToEffectSettlementResponse
      xml:
        name: BalanceDueToEffectSettlementResponse
        attribute: false
        wrapped: false
x-refined-from:
- pexa-exchange-api-legacy-swagger.json
- pexa-exchange-api-swagger.json