Class Manager
GET /v1/families/{familyId}/balance

Retrieve family balance

Path parameters

  • familyId string Required

    Family ID

Query parameters

  • where object

    Filter conditions

    Hide where attribute Show where attribute object
    • transactionId object

      Filter by Transaction ID

      Hide transactionId attribute Show transactionId attribute object
      • lessThan string

        Filter by ID less than

Responses

  • 200 application/json

    successful operation

    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
  • 404 application/json

    Not found

    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/families/{familyId}/balance 
curl \
 --request GET 'https://localhost/v1/families/fam_123123123/balance'
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": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}