Add schema definitions for InvoicingFixedPricingDistributionResponse and related components in OpenAPI spec

2026-03-12 11:26:25 +01:00
parent bd36540f2b
commit be358309d6
1 changed files with 174 additions and 0 deletions
@@ -4932,6 +4932,10 @@ paths:
      responses:
        '200':
          description: Fixed pricing distribution retrieved successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/InvoicingFixedPricingDistributionResponse'

  /superuser/invoicing/period/distribution/wash-subscriptions:
    get:
@@ -8805,6 +8809,176 @@ components:
        - internal_total
        - order_ids

+    InvoicingFixedPricingDistributionResponse:
+      type: object
+      properties:
+        success:
+          type: boolean
+          example: true
+        data:
+          type: array
+          items:
+            $ref: '#/components/schemas/InvoicingFixedPricingDistributionCustomer'
+        meta:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionMeta'
+        includes:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionIncludes'
+      required:
+        - success
+        - data
+        - meta
+        - includes
+
+    InvoicingFixedPricingDistributionCustomer:
+      type: object
+      properties:
+        id:
+          type: integer
+        customer_number:
+          type: integer
+        customer_name:
+          type: string
+        transactions:
+          type: array
+          items:
+            $ref: '#/components/schemas/InvoicingFixedPricingDistributionTransaction'
+        requires_action:
+          type: boolean
+        meta:
+          type: object
+          properties:
+            fixed_pricing:
+              $ref: '#/components/schemas/InvoicingFixedPricingDistributionFixedPricing'
+          required:
+            - fixed_pricing
+      required:
+        - id
+        - customer_number
+        - customer_name
+        - transactions
+        - requires_action
+        - meta
+
+    InvoicingFixedPricingDistributionTransaction:
+      type: object
+      properties:
+        id:
+          type: integer
+        date:
+          type: string
+          description: Datetime in `YYYY-MM-DD HH:mm:ss` format.
+          example: '2026-02-02 10:43:41'
+        amount:
+          type: number
+        booked:
+          type: boolean
+        excluded:
+          type: boolean
+      required:
+        - id
+        - date
+        - amount
+        - booked
+        - excluded
+
+    InvoicingFixedPricingDistributionFixedPricing:
+      type: object
+      properties:
+        customer_number:
+          type: integer
+        price:
+          type: number
+        description:
+          type: string
+        original_price:
+          type: number
+        department_totals:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionNumberMapOrEmptyArray'
+        department_totals_relative:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionNumberMapOrEmptyArray'
+      required:
+        - customer_number
+        - price
+        - description
+        - original_price
+        - department_totals
+        - department_totals_relative
+
+    InvoicingFixedPricingDistributionMeta:
+      type: object
+      properties:
+        date_from:
+          type: string
+          description: Datetime in `YYYY-MM-DD HH:mm:ss` format.
+          example: '2026-02-01 00:00:00'
+        date_to:
+          type: string
+          description: Datetime in `YYYY-MM-DD HH:mm:ss` format.
+          example: '2026-02-28 23:59:59'
+      required:
+        - date_from
+        - date_to
+
+    InvoicingFixedPricingDistributionIncludes:
+      type: object
+      properties:
+        debug_invoicing_period_customers_with_orders_in_date_range:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionExecutionTime'
+        debug_invoicing_period_process_customer_numbers:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionExecutionTime'
+        debug_invoicing_period_get_transactions_for_customers_in_date_range:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionExecutionTime'
+        debug_invoicing_period_calculate_transaction_totals:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionExecutionTime'
+        debug_invoicing_period_construct_customer_objects:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionExecutionTime'
+        collective_fixed_pricing_results:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionCollectiveResults'
+      additionalProperties: true
+
+    InvoicingFixedPricingDistributionExecutionTime:
+      type: object
+      properties:
+        execution_time:
+          type: number
+      required:
+        - execution_time
+
+    InvoicingFixedPricingDistributionCollectiveResults:
+      type: object
+      properties:
+        total_fixed_price:
+          type: number
+        total_original_price:
+          type: number
+        total_department_totals:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionNumberMapOrEmptyArray'
+        total_department_totals_relative:
+          $ref: '#/components/schemas/InvoicingFixedPricingDistributionNumberMapOrEmptyArray'
+        total_department_totals_parsed:
+          type: object
+          additionalProperties:
+            type: number
+        total_department_totals_relative_parsed:
+          type: object
+          additionalProperties:
+            type: number
+      required:
+        - total_fixed_price
+        - total_original_price
+        - total_department_totals
+        - total_department_totals_relative
+        - total_department_totals_parsed
+        - total_department_totals_relative_parsed
+
+    InvoicingFixedPricingDistributionNumberMapOrEmptyArray:
+      oneOf:
+        - type: object
+          additionalProperties:
+            type: number
+        - type: array
+          maxItems: 0
+
    SelfServeLaneStatus:
      type: object
      properties: