> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt > Use this file to discover all available pages before exploring further. # Get Invoices > List Invoices Retrieve a paginated list of invoices with filtering and sorting. ## OpenAPI ````yaml https://api.stuut.ai/openapi.json get /v2/invoices openapi: 3.1.0 info: title: Stuut API termsOfService: https://stuut.ai/terms-and-conditions contact: name: Stuut Support url: https://stuut.ai/ email: devs@stuut.co version: 2.0.0 servers: [] security: - HTTPBearer: [] tags: - name: adjustments description: Operations for managing payment adjustments (fees, discounts, write-offs). x-displayName: Adjustments - name: aether description: Operations for aether. x-displayName: Aether - name: analytics description: Operations for retrieving analytics and dashboard data. x-displayName: Analytics - name: assistant description: Operations for the in-app chat assistant. x-displayName: Assistant - name: audit-log description: Operations for retrieving the organization's audit log. x-displayName: Audit Log - name: bank-accounts description: Operations for retrieving and managing bank accounts. x-displayName: Bank Accounts - name: bank-statements description: Operations for retrieving and managing bank statements. x-displayName: Bank Statements - name: bank-transactions description: Operations for retrieving and managing bank transactions. x-displayName: Bank Transactions - name: business-units description: Operations for listing and managing business units. x-displayName: Business Units - name: call-agent description: >- Operations for initiating and managing real-time voice calls with partners. x-displayName: Call Agent - name: calls description: Operations for retrieving and managing voice call records. x-displayName: Calls - name: cash-app description: Operations for cash application — matching incoming payments to invoices. x-displayName: Cash Application - name: chats description: Operations for managing chat conversations. x-displayName: Chats - name: cnam-registration description: Operations for managing CNAM (caller ID name) registration. x-displayName: CNAM Registration - name: credit-memos description: Operations for retrieving and searching credit memos. x-displayName: Credit Memos - name: custom-table-templates description: >- Operations for managing custom table templates used in email template variables. x-displayName: Custom Table Templates - name: customer-segments description: Operations for managing customer segments. x-displayName: Customer Segments - name: deductions-knowledge description: Operations for managing deduction processing knowledge entries. x-displayName: Deductions Knowledge - name: email-threads description: Operations for managing email threads. x-displayName: Email Threads - name: emails description: Operations for retrieving and managing emails. x-displayName: Emails - name: exports description: Operations for requesting and retrieving async data exports. x-displayName: Exports - name: integrations description: >- Operations for managing integrations with external systems (e.g. ERP, CRM, etc.). x-displayName: Integrations - name: internal-contacts description: >- Operations for managing internal contacts (CSMs, account managers, etc.) and their assignments to partners. x-displayName: Internal Contacts - name: invoices description: Operations for retrieving and managing invoices. x-displayName: Invoices - name: kyb description: Operations for Know Your Business (KYB) verification. x-displayName: KYB - name: ledger-accounts description: Operations for retrieving and managing ledger accounts. x-displayName: Ledger Accounts - name: mailbox-settings description: >- Operations for an organization's mailbox provider configuration: Microsoft admin consent, shared-mailbox discovery, and provider health. x-displayName: Mailbox Settings - name: mailboxes description: >- Operations for connecting, listing, updating, and archiving user and shared mailboxes, including delegated OAuth sign-in. x-displayName: Mailboxes - name: media description: >- Operations for signing direct-to-storage media uploads (e.g. signature images). x-displayName: Media - name: organizations description: Operations for retrieving and managing the current organization. x-displayName: Organizations - name: outreach-workflows description: Operations for managing automated collections outreach workflows. x-displayName: Outreach Workflows - name: partners description: Operations for retrieving and managing customers. x-displayName: Partners - name: payments description: Operations for approving and managing payments. x-displayName: Payments - name: report-configs description: >- Operations for managing report configurations (frequency, recipients, schedule). x-displayName: Report Configs - name: sms-campaign-registration description: Operations for managing A2P 10DLC SMS campaign registration. x-displayName: SMS Campaign Registration - name: sms-templates description: >- Operations for defining, storing, and managing parameterized SMS message templates. x-displayName: SMS Templates - name: sms-threads description: Operations for retrieving and managing SMS conversation threads. x-displayName: SMS Threads - name: users description: Operations for retrieving and managing users. x-displayName: Users - name: users-ooo description: Operations for managing user out-of-office (OOO) status and coverage. x-displayName: Users OOO paths: /v2/invoices: get: tags: - invoices summary: Get Invoices description: |- List Invoices Retrieve a paginated list of invoices with filtering and sorting. operationId: GetInvoices parameters: - name: page in: query required: false schema: type: integer minimum: 0 description: Page number, 0 indexed. default: 0 description: Page number, 0 indexed. - name: limit in: query required: false schema: type: integer maximum: 500 minimum: 1 description: Number of records per page. default: 100 description: Number of records per page. - name: sort_by in: query required: false schema: anyOf: - enum: - default - due_date - issued_at - paid_at - amount_due - amount_remaining - pending_amount_remaining - total_amount - number - last_outreach_at - promised_to_pay_date type: string x-speakeasy-enum-format: union - type: 'null' - name: sort_order in: query required: false schema: $ref: '#/components/schemas/SortOrder' default: desc - name: status__in in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/InvoiceVirtualStatus' - type: 'null' description: >- Filter by invoice status. Includes virtual statuses: 'processing' (open with payment), 'partially_paid', 'overdue' (open and past due), 'promised' (open with an upcoming or current promise-to-pay date), 'broken_promise' (open with a promise-to-pay date that has passed). description: >- Filter by invoice status. Includes virtual statuses: 'processing' (open with payment), 'partially_paid', 'overdue' (open and past due), 'promised' (open with an upcoming or current promise-to-pay date), 'broken_promise' (open with a promise-to-pay date that has passed). - name: partner_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by partner ID description: Filter by partner ID - name: assignee_id in: query required: false schema: anyOf: - type: string - type: 'null' description: Filter by assignee ID description: Filter by assignee ID - name: number__in in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: Filter by invoice numbers description: Filter by invoice numbers - name: amount_remaining_lte in: query required: false schema: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal - name: amount_remaining_gte in: query required: false schema: anyOf: - type: number - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal - name: in_dispute in: query required: false schema: type: boolean description: Filter by whether invoice is in dispute description: Filter by whether invoice is in dispute - name: due_date__eq in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Due date exactly on description: Due date exactly on - name: due_date__gte in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Due date on or after description: Due date on or after - name: due_date__lte in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Due date on or before description: Due date on or before - name: issued_at__eq in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Issued at exactly on description: Issued at exactly on - name: issued_at__gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Issued at on or after description: Issued at on or after - name: issued_at__lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Issued at on or before description: Issued at on or before - name: promised_to_pay_date__eq in: query required: false schema: anyOf: - type: string format: date - type: 'null' description: Promised to pay exactly on description: Promised to pay exactly on - name: promised_to_pay_date__lte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Promised to pay on or before description: Promised to pay on or before - name: promised_to_pay_date__gte in: query required: false schema: anyOf: - type: string format: date-time - type: 'null' description: Promised to pay on or after description: Promised to pay on or after - name: search in: query required: false schema: anyOf: - type: string - type: 'null' description: >- Search in invoice number, partner name, account number, PO number, order number description: >- Search in invoice number, partner name, account number, PO number, order number - name: business_unit_id__in in: query required: false schema: anyOf: - items: type: string type: array - type: 'null' description: Filter by business unit IDs (via partner) description: Filter by business unit IDs (via partner) - name: has_outreach in: query required: false schema: type: boolean description: Filter by whether invoice has had outreach description: Filter by whether invoice has had outreach - name: customer_outreach_paused in: query required: false schema: type: boolean description: Filter by whether customer outreach is paused description: Filter by whether customer outreach is paused - name: currency__in in: query required: false schema: anyOf: - type: array items: $ref: '#/components/schemas/Currency' - type: 'null' description: Filter by currency codes (ISO 4217, e.g., ['usd', 'eur']) description: Filter by currency codes (ISO 4217, e.g., ['usd', 'eur']) - name: custom_fields in: query required: false schema: anyOf: - type: string - type: 'null' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaginatedResponse_InvoiceListSchema_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: SortOrder: type: string enum: - asc - desc title: SortOrder InvoiceVirtualStatus: type: string enum: - draft - open - uncollectible - paid - void - processing - overdue - partially_paid - promised - broken_promise title: InvoiceVirtualStatus Currency: type: string enum: - ADP - AED - AFA - AFN - ALK - ALL - AMD - ANG - AOA - AOK - AON - AOR - ARA - ARL - ARM - ARP - ARS - ATS - AUD - AWG - AZM - AZN - BAD - BAM - BAN - BBD - BDT - BEC - BEF - BEL - BGL - BGM - BGN - BGO - BHD - BIF - BMD - BND - BOB - BOL - BOP - BOV - BRB - BRC - BRE - BRL - BRN - BRR - BRZ - BSD - BTN - BUK - BWP - BYB - BYN - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLE - CLF - CLP - CNH - CNX - CNY - COP - COU - CRC - CSD - CSK - CUC - CUP - CVE - CYP - CZK - DDM - DEM - DJF - DKK - DOP - DZD - ECS - ECV - EEK - EGP - ERN - ESA - ESB - ESP - ETB - EUR - FIM - FJD - FKP - FRF - GBP - GEK - GEL - GHC - GHS - GIP - GMD - GNF - GNS - GQE - GRD - GTQ - GWE - GWP - GYD - HKD - HNL - HRD - HRK - HTG - HUF - IDR - IEP - ILP - ILR - ILS - INR - IQD - IRR - ISJ - ISK - ITL - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRH - KRO - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LTT - LUC - LUF - LUL - LVL - LVR - LYD - MAD - MAF - MCF - MDC - MDL - MGA - MGF - MKD - MKN - MLF - MMK - MNT - MOP - MRO - MRU - MTL - MTP - MUR - MVP - MVR - MWK - MXN - MXP - MXV - MYR - MZE - MZM - MZN - NAD - NGN - NIC - NIO - NLG - NOK - NPR - NZD - OMR - PAB - PEI - PEN - PES - PGK - PHP - PKR - PLN - PLZ - PTE - PYG - QAR - RHD - ROL - RON - RSD - RUB - RUR - RWF - SAR - SBD - SCR - SDD - SDG - SDP - SEK - SGD - SHP - SIT - SKK - SLE - SLL - SOS - SRD - SRG - SSP - STD - STN - SUR - SVC - SYP - SZL - THB - TJR - TJS - TMM - TMT - TND - TOP - TPE - TRL - TRY - TTD - TWD - TZS - UAH - UAK - UGS - UGX - USD - USN - USS - UYI - UYP - UYU - UYW - UZS - VEB - VED - VEF - VES - VND - VNN - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XEU - XFO - XFU - XOF - XPD - XPF - XPT - XRE - XSU - XTS - XUA - XXX - YDD - YER - YUD - YUM - YUN - YUR - ZAL - ZAR - ZMK - ZMW - ZRN - ZRZ - ZWD - ZWL - ZWR description: >- The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. x-speakeasy-enum-format: union PaginatedResponse_InvoiceListSchema_: properties: data: items: $ref: '#/components/schemas/InvoiceListSchema' type: array title: '' description: The list of records. current_page: type: integer title: '' description: The current page. default: 0 total_records: anyOf: - type: integer minimum: 0 - type: 'null' title: '' description: Total number of records. next_page: anyOf: - type: integer - type: 'null' title: '' description: The next page number, if one exists. type: object required: - data - current_page - total_records - next_page title: PaginatedResponse[InvoiceListSchema] HTTPValidationError: $defs: ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Type type: string required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true properties: type: const: request-validation title: Type type: string detail: anyOf: - type: string - type: 'null' default: null description: Human-readable description of this specific problem. title: Detail x-speakeasy-error-message: true status: const: 422 title: Status type: integer title: description: Short human-readable summary of the problem. title: Title type: string x-speakeasy-error-message: true errors: items: $ref: '#/components/schemas/ValidationError' title: Errors type: array required: - type - status - title - errors title: APIError type: object InvoiceListSchema: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' number: anyOf: - type: string - type: 'null' title: '' description: >- A unique, identifying string that appears on emails sent to the customer for this invoice. currency: $ref: '#/components/schemas/Currency' title: '' description: The invoice's currency code (e.g. USD). amount_due: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal title: '' description: The total amount due on the invoice. amount_paid: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal title: '' description: The total amount paid on the invoice. amount_remaining: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal title: '' description: The remaining balance on the invoice, excluding unposted payments. pending_amount_remaining: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal title: '' description: The remaining balance on the invoice, including unposted payments. total_amount: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ format: decimal title: '' description: The total amount on the invoice. due_date: anyOf: - type: string format: date-time - type: 'null' title: '' description: The invoice's due date. issued_at: anyOf: - type: string format: date-time - type: 'null' title: '' description: The invoice's issue date. paid_at: anyOf: - type: string format: date-time - type: 'null' title: '' description: The date the invoice was paid. promised_to_pay_date: anyOf: - type: string format: date - type: 'null' title: '' description: The date the customer has promised to pay the invoice. current_payment_promise_id: anyOf: - type: string - type: 'null' title: '' remote_created_at: anyOf: - type: string format: date-time - type: 'null' title: '' description: When the third party's entry was created. purchase_order_number: anyOf: - type: string - type: 'null' title: '' description: Unique identifier assigned to a purchase order by a buyer. order_number: anyOf: - type: string - type: 'null' title: '' description: Unique identifier assigned to a purchase by a seller. partner: anyOf: - $ref: '#/components/schemas/PartnerSummary' - type: 'null' title: '' description: The invoice's vendor or customer. last_outreach_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: The last date outreach was sent for this invoice. last_outreach_to: anyOf: - type: string - type: 'null' title: '' description: >- The last recipient of outreach that was sent for this invoice (email address or phone number). last_outreach_channel: anyOf: - $ref: '#/components/schemas/OutreachActionType' - type: 'null' title: '' description: >- The last channel outreach was sent in for this invoice (phone or email). in_dispute: type: boolean title: '' description: >- Whether an invoice is in dispute. If it is, we exclude it from any outreach. remote_payment_status: anyOf: - $ref: '#/components/schemas/PaymentStatus' - type: 'null' title: '' description: >- Status of payment on this invoice. NOTE: Source of this status could be different from the source of `remote_status`, and could be out of sync with it. It is currently controlled Stripe webhooks that receive partner portal session events. If payment was initiated and failed, remote_payment_status should be set to None. unresolved_dispute_item_status: anyOf: - $ref: '#/components/schemas/DisputeStatus' - type: 'null' title: '' unresolved_dispute_id: anyOf: - type: string - type: 'null' title: '' object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true virtual_status: $ref: '#/components/schemas/InvoiceVirtualStatus' title: '' description: >- Virtual status combining base status with conditions for OPEN invoices. readOnly: true days_overdue: anyOf: - type: integer - type: 'null' title: '' description: Number of days past due. Only set for overdue invoices. readOnly: true days_until_due: anyOf: - type: integer - type: 'null' title: '' description: >- Number of days until due. Only set for open invoices with a due date. readOnly: true payment_url: anyOf: - type: string - type: 'null' title: '' description: Payment portal URL for this invoice. readOnly: true type: object required: - created_at - modified_at - id - number - currency - amount_due - amount_paid - amount_remaining - pending_amount_remaining - total_amount - due_date - issued_at - paid_at - promised_to_pay_date - current_payment_promise_id - remote_created_at - purchase_order_number - order_number - partner - last_outreach_at - last_outreach_to - last_outreach_channel - in_dispute - remote_payment_status - unresolved_dispute_item_status - unresolved_dispute_id - object - virtual_status - days_overdue - days_until_due - payment_url title: InvoiceList description: |- Lightweight invoice summary for list endpoint. Includes PartnerSummary for table display (name, account_number). ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: type: string title: Type required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true PartnerSummary: properties: created_at: $ref: '#/components/schemas/UTCDateTime' title: '' modified_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' id: type: string title: '' account_number: anyOf: - type: string - type: 'null' title: '' description: The customer's account number. assignee_id: anyOf: - type: string - type: 'null' title: '' description: The ID of the user assigned to this partner, if any. business_unit_id: anyOf: - type: string - type: 'null' title: '' description: The business unit this partner belongs to. currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' title: '' description: The partner's default currency code (e.g. USD). email: anyOf: - type: string - type: 'null' title: '' description: The partner's company email address. name: anyOf: - type: string - type: 'null' title: '' description: The full name of the partner. legal_name: anyOf: - type: string - type: 'null' title: '' description: The legal name of this partner, typically applies to businesses. phone: anyOf: - type: string format: phone description: >- A phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format - type: 'null' title: '' description: The partner's default phone number. parent_id: anyOf: - type: string - type: 'null' title: '' remote_id: type: string title: '' description: The partner's third party id. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true type: object required: - created_at - modified_at - id - account_number - assignee_id - business_unit_id - currency - email - name - legal_name - phone - parent_id - remote_id - object title: PartnerSummary UTCDateTime: type: string format: date-time OutreachActionType: type: string enum: - email - call - sms title: OutreachActionType PaymentStatus: type: string enum: - processing - completed title: PaymentStatus DisputeStatus: type: string enum: - proposed - in_process - needs_review - resolved - closed title: DisputeStatus description: Status of a dispute in the resolution workflow. securitySchemes: HTTPBearer: type: http scheme: bearer ````