v1

latestOpenAPI 3.0.12026-07-141671231.8 MB

Customer Invoices

List customer invoices

List customer invoices and credit notes

ℹ️ This endpoint requires one of the following scopes: customer_invoices:all, customer_invoices:readonly

get/api/external/v2/customer_invoices

Query parameters

cursorstring

Example:dXBkYXRlZF9hdDoxNjc0MTIzNDU2

Cursor for pagination. Use this to fetch the next set of results. The cursor is an opaque string returned in the previous response's metadata. Leave empty for the first request.

limitinteger

Example:20

Number of items to return per request. Defaults to 20 if not specified. Must be between 1 and 100.

filterstring

Example:[{"field": "date", "operator": "gteq", "value": "2024-01-01"}, {"field": "credit_note", "operator": "eq", "value": "true"}]

You can choose to filter items on specific fields. Available fields and values:

id, date, customer_id, billing_subscription_id, quote_id: lt, lteq, gt, gteq, eq, not_eq, in, not_in
invoice_number: eq, not_eq, in, not_in
draft: eq (boolean)
credit_note: eq (boolean)
external_reference: eq
flow_id: eq, not_eq, in, not_in
category_id: in

sortstring

Example:id

You can choose to sort items on specific attributes Sort field may be prefixed with - for descending order. Example : id will sort by ascending order, -id will sort by descending order. Available fields : id, date

includestring

Example:invoice_lines

You can choose to include additional related resources in the response. When specified, related resources will be returned in a separate included section. Available includes: invoice_lines

⚠️ Warning: This feature is currently experimental and may change or be removed in future releases. We recommend using it with caution in production environments.

Response

A list of Customer Invoices and/or credit notes

has_moreboolean required

Indicates whether additional results are available beyond this set. Use this flag to determine if another request is needed.

next_cursorstring nullable required

Cursor to retrieve the next set of results. Include this value in the cursor parameter of your next request to fetch subsequent items. A null next_cursor in the response indicates no further results.

Example response

{
  "items": [
    {
      "id": 42,
      "label": "Invoice label",
      "invoice_number": "F20230001",
      "amount": "230.32",
      "currency_amount": "230.32",
      "currency_amount_before_tax": "196.32",
      "exchange_rate": "1.0",
      "date": "2023-08-30",
      "deadline": "2020-09-02",
      "currency_tax": "34.0",
      "tax": "34.0",
      "discount": {
        "value": "25"
      },
      "ledger_entry": {
        "id": 42002
      },
      "public_file_url": "https://app.pennylane.com/public/invoice/pdf?encrypted_id=bzjoVJe...3D%3D",
      "filename": "my_file.pdf",
      "remaining_amount_with_tax": "20.0",
      "remaining_amount_without_tax": "16.0",
      "special_mention": "Additional details",
      "customer": {
        "id": 42,
        "url": "https://app.pennylane.com/api/external/v2/customers/42"
      },
      "invoice_line_sections": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/invoice_line_sections"
      },
      "invoice_lines": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/invoice_lines"
      },
      "custom_header_fields": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/custom_header_fields"
      },
      "categories": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/categories"
      },
      "pdf_invoice_free_text": "Thanks for paying this invoice",
      "pdf_invoice_subject": "Invoice subject",
      "pdf_description": "Invoice description",
      "credited_invoice": {
        "id": 40,
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/40"
      },
      "transaction_reference": {
        "banking_provider": "bank",
        "provider_field_name": "label",
        "provider_field_value": "invoice_number"
      },
      "payments": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/payments"
      },
      "matched_transactions": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/matched_transactions"
      },
      "appendices": {
        "url": "https://app.pennylane.com/api/external/v2/customer_invoices/42/appendices"
      },
      "quote": {
        "id": 42
      },
      "external_reference": "FR123",
      "archived_at": "2023-08-30T10:08:08.146343Z",
      "created_at": "2023-08-30T10:08:08.146343Z",
      "updated_at": "2023-08-30T10:08:08.146343Z"
    }
  ],
  "has_more": true,
  "next_cursor": "dXBkYXRlZF9hdDoxNjc0MTIzNDU2"
}