API docs by Redocly

Repzo API - Settlement (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Settlement endpoints.

Find settlements

query Parameters
object

Query parameters for filtering settlements

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 settlement

Request Body schema: application/json
client
required
string

Client ID associated with the settlement

rep
string

Representative ID who processed the settlement

required
Array of objects

List of invoices included in settlement

required
Array of objects

List of payments included in settlement

notes
string

Additional notes

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "notes": "string",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "settlementDate": "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 settlement by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "invoices": [
    ],
  • "payments": [
    ],
  • "totalAmount": 0,
  • "status": "pending",
  • "settlementDate": "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
}