Class Manager
GET /v1/balances

List family balances

Query parameters

  • where object Required

    Filter conditions

    Hide where attribute Show where attribute object
    • familyId object Required

      Filter by Family ID

      Hide familyId attribute Show familyId attribute object
      • in array[string] Required

        Filter by ID in array

Responses

  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • companyId string Required

      Company ID

    • familyId string Required

      Family ID

    • balance integer Required

      Balance

    • debit integer Required

      Debit

    • credit integer Required

      Credit

    • totalToPay integer Required

      Total to pay

    • nextScheduledPayment integer | null Required

      Next scheduled payment value

    • nextScheduledPaymentDate string | null

      Next scheduled payment date

    • beforeTransactionId string | null Required

      Transaction ID
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/balances 
curl \
 --request GET 'https://localhost/v1/balances?where=%7B%22familyId%22%3A%7B%22in%22%3A%5B%22fam_xxxxxxxxxx%22%2C%22fam_xxxxxxxxxx%22%5D%7D%7D'
Response examples (200) 
[
  {
    "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "familyId": "fml_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "balance": 100,
    "debit": 100,
    "credit": 100,
    "totalToPay": 100,
    "nextScheduledPayment": 100,
    "nextScheduledPaymentDate": "string",
    "beforeTransactionId": "trn_xxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}