repzo 1.0.155 → 1.0.156

package/src/oas/refund.yaml

@@ -0,0 +1,281 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Refund
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Refund endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /refund:
+    get:
+      summary: Find refunds
+      operationId: findRefunds
+      parameters:
+        - in: query
+          name: params
+          schema:
+            type: object
+            properties:
+              _id:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              search:
+                type: string
+              client:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              rep:
+                oneOf:
+                  - type: array
+                    items:
+                      type: string
+                  - type: string
+              status:
+                type: string
+                enum: [pending, approved, rejected, processed]
+              from_date:
+                type: string
+                format: date-time
+              to_date:
+                type: string
+                format: date-time
+              from_updatedAt:
+                type: number
+              from__id:
+                type: string
+              to__id:
+                type: string
+              sortBy:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    field:
+                      type: string
+                      enum: [_id, createdAt, updatedAt, amount]
+                    type:
+                      type: string
+                      enum: [asc, desc]
+          description: Query parameters for filtering refunds
+      responses:
+        "200":
+          description: A list of refunds
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RefundFindResult"
+    post:
+      summary: Create a refund
+      operationId: createRefund
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RefundCreateBody"
+      responses:
+        "201":
+          description: Refund created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RefundCreateResult"
+  /refund/{id}:
+    get:
+      summary: Get a refund by ID
+      operationId: getRefund
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Refund details
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RefundGetResult"
+    put:
+      summary: Update a refund
+      operationId: updateRefund
+      parameters:
+        - in: path
+          name: id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/RefundUpdateBody"
+      responses:
+        "200":
+          description: Refund updated
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/RefundUpdateResult"
+components:
+  schemas:
+    RefundFindResult:
+      type: object
+      description: Result of finding refunds
+      properties:
+        data:
+          type: array
+          items:
+            $ref: "#/components/schemas/RefundSchema"
+        total_result:
+          type: number
+          description: Total number of refunds
+        current_count:
+          type: number
+          description: Count of refunds in current page
+        total_pages:
+          type: number
+          description: Total number of pages
+        current_page:
+          type: number
+          description: Current page number
+        per_page:
+          type: number
+          description: Number of refunds per page
+    RefundSchema:
+      type: object
+      description: Refund schema
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the refund
+        client:
+          type: string
+          description: Client ID associated with the refund
+        rep:
+          type: string
+          description: Representative ID who processed the refund
+        invoice:
+          type: string
+          description: Invoice ID being refunded
+        amount:
+          type: number
+          description: Refund amount
+        reason:
+          type: string
+          description: Reason for the refund
+        status:
+          type: string
+          enum: [pending, approved, rejected, processed]
+          description: Status of the refund
+        refundMethod:
+          type: string
+          description: Method of refund
+        reference:
+          type: string
+          description: Reference number for the refund
+        notes:
+          type: string
+          description: Additional notes
+        processedAt:
+          type: string
+          format: date-time
+          description: When the refund was processed
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+        company_namespace:
+          type: array
+          items:
+            type: string
+          description: Company namespaces
+        createdAt:
+          type: string
+          format: date-time
+          description: Creation timestamp
+        updatedAt:
+          type: string
+          format: date-time
+          description: Last update timestamp
+        __v:
+          type: number
+          description: Version number
+    RefundCreateBody:
+      type: object
+      description: Body for creating a refund
+      required:
+        - client
+        - amount
+        - reason
+      properties:
+        client:
+          type: string
+          description: Client ID associated with the refund
+        rep:
+          type: string
+          description: Representative ID who processed the refund
+        invoice:
+          type: string
+          description: Invoice ID being refunded
+        amount:
+          type: number
+          description: Refund amount
+        reason:
+          type: string
+          description: Reason for the refund
+        refundMethod:
+          type: string
+          description: Method of refund
+        reference:
+          type: string
+          description: Reference number for the refund
+        notes:
+          type: string
+          description: Additional notes
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+    RefundCreateResult:
+      $ref: "#/components/schemas/RefundSchema"
+      description: Result of creating a refund
+    RefundGetResult:
+      $ref: "#/components/schemas/RefundSchema"
+      description: Result of getting a refund
+    RefundUpdateBody:
+      type: object
+      description: Body for updating a refund
+      properties:
+        status:
+          type: string
+          enum: [pending, approved, rejected, processed]
+          description: Status of the refund
+        refundMethod:
+          type: string
+          description: Method of refund
+        reference:
+          type: string
+          description: Reference number for the refund
+        notes:
+          type: string
+          description: Additional notes
+        processedAt:
+          type: string
+          format: date-time
+          description: When the refund was processed
+        integration_meta:
+          type: object
+          additionalProperties: true
+          description: Integration metadata
+    RefundUpdateResult:
+      $ref: "#/components/schemas/RefundSchema"
+      description: Result of updating a refund

package/src/oas/rep-balance-summary.yaml

@@ -0,0 +1,135 @@
+openapi: 3.0.3
+info:
+  title: Repzo API - Rep Balance Summary
+  version: 1.0.0
+  description: OpenAPI specification for Repzo Rep Balance Summary endpoints.
+servers:
+  - url: https://sv.api.repzo.me
+paths:
+  /rep-balance-summary:
+    get:
+      summary: Find rep balance summaries
+      operationId: findRepBalanceSummaries
+      parameters:
+        - in: query
+          name: rep
+          required: true
+          schema:
+            type: string
+          description: The rep ID to get balance summary for
+        - in: query
+          name: page
+          schema:
+            type: integer
+            minimum: 1
+            default: 1
+          description: Page number for pagination
+        - in: query
+          name: per_page
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 20
+          description: Number of items per page
+        - in: query
+          name: disabled
+          schema:
+            type: boolean
+            default: false
+          description: Whether to include disabled records
+        - in: query
+          name: populatedKeys
+          schema:
+            type: array
+            items:
+              type: string
+          description: Keys to populate in the response
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  total_result:
+                    type: integer
+                    description: Total number of results
+                  current_count:
+                    type: integer
+                    description: Number of results in current page
+                  total_pages:
+                    type: integer
+                    description: Total number of pages
+                  current_page:
+                    type: integer
+                    description: Current page number
+                  per_page:
+                    type: integer
+                    description: Number of items per page
+                  first_page_url:
+                    type: string
+                    description: URL for first page
+                  last_page_url:
+                    type: string
+                    description: URL for last page
+                  next_page_url:
+                    type: string
+                    nullable: true
+                    description: URL for next page
+                  prev_page_url:
+                    type: string
+                    nullable: true
+                    description: URL for previous page
+                  path:
+                    type: string
+                    description: Base path for the endpoint
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/RepBalanceSummary"
+                  totals:
+                    type: object
+                    properties:
+                      total_balances:
+                        type: number
+                        description: Sum of all balance summaries
+                  options:
+                    type: object
+                    properties:
+                      has_more:
+                        type: boolean
+                        description: Whether there are more results
+                      include_documents_count:
+                        type: boolean
+                        description: Whether document count is included
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    RepBalanceSummary:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the rep balance summary
+        rep:
+          type: string
+          description: Rep ID
+        rep_name:
+          type: string
+          description: Rep name
+        total_outstanding_balance_of_invoices_created_by_rep:
+          type: number
+          description: Total outstanding balance of invoices created by the rep
+      required:
+        - _id
+        - rep
+        - rep_name
+        - total_outstanding_balance_of_invoices_created_by_rep