Items
Items
Product and service catalog management. Items can be referenced in invoices and include pricing and tax information.
The Item object
Attributes
Per-unit net price (before tax). Always stores net price.
Per-unit gross price (includes tax). Only present if user originally sent gross price.
Create a new item
/itemsCreate a new product or service item for use in invoices. Items can include pricing, tax information (inline or by reference), and unit details. All fields except name are optional.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Body parameters
Net price per unit (before tax). Provide either price OR gross_price, not both.
Gross price per unit (includes tax). If provided, net price is calculated. Provide either price OR gross_price, not both.
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
curl -X POST "https://eu.spaceinvoices.com/items" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"name": "Satellite Communication Module",
"price": 1500
}'Returns
Per-unit net price (before tax). Always stores net price.
Per-unit gross price (includes tax). Only present if user originally sent gross price.
{
"id": "item_6595a27b5d35015c3ef0c3fd",
"name": "Satellite Communication Module",
"description": null,
"price": 1500,
"gross_price": null,
"total_tax": 0,
"tax_ids": [],
"entity_id": "ent_6595a27b5d35015c3ef0c3fd",
"metadata": {},
"deleted_at": null,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}List all items
/itemsRetrieve a paginated list of items (products and services) with optional filtering and sorting. Supports cursor-based pagination, flexible JSON querying with MongoDB-style operators, full-text search, and sorting.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Query parameters
Number of results per request.
Default: 10
Opaque cursor to fetch the next page of results. Reuse only with the same effective ordering. Use the value from pagination.next_cursor in the previous response.
Opaque cursor to fetch the previous page of results. Reuse only with the same effective ordering. Use the value from pagination.prev_cursor in the previous response.
Whether to include the total count of items in pagination.total.
Default is true.
When false, pagination.total returns -1 for better performance.
Sort by one field or provide a repeated array for multi-column ordering. Prefix a field with - for descending order. When paginating, reuse cursors only with the same effective ordering.
JSON query object for filtering results. Supports MongoDB-style operators.
Supported operators:
- equals or direct value - Exact match (default)
- gte - Greater than or equal
- lte - Less than or equal
- gt - Greater than
- lt - Less than
- in - Value in array
- notIn - Value not in array
- contains - String contains (case-insensitive)
- startsWith - String starts with
- endsWith - String ends with
- between - Value between two numbers/dates [min, max]
Allowed fields: id, name, description, price, unit, created_at, updated_at
Examples:
- {"total": {"gte": 1000}} - Invoices over 1000
- {"customer.name": {"contains": "Acme"}} - Customer name contains "Acme"
- {"date": {"between": ["2025-01-01", "2025-12-31"]}} - Date range
Full-text search query to filter results across multiple fields.
Searches are case-insensitive and match partial strings.
Searches across all text fields including names, descriptions, addresses, and metadata values.
When true, returns only soft-deleted (trashed) items. Default false excludes deleted items.
curl "https://eu.spaceinvoices.com/items" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
{
"data": [
{
"id": "item_7595a27b5d35015c3ef0c3fe",
"name": "Orbital Navigation License",
"description": "Annual software license for orbital trajectory planning",
"price": 5000,
"gross_price": null,
"total_tax": 1100,
"tax_ids": [
"tax_6595a27b5d35015c3ef0c3fd"
],
"entity_id": "ent_6595a27b5d35015c3ef0c3fd",
"metadata": {
"category": "software",
"unit": "license"
},
"deleted_at": null,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}
],
"pagination": {
"total": 1,
"next_cursor": null,
"prev_cursor": null,
"has_more": false
}
}Update an item
/items/{id}Update an existing product or service item. Only the provided fields are updated. Pricing and taxes are recalculated consistently with item creation rules.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
Body parameters
Net price per unit (before tax). Provide either price OR gross_price, not both.
Gross price per unit (includes tax). If provided, net price is calculated. Provide either price OR gross_price, not both.
Custom key-value data for your own use. Store any JSON object up to 50 properties. Values must be strings up to 250 characters. Useful for storing external IDs, tags, or integration data.
curl -X PATCH "https://eu.spaceinvoices.com/items/{id}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID" \
-H "Content-Type: application/json" \
-d '{
"name": "Satellite Communication Module v2"
}'Returns
Per-unit net price (before tax). Always stores net price.
Per-unit gross price (includes tax). Only present if user originally sent gross price.
{
"id": "item_6595a27b5d35015c3ef0c3fd",
"name": "Satellite Communication Module v2",
"description": null,
"price": 1500,
"gross_price": null,
"total_tax": 0,
"tax_ids": [],
"entity_id": "ent_6595a27b5d35015c3ef0c3fd",
"metadata": {},
"deleted_at": null,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-02T00:00:00.000Z"
}Delete an item
/items/{id}Soft delete an item. The item will be moved to the trash and can be restored later.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
curl -X DELETE "https://eu.spaceinvoices.com/items/{id}" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Permanently delete an item
/items/{id}/permanentPermanently delete a soft-deleted item. Only items in the trash can be permanently deleted.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
curl -X DELETE "https://eu.spaceinvoices.com/items/{id}/permanent" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Restore a deleted item
/items/{id}/restoreRestore a soft-deleted item from the trash.
Header parameters
Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.
Path parameters
Unique resource identifier
curl -X POST "https://eu.spaceinvoices.com/items/{id}/restore" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "x-entity-id: YOUR_ENTITY_ID"Returns
Per-unit net price (before tax). Always stores net price.
Per-unit gross price (includes tax). Only present if user originally sent gross price.
{
"id": "item_6595a27b5d35015c3ef0c3fd",
"name": "Satellite Communication Module",
"description": null,
"price": 1500,
"gross_price": null,
"total_tax": 0,
"tax_ids": [],
"entity_id": "ent_6595a27b5d35015c3ef0c3fd",
"metadata": {},
"deleted_at": null,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-09-01T00:00:00.000Z"
}