Get the outstanding balance for a customer

get/customer-balances
SecuritybearerAuth
Request
query Parameters
customer_id
required
integer <int64> (IdParam) >= 1

Customer identifier

Example: customer_id=1
Responses
200

Customer outstanding balance found

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
{
  • "id": 1,
  • "customerId": 1,
  • "balance": 0,
  • "totalPayments": 0,
  • "totalPaymentsSinceLastInvoice": 0,
  • "paymentMethodSummary": {
    • "paymentMethod": "CHEQUE",
    • "summaryType": "NONE"
    },
  • "repaymentPlanSummary": {
    • "repaymentPlanAmount": 1,
    • "repaymentPlanRemainingPeriods": 0,
    • "summaryType": "NONE"
    }
}