# Get the outstanding balance for a customer

Endpoint: GET /customer-balances
Version: 1.37
Security: bearerAuth

## Query parameters:

  - `customer_id` (integer, required)
    Customer identifier
    Example: 1

## Response 200 fields (application/json):

  - `id` (integer)
    Customer outstanding balance identifier
    Example: 1

  - `customerId` (integer, required)
    Customer identifier
    Example: 1

  - `balance` (number)
    Outstanding balance

  - `totalPayments` (number)
    Sum of all payments against the customer

  - `totalPaymentsSinceLastInvoice` (number)
    Sum of all payments against the customer since the last invoice

  - `paymentMethodSummary` (object)
    Summary of customer's payment method. This is from a site that is 'live', meaning has no end date, or end date is in the future.

  - `paymentMethodSummary.paymentMethod` (string)
    Payment method
    Enum: "CHEQUE", "DIRECT_DEBIT", "CANCELLED_DD", "CANCELLED_CARD", "CREDIT_CARD", "PAYPAL", "BACS", "POST_OFFICE_PAYMENT_CARD", "EZYPAY", "GO_CARDLESS", "GC_INSTANT_BANK_PAYMENTS", "STRIPE", "STRIPE_CARD", "STRIPE_DD", "FINASTRA", "FAST_PAY", "OTHER"

  - `paymentMethodSummary.summaryType` (string, required)
    Type of summary
    Enum: "NONE", "SINGLE", "MULTIPLE"

  - `repaymentPlanSummary` (object)
    Summary of customer's repayment plan. This is from a site that is 'live', meaning has no end date, or end date is in the future.

  - `repaymentPlanSummary.repaymentPlanAmount` (number)
    The repayment plan period amount in major currency (e.g pounds/dollars/euros)

  - `repaymentPlanSummary.repaymentPlanRemainingPeriods` (integer)
    The repayment plan remaining periods (typically in months)


## Response 400 fields

## Response 401 fields

## Response 403 fields