> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usequanta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Invoice Customer Credit

> Managed customer credit state for an invoice.

Returns the customer's current credit balance and the credit already
applied to this invoice (both Quanta-initiated and ops-recorded entries).



## OpenAPI

````yaml https://app.usequanta.com/openapi/quanta-services-api/openapi.json get /admin_api/invoices/invoice/{invoice_qid}/customer_credit
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://app.usequanta.com
    description: Production
security:
  - HTTPBearer: []
paths:
  /admin_api/invoices/invoice/{invoice_qid}/customer_credit:
    get:
      tags:
        - invoice_admin
        - quanta-services-api
      summary: Get Invoice Customer Credit
      description: >-
        Managed customer credit state for an invoice.


        Returns the customer's current credit balance and the credit already

        applied to this invoice (both Quanta-initiated and ops-recorded
        entries).
      operationId: get_invoice_customer_credit
      parameters:
        - name: invoice_qid
          in: path
          required: true
          schema:
            type: string
            title: Invoice Qid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceCustomerCreditResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    InvoiceCustomerCreditResponse:
      properties:
        invoice_qid:
          type: string
          title: Invoice Qid
        is_eligible:
          type: boolean
          title: Is Eligible
        customer_qid:
          anyOf:
            - type: string
            - type: 'null'
          title: Customer Qid
        customer_balance:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Customer Balance
        applied_total:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Applied Total
        entries:
          items:
            $ref: '#/components/schemas/CustomerCreditApplicationEntry'
          type: array
          title: Entries
      type: object
      required:
        - invoice_qid
        - is_eligible
        - customer_qid
        - customer_balance
        - applied_total
        - entries
      title: InvoiceCustomerCreditResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CustomerCreditApplicationEntry:
      properties:
        qid:
          type: string
          title: Qid
        amount:
          type: string
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
          title: Amount
        effective_date:
          type: string
          title: Effective Date
        event_qid:
          anyOf:
            - type: string
            - type: 'null'
          title: Event Qid
        stripe_write_ref:
          anyOf:
            - type: string
            - type: 'null'
          title: Stripe Write Ref
      type: object
      required:
        - qid
        - amount
        - effective_date
        - event_qid
        - stripe_write_ref
      title: CustomerCreditApplicationEntry
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Quanta Services API scoped bearer token. Supported only on Services API
        routes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.