Skip to main content
GET
/
v1
/
invoice-items
List invoice items
curl --request GET \
  --url https://api.wellapp.ai/v1/invoice-items \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "invoice_item",
      "id": "item_001",
      "attributes": {
        "line_id": "1",
        "sku": "WM-1001",
        "name": "Wireless Mouse",
        "description": "Ergonomic wireless mouse with USB receiver",
        "unit_price": 25,
        "currency": "EUR",
        "unit": "EA",
        "min_quantity": 1,
        "max_quantity": 500,
        "tax": {
          "rate": 20,
          "category": "standard",
          "scheme": "VAT"
        },
        "period": {
          "start": "2025-06-26",
          "end": "2025-06-27"
        },
        "created_at": "2025-05-11T13:42:12Z",
        "updated_at": "2025-05-11T13:45:20Z"
      },
      "relationships": {
        "invoices": {
          "data": [
            {
              "type": "invoice",
              "id": "invoice1"
            }
          ]
        },
        "medias": {
          "data": [
            {
              "type": "media",
              "id": "media-1"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "invoice",
      "id": "invoice1",
      "attributes": {
        "reference_number": "INV-2025-001",
        "document_type": "commercial_invoice",
        "document_type_code": "380",
        "issue_date": "2025-01-15",
        "due_date": "2025-02-15",
        "local_currency": "EUR",
        "local_totals": {
          "subtotal": "1000.00",
          "tax_total": "200.00",
          "total_amount": "1200.00"
        },
        "terms": "Payment due within 30 days",
        "billing_context": "subscription",
        "payment_status": {
          "paid": false,
          "amount_paid": 0,
          "amount_remaining": 1200
        },
        "status": "draft",
        "description": "Professional services invoice for January 2025",
        "created_at": "2025-01-15T10:30:00Z",
        "updated_at": "2025-01-15T10:30:00Z"
      }
    },
    {
      "type": "media",
      "id": "media-1",
      "attributes": {
        "media_type": "logo",
        "is_primary": true,
        "url": "https://cdn.example.com/product-images/wireless-mouse.jpg",
        "created_at": "2025-05-11T13:00:00Z",
        "updated_at": "2025-05-11T13:00:00Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

​
Complex Usage Example

​
Advanced Invoice Items Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, sorting, and pagination for retrieving invoice items: 
curl -X GET "https://api.well.com/v1/invoice-items?include=media,invoices&filter[workspace_id]=550e8400-e29b-41d4-a716-446655440000&filter[created_at][from]=2025-01-01T00:00:00Z&filter[created_at][to]=2025-12-31T23:59:59Z&filter[updated_at][from]=2025-06-01T00:00:00Z&sort=-created_at&page[limit]=15&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyNS0xMS0wMlQxMDozMDowMFoiLCJpZCI6Iml0ZW05LXV1aWQifQ==" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
include
enum<string>

Include related resources in the response. Comma-separated values supported.

Available options:
media,
invoices
​
filter[created_at][from]
string<date-time>

Filter items created from this date/time

​
filter[created_at][to]
string<date-time>

Filter items created up to this date/time

​
filter[updated_at][from]
string<date-time>

Filter items updated from this date/time

​
filter[updated_at][to]
string<date-time>

Filter items updated up to this date/time

​
filter[workspace_id]
string<uuid>

Filter items by workspace ID

​
filter[external_workspace_id]
string

Filter items by external workspace ID

​
sort
enum<string>

Sort items by field. Use - prefix for descending order.

Available options:
created_at,
-created_at,
updated_at,
-updated_at
​
page
integer
default:1

Page number for pagination

Required range: x >= 1
​
per_page
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

List of invoice items retrieved successfully

Response schema for listing invoice items

​
data
object[]

Array of invoice items

​
included
object

Related resources when included via the include parameter

​
meta
object

Metadata about the response