# Repzo API - Checks

OpenAPI specification for Repzo Checks endpoints.

**Version:** 1.0.0

## Overview

### Base URLs

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

## Authentication

No authentication required.

## Endpoints

### `/checks`

#### GET /checks

**Summary:** Find checks

##### Parameters

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

| `params` | query | object | No | Query parameters for filtering checks |

##### Responses

**200** - A list of checks

Content-Type: `application/json`

---

#### POST /checks

**Summary:** Create a check

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Check created

Content-Type: `application/json`

---

### `/checks/{id}`

#### GET /checks/{id}

**Summary:** Get a check by ID

##### Parameters

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

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

##### Responses

**200** - Check details

Content-Type: `application/json`

---

## Data Models

### CheckFindResult

Result of finding checks

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

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

| `total_result` | number | No | Total number of checks |

| `current_count` | number | No | Count of checks in current page |

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

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

| `per_page` | number | No | Number of checks per page |

### CheckSchema

Check schema

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

| `_id` | string | No | Unique identifier for the check |

| `client` | string | No | Client ID associated with the check |

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

| `checkNumber` | string | No | Check number |

| `amount` | number | No | Check amount |

| `bank` | string | No | Bank name or ID |

| `accountNumber` | string | No | Account number |

| `issueDate` | string | No | Date when check was issued |

| `dueDate` | string | No | Due date of the check |

| `status` | string | No | Status of the check |

| `clearedDate` | string | No | Date when check was cleared |

| `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 |

### CheckCreateBody

Body for creating a check

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

| `client` | string | Yes | Client ID associated with the check |

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

| `checkNumber` | string | Yes | Check number |

| `amount` | number | Yes | Check amount |

| `bank` | string | Yes | Bank name or ID |

| `accountNumber` | string | No | Account number |

| `issueDate` | string | No | Date when check was issued |

| `dueDate` | string | Yes | Due date of the check |

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

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

### CheckCreateResult

Result of creating a check

### CheckGetResult

Result of getting a check

## TypeScript Usage

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