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

# Invoice List Api

> Lists invoices with optional filtering.



## OpenAPI

````yaml get /api/v1/invoice/
openapi: 3.1.0
info:
  title: NinjaAPI
  version: 1.0.0
  description: ''
servers:
  - url: https://api.justpaid.io
security: []
paths:
  /api/v1/invoice/:
    get:
      summary: Invoice List Api
      description: Lists invoices with optional filtering.
      operationId: loopfour_backend_invoice_external_api_invoice_list_api
      parameters:
        - in: query
          name: invoice_status
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Invoice Status
          required: false
        - in: query
          name: customer
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Customer
          required: false
        - in: query
          name: invoice_date_gte
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Invoice Date Gte
          required: false
        - in: query
          name: invoice_date_lte
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Invoice Date Lte
          required: false
        - in: query
          name: due_date_gte
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Due Date Gte
          required: false
        - in: query
          name: due_date_lte
          schema:
            anyOf:
              - format: date
                type: string
              - type: 'null'
            title: Due Date Lte
          required: false
        - in: query
          name: amount_gte
          schema:
            anyOf:
              - type: number
              - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
                type: string
              - type: 'null'
            title: Amount Gte
          required: false
        - in: query
          name: amount_lte
          schema:
            anyOf:
              - type: number
              - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
                type: string
              - type: 'null'
            title: Amount Lte
          required: false
        - in: query
          name: limit
          schema:
            default: 20
            maximum: 100
            minimum: 1
            title: Limit
            type: integer
          required: false
        - in: query
          name: offset
          schema:
            default: 0
            minimum: 0
            title: Offset
            type: integer
          required: false
        - name: invoice_status
          in: query
          description: Filter by invoice status (e.g., 'draft', 'sent', 'paid')
          required: false
          schema:
            type: string
        - name: customer
          in: query
          description: Filter by customer UUID
          required: false
          schema:
            type: string
          example: 123e4567-e89b-12d3-a456-426614174000
        - name: invoice_date_gte
          in: query
          description: Filter invoices with invoice date greater than or equal to this date
          required: false
          schema:
            format: date
            type: string
          example: '2024-01-01'
        - name: invoice_date_lte
          in: query
          description: Filter invoices with invoice date less than or equal to this date
          required: false
          schema:
            format: date
            type: string
          example: '2024-12-31'
        - name: due_date_gte
          in: query
          description: Filter invoices with due date greater than or equal to this date
          required: false
          schema:
            format: date
            type: string
          example: '2024-01-01'
        - name: due_date_lte
          in: query
          description: Filter invoices with due date less than or equal to this date
          required: false
          schema:
            format: date
            type: string
          example: '2024-12-31'
        - name: amount_gte
          in: query
          description: Filter invoices with amount greater than or equal to this value
          required: false
          schema:
            type: number
          example: 100
        - name: amount_lte
          in: query
          description: Filter invoices with amount less than or equal to this value
          required: false
          schema:
            type: number
          example: 10000
        - name: limit
          in: query
          description: Number of results to return per page
          required: false
          schema:
            type: integer
          example: 10
        - name: offset
          in: query
          description: Number of results to skip
          required: false
          schema:
            type: integer
          example: 0
      responses:
        '200':
          description: List of invoices retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedInvoiceOut2'
      security:
        - HttpBearerAuth: []
components:
  schemas:
    PagedInvoiceOut2:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InvoiceOut2'
          title: Items
          type: array
        count:
          title: Count
          type: integer
      required:
        - items
        - count
      title: PagedInvoiceOut2
      type: object
    InvoiceOut2:
      description: Output schema for invoice information.
      properties:
        uuid:
          description: The unique identifier for the invoice
          example: 123e4567-e89b-12d3-a456-426614174000
          format: uuid
          title: Uuid
          type: string
        invoice_status:
          description: The current status of the invoice
          example: draft
          title: Invoice Status
          type: string
        amount:
          description: The total amount due for the invoice
          example: 1000
          title: Amount
          type: number
        currency:
          description: The currency code for the invoice
          example: USD
          title: Currency
          type: string
        invoice_number:
          description: The unique invoice number
          example: INV-2024-001
          title: Invoice Number
          type: string
        invoice_date:
          description: The date when the invoice was created
          example: '2024-03-21'
          format: date
          title: Invoice Date
          type: string
        due_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The date by which the invoice must be paid
          example: '2024-04-21'
          title: Due Date
        service_start_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The start date of the service period
          example: '2024-03-01'
          title: Service Start Date
        service_end_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The end date of the service period
          example: '2024-03-31'
          title: Service End Date
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: A description of the invoice
          example: Monthly services for March 2024
          title: Description
        created_at:
          description: The timestamp when the invoice was created
          example: '2024-03-21T10:00:00Z'
          format: date-time
          title: Created At
          type: string
        is_recurring:
          description: Indicates if this is a recurring invoice
          example: false
          title: Is Recurring
          type: boolean
        from_external_source:
          description: Indicates if the invoice was created from an external source
          example: false
          title: From External Source
          type: boolean
        external_source:
          anyOf:
            - type: string
            - type: 'null'
          description: The name of the external source if applicable
          example: stripe
          title: External Source
        external_source_id:
          anyOf:
            - type: string
            - type: 'null'
          description: The ID of the invoice in the external system
          example: inv_123456
          title: External Source Id
        payment_link:
          anyOf:
            - type: string
            - type: 'null'
          description: URL where the customer can pay this invoice
          example: https://app.justpaid.ai/portal/inv/123
          title: Payment Link
        line_items:
          description: List of line items included in this invoice
          items:
            $ref: '#/components/schemas/InvoiceLineItemOut2'
          title: Line Items
          type: array
        file_url:
          anyOf:
            - type: string
            - type: 'null'
          description: URL to download the invoice PDF
          example: https://api.justpaid.ai/invoices/123.pdf
          title: File Url
        customer:
          anyOf:
            - $ref: '#/components/schemas/CustomerOut2'
            - type: 'null'
          description: Details of the customer associated with this invoice
      title: InvoiceOut2
      type: object
    InvoiceLineItemOut2:
      description: Output schema for invoice line items with UUID for external API.
      properties:
        uuid:
          format: uuid
          title: Uuid
          type: string
        name:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          title: Name
        unit_price:
          anyOf:
            - type: number
            - type: 'null'
          title: Unit Price
        quantity:
          anyOf:
            - type: integer
            - type: 'null'
          default: 1
          title: Quantity
        amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Amount
        currency:
          anyOf:
            - maxLength: 3
              type: string
            - type: 'null'
          default: USD
          title: Currency
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: The description of the line item
          title: Description
        flat_fee:
          anyOf:
            - type: number
            - type: 'null'
          description: Fixed flat fee added to the line item amount
          title: Flat Fee
        tax_rate:
          anyOf:
            - type: number
            - type: 'null'
          default: 0
          title: Tax Rate
        tax_amount:
          anyOf:
            - type: number
            - type: 'null'
          default: 0
          title: Tax Amount
        tax_name:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          title: Tax Name
        discount_amount:
          anyOf:
            - type: number
            - type: 'null'
          title: Discount Amount
        discount_percent:
          anyOf:
            - type: number
            - type: 'null'
          title: Discount Percent
        service_start_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The date the service starts for the item
          title: Service Start Date
        service_end_date:
          anyOf:
            - format: date
              type: string
            - type: 'null'
          description: The date the service ends for the item
          title: Service End Date
        display_order:
          anyOf:
            - type: integer
            - type: 'null'
          description: The order in which the line item will be displayed in the UI/pdf
          title: Display Order
      title: InvoiceLineItemOut2
      type: object
    CustomerOut2:
      description: Output schema for customer information.
      properties:
        external_id:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            An optional external identifier for the customer. This can be used
            to link the customer to an external system.
          example: CUST-001
          title: External Id
        uuid:
          format: uuid
          title: Uuid
          type: string
        name:
          anyOf:
            - maxLength: 100
              type: string
            - type: 'null'
          description: Customer name
          title: Name
        contact_name:
          anyOf:
            - maxLength: 100
              type: string
            - type: 'null'
          description: The name of the contact person
          title: Contact Name
        email:
          anyOf:
            - maxLength: 100
              type: string
            - type: 'null'
          title: Email
        additional_emails:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          description: A list of additional customer email addresses
          title: Additional Emails
        billing_emails:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          description: Billing email addresses
          title: Billing Emails
        phone_number:
          anyOf:
            - maxLength: 20
              type: string
            - type: 'null'
          description: Customer phone number with country code
          title: Phone Number
        currency:
          anyOf:
            - maxLength: 3
              type: string
            - type: 'null'
          default: USD
          title: Currency
        tax_id:
          anyOf:
            - maxLength: 25
              type: string
            - type: 'null'
          description: Customer tax id
          title: Tax Id
      title: CustomerOut2
      type: object
  securitySchemes:
    HttpBearerAuth:
      type: http
      scheme: bearer

````