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

# List all Invoices

> Get paginated list of invoices for a business with optional filtering.

**Scopes:** `invoice:read`



## OpenAPI

````yaml /api-reference/openapi.json get /v0/business/{business_id}/invoice
openapi: 3.1.0
info:
  title: Asset API
  version: '0.1'
servers:
  - url: https://api.sandbox.getasset.com
    description: Sandbox
  - url: https://api.getasset.com
    description: Production
security: []
paths:
  /v0/business/{business_id}/invoice:
    get:
      tags:
        - Invoice
      summary: List all Invoices
      description: |-
        Get paginated list of invoices for a business with optional filtering.

        **Scopes:** `invoice:read`
      operationId: get_invoices_v0_business__business_id__invoice_get
      parameters:
        - name: business_id
          in: path
          required: true
          schema:
            description: The id of the business
            examples:
              - biz_GA6EG2qFxA97NZHtxeLPUy
            type: string
            format: biz_string
            title: Business Id
          description: The id of the business
        - name: due_at_start
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: >-
              Include invoices due after this period (inclusive) in ISO-8601
              format
            title: Due At Start
          description: >-
            Include invoices due after this period (inclusive) in ISO-8601
            format
        - name: due_at_end
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: >-
              Include invoices due before this period (exclusive) in ISO-8601
              format
            title: Due At End
          description: >-
            Include invoices due before this period (exclusive) in ISO-8601
            format
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter invoices by one or more statuses, comma-separated
            title: Status
          description: Filter invoices by one or more statuses, comma-separated
        - name: numbers
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - items:
                  type: string
                type: array
              - type: 'null'
            description: Filter invoices by one or more invoice numbers, comma-separated
            title: Numbers
          description: Filter invoices by one or more invoice numbers, comma-separated
        - name: page_token
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                description: The page token to for the next or previous page
              - type: 'null'
            title: Page Token
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 100
            title: Page Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoicesPaginated'
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Not Found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Unprocessable Content
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Service Unavailable
      security:
        - OAuth2PasswordBearer:
            - invoice:read
components:
  schemas:
    InvoicesPaginated:
      properties:
        data:
          items:
            $ref: '#/components/schemas/InvoicePublic'
          type: array
          title: Data
        pagination:
          $ref: '#/components/schemas/PaginationResponse'
      type: object
      required:
        - data
        - pagination
      title: InvoicesPaginated
    ErrorResponse:
      properties:
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
          description: A description of the error
        data:
          title: Data
          description: Data associated with the error
      type: object
      required:
        - error
        - data
      title: ErrorResponse
    InvoicePublic:
      properties:
        business_id:
          type: string
          format: biz_string
          title: Business Id
          description: The ID of the Business that the invoice is associated with
          examples:
            - biz_Pk2fNFDd8wj7EFeLWJywc7
        number:
          type: string
          maxLength: 255
          title: Number
          description: >-
            The number of the invoice. Must be unique across all invoices for a
            business.
          examples:
            - INV-1234567890
        description:
          type: string
          maxLength: 512
          title: Description
          description: The description of the invoice
          examples:
            - Invoice from Acme Corp
        total_amount:
          type: number
          title: Total Amount
          description: The amount of the invoice
          examples:
            - 520.56
        total_paid:
          type: number
          title: Total Paid
          description: The amount of the invoice that has been paid
          default: 0
          examples:
            - 520.56
        source:
          $ref: '#/components/schemas/InvoiceSource'
          description: The source of the invoice
        due_at:
          type: string
          format: date-time
          title: Due At
          description: The due date of the invoice
        sent_at:
          type: string
          format: date-time
          title: Sent At
          description: The date the invoice was sent
        voided_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Voided At
          description: The date the invoice was voided
        status:
          $ref: '#/components/schemas/InvoiceStatus'
          description: The status of the invoice
          examples:
            - paid
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        id:
          type: string
          format: inv_string
          title: Id
          description: The ID of the invoice
          examples:
            - inv_GkBo16N66u2teKfFuFMMwf
        lines:
          anyOf:
            - items:
                $ref: '#/components/schemas/InvoiceLinePublic'
              type: array
            - type: 'null'
          title: Lines
          description: The lines of the invoice
        payments:
          anyOf:
            - items:
                $ref: '#/components/schemas/InvoicePaymentPublic'
              type: array
            - type: 'null'
          title: Payments
          description: The payments of the invoice
        customer_id:
          type: string
          format: cus_string
          title: Customer Id
          description: The ID of the Customer that the invoice is associated with
          examples:
            - cus_WxcM3ypJ5boFxsNQzcqRXe
        tags:
          anyOf:
            - additionalProperties:
                items:
                  $ref: '#/components/schemas/TagValueInput-Output'
                type: array
              type: object
            - type: 'null'
          title: Tags
          description: >-
            Tag field name to the list of values attached to the invoice. Each
            value carries its allocated amount; a single-value field is still
            returned as a one-element list.
          examples:
            - Job:
                - amount: '3000.00'
                  value: Maple Street Remodel
                - amount: '1500.00'
                  value: Downtown Office Rewire
      type: object
      required:
        - business_id
        - number
        - description
        - total_amount
        - source
        - due_at
        - sent_at
        - status
        - id
        - customer_id
      title: InvoicePublic
    PaginationResponse:
      properties:
        next_page_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Page Token
          description: The next page token
        previous_page_token:
          anyOf:
            - type: string
            - type: 'null'
          title: Previous Page Token
          description: The previous page token
      type: object
      title: PaginationResponse
    InvoiceSource:
      type: string
      enum:
        - manual
        - stripe
      title: InvoiceSource
    InvoiceStatus:
      type: string
      enum:
        - open
        - paid
        - uncollectible
        - voided
        - refunded
        - partially_refunded
      title: InvoiceStatus
    InvoiceLinePublic:
      properties:
        description:
          type: string
          maxLength: 512
          title: Description
          description: The description of the line item
          examples:
            - Web development services
        ledger_id:
          anyOf:
            - type: string
              format: ldg_string
            - type: 'null'
          title: Ledger Id
          description: The ID of the ledger that the line item is associated with
          examples:
            - ldg_ErisumsAc7qgmbTctM7zKK
        amount:
          type: number
          title: Amount
          description: The amount of the line item
          examples:
            - 520.56
        metadata:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Metadata
        id:
          type: string
          format: inl_string
          title: Id
          description: The ID of the invoice line
          examples:
            - inl_GkBo16N66u2teKfFuFMMwf
        invoice_id:
          type: string
          format: inv_string
          title: Invoice Id
          description: The ID of the invoice that the line item is associated with
          examples:
            - inv_WQMDNUHpBThYSNh4AprDBo
      type: object
      required:
        - description
        - ledger_id
        - amount
        - id
        - invoice_id
      title: InvoiceLinePublic
    InvoicePaymentPublic:
      properties:
        invoice_id:
          type: string
          format: inv_string
          title: Invoice Id
          description: The ID of the invoice that the payment is associated with
          examples:
            - inv_GkBo16N66u2teKfFuFMMwf
        transaction_id:
          anyOf:
            - type: string
              format: txn_string
            - type: 'null'
          title: Transaction Id
          description: >-
            The ID of the transaction that the payment is associated with. Null
            for credit-source payments.
          examples:
            - txn_WQMDNUHpBThYSNh4AprDBo
        credit_journal_entry_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Credit Journal Entry Id
          description: >-
            Journal entry created for this payment. Populated for credit-source
            payments; null for transaction-source payments (whose JE is keyed
            off the transaction).
        credit_memo_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Credit Memo Id
          description: >-
            Credit memo that backs this payment. Set for write-off payments;
            null otherwise.
        payment_id:
          type: string
          maxLength: 255
          title: Payment Id
          description: The external identifier of the payment
          examples:
            - inp_ErisumsAc7qgmbTctM7zKK
        datetime:
          type: string
          format: date-time
          title: Datetime
          description: The date and time the payment was made
          examples:
            - '2021-01-01T00:00:00Z'
        payment_amount:
          type: number
          title: Payment Amount
          description: The amount of the payment
          examples:
            - 520.56
        id:
          type: string
          format: inp_string
          title: Id
          description: The ID of the invoice payment
          examples:
            - inp_WQMDNUHpBThYSNh4AprDBo
        invoice:
          anyOf:
            - $ref: '#/components/schemas/InvoicePublic'
            - type: 'null'
          description: The invoice that the payment is associated with
        is_write_off:
          type: boolean
          title: Is Write Off
          description: >-
            True when the payment was created by writing off the invoice as
            uncollectible.
          default: false
      type: object
      required:
        - invoice_id
        - payment_id
        - datetime
        - payment_amount
        - id
      title: InvoicePaymentPublic
    TagValueInput-Output:
      properties:
        value:
          type: string
          title: Value
          description: The tag value (option string)
          examples:
            - NYC
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
          description: >-
            Portion of the source object allocated to this tag value. If
            omitted: with one value on a field the full source amount is used;
            with multiple values on a field the amount is split evenly. Mixed
            (some amounts set, some omitted) is rejected.
          examples:
            - '75.00'
      type: object
      required:
        - value
      title: TagValueInput
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v0/auth/token

````