Socotra Billing API

openapi: 3.0.1
info:
  title: Socotra Insurance Suite OpenAPI Definition Billing API
  description: Socotra Insurance Suite API
  termsOfService: https://www.socotra.com
  version: v0
servers:
- url: /
  description: Generated server url
tags:
- name: Billing
paths:
  /billing/{tenantLocator}/payments/{locator}:
    get:
      operationId: fetchPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Billing
    put:
      operationId: updatePaymentOverwriteData
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
    patch:
      operationId: updatePayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/disbursements/{locator}:
    get:
      operationId: fetchDisbursement
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Billing
    put:
      operationId: updateDisbursementReplaceData
      description: Updates the disbursement and replaces all existing data extensions with the data.
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisbursementUpdateReplaceDataRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
    patch:
      operationId: updateDisbursement
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisbursementUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/creditDistributions/{locator}:
    get:
      operationId: fetchCreditDistribution
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditDistributionResponse'
                deprecated: false
      x-securityGroup: credit-distributions
      x-securityPermission:
      - read
      deprecated: false
      tags:
      - Billing
    put:
      operationId: createOrReplaceCreditDistribution
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditDistributionPutRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditDistributionResponse'
                deprecated: false
      x-securityGroup: credit-distributions
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
    patch:
      operationId: updateCreditDistribution
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditDistributionUpdateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditDistributionResponse'
                deprecated: false
      x-securityGroup: credit-distributions
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/writeOffs:
    post:
      operationId: writeOff
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WriteOffRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WriteOffResponse'
                deprecated: false
      x-securityGroup: write-offs
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/retryJobs/{policyLocator}/retryFailedTransactions:
    post:
      operationId: retryFailedTransactions
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: policyLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPageResponseInstallmentJobData'
                deprecated: false
      x-securityGroup: retry-jobs
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments:
    post:
      operationId: createPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/number/set:
    post:
      operationId: setPaymentNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: paymentNumber
        in: query
        required: true
        schema:
          type: string
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/number/generate:
    post:
      operationId: generatePaymentNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/jobs/delinquencies/moratoriums:
    post:
      operationId: runDelinquencyMoratoriumsWorkflow
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      responses:
        '200':
          description: OK
      x-securityGroup: jobs
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices:
    post:
      operationId: createAggregatedInvoice
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AggregatedInvoiceCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices/{locator}/transfer:
    post:
      operationId: transferInvoicesBetweenAggregatedInvoices
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AggregatedInvoiceTransferRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices/{locator}/settle:
    post:
      operationId: settleNegativeOrZeroInvoice
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: forced
        in: query
        required: false
        schema:
          type: boolean
          default: false
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPageResponseCreditDistributionResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices/{locator}/number/set:
    post:
      operationId: setInvoiceNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: invoiceNumber
        in: query
        required: true
        schema:
          type: string
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices/{locator}/number/generate:
    post:
      operationId: generateInvoiceNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/invoices/earlyInvoicing:
    post:
      operationId: initiateEarlyInvoicing
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EarlyInvoicingRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EarlyInvoicingResponse'
                deprecated: false
      x-securityGroup: invoices
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/holds:
    post:
      operationId: createHold
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HoldCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HoldResponse'
                deprecated: false
      x-securityGroup: holds
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/financialInstruments:
    post:
      operationId: createFinancialInstrument
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FinancialInstrumentCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialInstrumentResponse'
                deprecated: false
      x-securityGroup: financial-instruments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/financialInstruments/{locator}/setAsDefault:
    post:
      operationId: setFinancialInstrumentAsDefault
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: value
        in: query
        required: false
        schema:
          type: boolean
          default: true
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FinancialInstrumentResponse'
                deprecated: false
      x-securityGroup: financial-instruments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/disbursements:
    post:
      operationId: createDisbursement
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisbursementCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/disbursements/{locator}/number/set:
    post:
      operationId: setDisbursementNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      - name: disbursementNumber
        in: query
        required: true
        schema:
          type: string
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/disbursements/{locator}/number/generate:
    post:
      operationId: generateDisbursementNumber
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DisbursementResponse'
                deprecated: false
      x-securityGroup: disbursements
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/creditDistributions:
    post:
      operationId: createCreditDistribution
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditDistributionCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditDistributionResponse'
                deprecated: false
      x-securityGroup: credit-distributions
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/accounts/{accountLocator}/charges:
    post:
      operationId: addCharges
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: accountLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargesCreateRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/ChargeResponse'
                  deprecated: false
      x-securityGroup: charges
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/accounts/{accountLocator}/charges/reverse:
    post:
      operationId: reverseCharges
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: accountLocator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChargesReversalRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                deprecated: false
                items:
                  $ref: '#/components/schemas/ChargeResponse'
                  deprecated: false
      x-securityGroup: charges
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/writeOffs/{locator}/reverse:
    patch:
      operationId: reverseWriteOff
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WriteOffResponse'
                deprecated: false
      x-securityGroup: write-offs
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/validate:
    patch:
      operationId: validatePayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/reverse:
    patch:
      operationId: reversePayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreditDistributionReverseRequest'
              deprecated: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/reset:
    patch:
      operationId: resetPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/request:
    patch:
      operationId: executePayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/post:
    patch:
      operationId: postPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/fail:
    patch:
      operationId: failPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          format: ulid
          deprecated: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
                deprecated: false
      x-securityGroup: payments
      x-securityPermission:
      - write
      deprecated: false
      tags:
      - Billing
  /billing/{tenantLocator}/payments/{locator}/discard:
    patch:
      operationId: discardPayment
      parameters:
      - name: tenantLocator
        in: path
        required: true
        schema:
          type: string
          format: uuid
          deprecated: false
      - name: locator
        in: path
        required: true
        schema:
          type: string
          fo

# --- truncated at 32 KB (258 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-billing-api-openapi.yml