Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Client Credit Account Transaction

Create a client credit account transaction

Create and return a client credit account transaction for the specified business id

post/api/business/{businessId}/creditaccounttransaction

Path parameters

businessIdstring required

Request body

clientIdstring required

The unique identifier of the client for which this credit account transaction applies.

branchIdstring required
descriptionstring required
transactionAmountnumber required

The transaction amount is the value that will change the clients outstanding balance. Adding a positive value will add to the clients outstanding balance while a negative amount will take away from it

staffIdstring

Example request

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "branchId": "SE-J0emUgQnya14mOGdQS",
  "description": "Paid into client account",
  "transactionAmount": 123.12,
  "staffId": "staffid"
}

Response

Client credit account transaction created successfully

clientIdstring required

The unique identifier of the client for which this credit account transaction applies.

branchIdstring required
descriptionstring required
transactionAmountnumber required

The transaction amount is the value that will change the clients outstanding balance. Adding a positive value will add to the clients outstanding balance while a negative amount will take away from it

staffIdstring
outstandingBalancenumber

Clients current balance - read only

Example response

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "branchId": "SE-J0emUgQnya14mOGdQS",
  "description": "Paid into client account",
  "transactionAmount": 123.12,
  "staffId": "staffid",
  "outstandingBalance": 123.12
}