Class Manager
GET /v1/billing/{familyId}

Get bill

Path parameters

  • familyId string Required

    Family ID

Query parameters

  • billingMonth string Required

    Billing month

  • seasonId string Required

    Season ID

  • pricingPlanId string Required

    Pricing plan ID

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • familyId string Required

      Family ID

    • description string Required

      Description

    • date string(date) Required

      Date

    • subtotal integer Required

      Subtotal

    • discountTotal integer Required

      Discount total

    • taxTotal integer Required

      Tax total

    • total integer Required

      Total

    • items array[object] Required

      Items

      Bill Item schema

      Hide items attributes Show items attributes object
      • description string Required

        Description

      • type string Required

        Values are manual-debit, tax, additional-fee, registration-fee, tuition, trial, refund, payment-auto-failed, payment-auto-failed-reversal, product, discount-credit, upcoming-payment-adjustment, payment-manual, payment-manual-account-balance, discount, discount-tax, credit-note, manual-debit-credit, tax-credit, registration-fee-credit, tuition-credit, trial-credit, product-credit, additional-credit, custom-credit, payment-auto, payment-pending-card, payment-auto-account-balance, fee-class-manager, or fee-company.

      • subtotal integer Required

        Subtotal

      • discountTotal integer Required

        Discount total

      • taxTotal integer | null Required

        Tax total

      • taxDescription string | null Required

        Tax description

      • total integer Required

        Total

      • discounts array[object] Required

        Taxes

        Bill Item Discount schema

        Hide discounts attributes Show discounts attributes object
        • description string Required

          Description

        • total integer Required

          Total

        • amount integer Required

          Amount

        • taxAmount integer | null Required

          Tax amount

    • taxes array[object] Required

      Taxes

      Bill Item Tax schema

      Hide taxes attributes Show taxes attributes object
      • description string Required

        Description

      • amount integer Required

        Amount
  • 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/billing/{familyId} 
curl \
 --request GET 'https://classmanager.test/v1/billing/fml_123123123123?billingMonth=2023-07-24&seasonId=sea_123123123123&pricingPlanId=pp_123123123123'
Response examples (200) 
{
  "familyId": "fml_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "description": "This is a bill description",
  "date": "2023-12-05",
  "subtotal": 1000,
  "discountTotal": -100,
  "taxTotal": 200,
  "total": 1200,
  "items": [
    {
      "description": "This is a bill item description",
      "type": "manual-debit",
      "subtotal": 1000,
      "discountTotal": 100,
      "taxTotal": 200,
      "taxDescription": "string",
      "total": 1200,
      "discounts": [
        {
          "description": "VAT (20%)",
          "total": 200,
          "amount": 320,
          "taxAmount": 120
        }
      ]
    }
  ],
  "taxes": [
    {
      "description": "VAT (20%)",
      "amount": 200
    }
  ]
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}