API docs by Redocly

Repzo API - Checks (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Checks endpoints.

Find checks

query Parameters
object

Query parameters for filtering checks

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0
}

Create a check

Request Body schema: application/json
client
required
string

Client ID associated with the check

rep
string

Representative ID who received the check

checkNumber
required
string

Check number

amount
required
number

Check amount

bank
required
string

Bank name or ID

accountNumber
string

Account number

issueDate
string <date-time>

Date when check was issued

dueDate
required
string <date-time>

Due date of the check

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "clearedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get a check by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "checkNumber": "string",
  • "amount": 0,
  • "bank": "string",
  • "accountNumber": "string",
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "status": "pending",
  • "clearedDate": "2019-08-24T14:15:22Z",
  • "notes": "string",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}