Skip to content

Items

Items

Product and service catalog management. Items can be referenced in invoices and include pricing and tax information.

The Item object

object

Attributes

idstring
namestring
descriptionstring
pricenumber

Per-unit net price (before tax). Always stores net price.

metadata
Other attributes
gross_pricenumber
tax_idsarray of strings
total_taxnumber
entity_idstring
created_atstring<date-time>
updated_atstring<date-time>

Create a new item

POST/items

Create 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_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Body parameters

namestringrequired
descriptionstringoptional
pricenumberoptional

Net price per unit (before tax). Provide either price OR gross_price, not both.

taxesarray of objectsoptional

Taxes for the item. Provide rate to auto-create, or classification to lookup existing tax.

metadataobjectoptional

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.

Other parameters
gross_pricenumberoptional
tax_idsarray of stringsoptional
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": "Minimal Item",
    "price": 1500
  }'
Example:

Returns

idstring
namestring
descriptionstring
pricenumber

Per-unit net price (before tax). Always stores net price.

metadata
Other parameters
gross_pricenumber
tax_idsarray of strings
total_taxnumber
entity_idstring
created_atstring<date-time>
updated_atstring<date-time>
json
{
  "id": "item_6595a27b5d35015c3ef0c3fd",
  "name": "Minimal Item",
  "description": null,
  "price": 1500,
  "gross_price": null,
  "total_tax": 0,
  "tax_ids": [],
  "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
  "metadata": {},
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-09-01T00:00:00.000Z"
}
Example:

List all items

GET/items

Retrieve 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_idstringoptional

Entity ID on which the request is made. Optional - defaults to the first created entity if not provided.

Query parameters

limitintegeroptional

Number of results per request.

Default: 10

next_cursorstringoptional

Cursor to fetch the next page of results. Use the value from pagination.next_cursor in the previous response.

prev_cursorstringoptional

Cursor to fetch the previous page of results. Use the value from pagination.prev_cursor in the previous response.

include_total_countbooleanoptional

Whether to include the total count of items in pagination.total.
Default is true.
When false, pagination.total returns -1 for better performance.

order_byoptional
querystring<json>optional

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

searchstringoptional

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.

curl "https://eu.spaceinvoices.com/items" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "x-entity-id: YOUR_ENTITY_ID"

Returns

dataarray of objects
paginationobject

Pagination metadata including cursors and result counts

json
{
  "data": [
    {
      "id": "item_7595a27b5d35015c3ef0c3fe",
      "name": "Professional Consulting Service",
      "description": "Hourly consulting rate for software architecture",
      "price": 200,
      "gross_price": null,
      "total_tax": 44,
      "tax_ids": [
        "tax_6595a27b5d35015c3ef0c3fd"
      ],
      "entity_id": "ent_6595a27b5d35015c3ef0c3fd",
      "metadata": {
        "category": "services",
        "unit": "hour"
      },
      "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
  }
}