# Repzo API - Receiving Material

OpenAPI specification for Repzo Receiving Material endpoints.

**Version:** 1.0.0

## Overview

### Base URLs

- \*\*\*\*: `https://sv.api.repzo.me`

## Authentication

No authentication required.

## Endpoints

### `/receiving-material`

#### GET /receiving-material

**Summary:** Find receiving materials

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `params` | query | object | No | Query parameters for filtering receiving materials |

##### Responses

**200** - A list of receiving materials

Content-Type: `application/json`

---

#### POST /receiving-material

**Summary:** Create a receiving material

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Receiving material created

Content-Type: `application/json`

---

### `/receiving-material/{id}`

#### GET /receiving-material/{id}

**Summary:** Get a receiving material by ID

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | No description |

##### Responses

**200** - Receiving material details

Content-Type: `application/json`

---

#### PUT /receiving-material/{id}

**Summary:** Update a receiving material

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | No description |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Receiving material updated

Content-Type: `application/json`

---

## Data Models

### ReceivingMaterialFindResult

Result of finding receiving materials

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `data` | array | No | No description |

| `total_result` | number | No | Total number of receiving materials |

| `current_count` | number | No | Count of receiving materials in current page |

| `total_pages` | number | No | Total number of pages |

| `current_page` | number | No | Current page number |

| `per_page` | number | No | Number of receiving materials per page |

### ReceivingMaterialSchema

Receiving material schema

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier for the receiving material |

| `warehouse` | string | No | Warehouse ID where materials are received |

| `supplier` | string | No | Supplier ID providing the materials |

| `rep` | string | No | Representative ID who received the materials |

| `receiptNumber` | string | No | Receipt number |

| `receiptDate` | string | No | Date when materials were received |

| `items` | array | No | List of items received |

| `totalAmount` | number | No | Total amount of the receipt |

| `status` | string | No | Status of the receiving material |

| `notes` | string | No | Additional notes |

| `integration_meta` | object | No | Integration metadata |

| `company_namespace` | array | No | Company namespaces |

| `createdAt` | string | No | Creation timestamp |

| `updatedAt` | string | No | Last update timestamp |

| `__v` | number | No | Version number |

### ReceivingMaterialCreateBody

Body for creating a receiving material

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `warehouse` | string | Yes | Warehouse ID where materials are received |

| `supplier` | string | Yes | Supplier ID providing the materials |

| `rep` | string | No | Representative ID who received the materials |

| `receiptNumber` | string | No | Receipt number |

| `receiptDate` | string | No | Date when materials were received |

| `items` | array | Yes | List of items received |

| `notes` | string | No | Additional notes |

| `integration_meta` | object | No | Integration metadata |

### ReceivingMaterialCreateResult

Result of creating a receiving material

### ReceivingMaterialGetResult

Result of getting a receiving material

### ReceivingMaterialUpdateBody

Body for updating a receiving material

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `receiptDate` | string | No | Date when materials were received |

| `items` | array | No | List of items received |

| `status` | string | No | Status of the receiving material |

| `notes` | string | No | Additional notes |

| `integration_meta` | object | No | Integration metadata |

### ReceivingMaterialUpdateResult

Result of updating a receiving material

## TypeScript Usage

See [receiving-material-examples.md](./receiving-material-examples.md) for detailed TypeScript usage examples.