repzo 1.0.155 → 1.0.156

package/src/oas/asset-part-receival.yaml

@@ -0,0 +1,591 @@
+openapi: 3.0.0
+info:
+  title: Asset Part Receival API
+  description: API for managing asset part receivals (receiving inventory)
+  version: 1.0.0
+  contact:
+    name: Repzo
+    url: https://repzo.com
+
+servers:
+  - url: https://sv.api.repzo.me
+    description: Production server
+  - url: https://staging.sv.api.repzo.me
+    description: Staging server
+
+tags:
+  - name: Asset Part Receival
+    description: Operations related to asset part receival management
+
+paths:
+  /asset-part-receival:
+    get:
+      tags:
+        - Asset Part Receival
+      summary: Get all asset part receivals
+      description: Retrieve a list of all asset part receivals with optional filtering and pagination
+      parameters:
+        - name: limit
+          in: query
+          description: Maximum number of records to return
+          required: false
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 100
+            default: 50
+        - name: offset
+          in: query
+          description: Number of records to skip for pagination
+          required: false
+          schema:
+            type: integer
+            minimum: 0
+            default: 0
+        - name: sort
+          in: query
+          description: Field to sort by
+          required: false
+          schema:
+            type: string
+        - name: order
+          in: query
+          description: Sort order (asc or desc)
+          required: false
+          schema:
+            type: string
+            enum: [asc, desc]
+            default: desc
+        - name: filter
+          in: query
+          description: Filter conditions in JSON format
+          required: false
+          schema:
+            type: string
+        - name: search
+          in: query
+          description: Search term for text fields
+          required: false
+          schema:
+            type: string
+      responses:
+        "200":
+          description: List of asset part receivals retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    type: array
+                    items:
+                      $ref: "#/components/schemas/AssetPartReceival"
+                  total:
+                    type: integer
+                    description: Total number of records
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    post:
+      tags:
+        - Asset Part Receival
+      summary: Create a new asset part receival
+      description: Create a new asset part receival with the provided data
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartReceivalInput"
+      responses:
+        "201":
+          description: Asset part receival created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartReceival"
+        "400":
+          description: Bad request
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+  /asset-part-receival/{id}:
+    get:
+      tags:
+        - Asset Part Receival
+      summary: Get asset part receival by ID
+      description: Retrieve a specific asset part receival by its ID
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part receival ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part receival retrieved successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartReceival"
+        "404":
+          description: Asset part receival not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    put:
+      tags:
+        - Asset Part Receival
+      summary: Update asset part receival
+      description: Update an existing asset part receival with new data
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part receival ID
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/AssetPartReceivalInput"
+      responses:
+        "200":
+          description: Asset part receival updated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  data:
+                    $ref: "#/components/schemas/AssetPartReceival"
+        "400":
+          description: Bad request
+        "404":
+          description: Asset part receival not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+    delete:
+      tags:
+        - Asset Part Receival
+      summary: Delete asset part receival
+      description: Delete an existing asset part receival
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: Asset part receival ID
+          schema:
+            type: string
+      responses:
+        "200":
+          description: Asset part receival deleted successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                    example: true
+                  message:
+                    type: string
+                    example: Asset part receival deleted successfully
+        "404":
+          description: Asset part receival not found
+        "401":
+          description: Unauthorized
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+    AssetPartReceival:
+      type: object
+      properties:
+        _id:
+          type: string
+          description: Unique identifier for the asset part receival
+          example: "60f7b1b3e4b0e8b3f8b3f8b3"
+        receivalNumber:
+          type: string
+          description: Unique receival number
+          example: "RCV-2023-001"
+        purchaseOrder:
+          type: string
+          description: Purchase order reference
+          example: "PO-2023-001"
+        supplier:
+          type: string
+          description: Supplier ID
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        receivalDate:
+          type: string
+          format: date-time
+          description: Date and time of receival
+          example: "2023-01-15T10:00:00Z"
+        expectedDate:
+          type: string
+          format: date-time
+          description: Expected delivery date
+          example: "2023-01-14T10:00:00Z"
+        receivedBy:
+          type: string
+          description: User who received the parts
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        warehouse:
+          type: string
+          description: Warehouse ID where parts were received
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        status:
+          type: string
+          enum: [pending, partial, complete, cancelled]
+          default: pending
+          description: Status of the receival
+        items:
+          type: array
+          items:
+            type: object
+            properties:
+              assetPart:
+                type: string
+                description: Asset part ID
+              orderedQuantity:
+                type: integer
+                minimum: 1
+                description: Quantity ordered
+              receivedQuantity:
+                type: integer
+                minimum: 0
+                description: Quantity actually received
+              unitCost:
+                type: number
+                format: double
+                minimum: 0
+                description: Cost per unit
+              totalCost:
+                type: number
+                format: double
+                minimum: 0
+                description: Total cost for this item
+              condition:
+                type: string
+                enum: [new, good, damaged, defective]
+                default: new
+                description: Condition of received items
+              batchNumber:
+                type: string
+                description: Batch number
+              serialNumbers:
+                type: array
+                items:
+                  type: string
+                description: Serial numbers for tracked items
+              expiryDate:
+                type: string
+                format: date
+                description: Expiry date if applicable
+              notes:
+                type: string
+                description: Notes for this item
+        totalValue:
+          type: number
+          format: double
+          minimum: 0
+          description: Total value of the receival
+        currency:
+          type: string
+          description: Currency code
+          example: "USD"
+        shippingCost:
+          type: number
+          format: double
+          minimum: 0
+          description: Shipping cost
+        taxAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Tax amount
+        discountAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Discount amount
+        invoice:
+          type: object
+          properties:
+            number:
+              type: string
+              description: Invoice number
+            date:
+              type: string
+              format: date
+              description: Invoice date
+            amount:
+              type: number
+              format: double
+              minimum: 0
+              description: Invoice amount
+        qualityCheck:
+          type: object
+          properties:
+            performed:
+              type: boolean
+              default: false
+              description: Whether quality check was performed
+            checkedBy:
+              type: string
+              description: User who performed quality check
+            checkDate:
+              type: string
+              format: date-time
+              description: Quality check date
+            passed:
+              type: boolean
+              description: Whether quality check passed
+            notes:
+              type: string
+              description: Quality check notes
+        documents:
+          type: array
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              url:
+                type: string
+                format: uri
+              type:
+                type: string
+                enum: [invoice, packing-slip, quality-certificate, photo]
+        notes:
+          type: string
+          description: General notes
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+        createdAt:
+          type: string
+          format: date-time
+          description: Record creation timestamp
+          example: "2023-01-15T08:00:00Z"
+        updatedAt:
+          type: string
+          format: date-time
+          description: Record last update timestamp
+          example: "2023-01-15T10:30:00Z"
+      required:
+        - receivalNumber
+        - supplier
+        - receivalDate
+        - items
+
+    AssetPartReceivalInput:
+      type: object
+      properties:
+        receivalNumber:
+          type: string
+          description: Unique receival number
+          example: "RCV-2023-001"
+        purchaseOrder:
+          type: string
+          description: Purchase order reference
+          example: "PO-2023-001"
+        supplier:
+          type: string
+          description: Supplier ID
+          example: "60f7b1b3e4b0e8b3f8b3f8b4"
+        receivalDate:
+          type: string
+          format: date-time
+          description: Date and time of receival
+          example: "2023-01-15T10:00:00Z"
+        expectedDate:
+          type: string
+          format: date-time
+          description: Expected delivery date
+          example: "2023-01-14T10:00:00Z"
+        receivedBy:
+          type: string
+          description: User who received the parts
+          example: "60f7b1b3e4b0e8b3f8b3f8b5"
+        warehouse:
+          type: string
+          description: Warehouse ID where parts were received
+          example: "60f7b1b3e4b0e8b3f8b3f8b6"
+        status:
+          type: string
+          enum: [pending, partial, complete, cancelled]
+          default: pending
+          description: Status of the receival
+        items:
+          type: array
+          items:
+            type: object
+            properties:
+              assetPart:
+                type: string
+                description: Asset part ID
+              orderedQuantity:
+                type: integer
+                minimum: 1
+                description: Quantity ordered
+              receivedQuantity:
+                type: integer
+                minimum: 0
+                description: Quantity actually received
+              unitCost:
+                type: number
+                format: double
+                minimum: 0
+                description: Cost per unit
+              totalCost:
+                type: number
+                format: double
+                minimum: 0
+                description: Total cost for this item
+              condition:
+                type: string
+                enum: [new, good, damaged, defective]
+                default: new
+                description: Condition of received items
+              batchNumber:
+                type: string
+                description: Batch number
+              serialNumbers:
+                type: array
+                items:
+                  type: string
+                description: Serial numbers for tracked items
+              expiryDate:
+                type: string
+                format: date
+                description: Expiry date if applicable
+              notes:
+                type: string
+                description: Notes for this item
+        totalValue:
+          type: number
+          format: double
+          minimum: 0
+          description: Total value of the receival
+        currency:
+          type: string
+          description: Currency code
+          example: "USD"
+        shippingCost:
+          type: number
+          format: double
+          minimum: 0
+          description: Shipping cost
+        taxAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Tax amount
+        discountAmount:
+          type: number
+          format: double
+          minimum: 0
+          description: Discount amount
+        invoice:
+          type: object
+          properties:
+            number:
+              type: string
+              description: Invoice number
+            date:
+              type: string
+              format: date
+              description: Invoice date
+            amount:
+              type: number
+              format: double
+              minimum: 0
+              description: Invoice amount
+        qualityCheck:
+          type: object
+          properties:
+            performed:
+              type: boolean
+              default: false
+              description: Whether quality check was performed
+            checkedBy:
+              type: string
+              description: User who performed quality check
+            checkDate:
+              type: string
+              format: date-time
+              description: Quality check date
+            passed:
+              type: boolean
+              description: Whether quality check passed
+            notes:
+              type: string
+              description: Quality check notes
+        documents:
+          type: array
+          items:
+            type: object
+            properties:
+              name:
+                type: string
+              url:
+                type: string
+                format: uri
+              type:
+                type: string
+                enum: [invoice, packing-slip, quality-certificate, photo]
+        notes:
+          type: string
+          description: General notes
+        metadata:
+          type: object
+          additionalProperties: true
+          description: Additional metadata
+      required:
+        - receivalNumber
+        - supplier
+        - receivalDate
+        - items
+
+  securitySchemes:
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: api-key
+
+security:
+  - ApiKeyAuth: []