API docs by Redocly

Repzo API - Adjust Account (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Adjust Account endpoints.

Find account adjustments

query Parameters
object

Query parameters for filtering account adjustments

Responses

Response samples

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

Create an account adjustment

Request Body schema: application/json
client
required
string

Client ID whose account is being adjusted

rep
string

Representative ID who made the adjustment

type
required
string
Enum: "credit" "debit"

Type of adjustment (credit increases balance, debit decreases)

amount
required
number

Adjustment amount

reason
required
string

Reason for the adjustment

reference
string

Reference number or document

description
string

Detailed description of the adjustment

adjustmentDate
string <date-time>

Date when adjustment was made

object

Integration metadata

Responses

Request samples

Content type
application/json
{
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "previousBalance": 0,
  • "newBalance": 0,
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "approvedBy": "string",
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}

Get an account adjustment by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "client": "string",
  • "rep": "string",
  • "type": "credit",
  • "amount": 0,
  • "reason": "string",
  • "reference": "string",
  • "description": "string",
  • "previousBalance": 0,
  • "newBalance": 0,
  • "adjustmentDate": "2019-08-24T14:15:22Z",
  • "approvedBy": "string",
  • "approvalDate": "2019-08-24T14:15:22Z",
  • "integration_meta": { },
  • "company_namespace": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "__v": 0
}