Items API
Access and create your catalog items.
Read scope: items:read
Write scope: items:write
List Items
GET /itemsReturns all catalog items for your business.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
item_type | string | Filter by type: SALES, PURCHASE, or TEXT |
page | integer | Page number (default: 1) |
page_size | integer | Items per page (default: 50, max: 100) |
Example Request
curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
"https://api.rebased.app/api/v1/external/items?item_type=SALES"Example Response
{
"items": [
{
"id": "aa0e8400-e29b-41d4-a716-446655440000",
"item_code": "CONSULT-HR",
"name": "Consulting - Hourly",
"description": "Professional consulting services",
"item_type": "SALES",
"unit_price": 150.00,
"is_taxable": true,
"account_id": "880e8400-e29b-41d4-a716-446655440000",
"tax_code_id": "990e8400-e29b-41d4-a716-446655440000",
"is_active": true,
"created_at": "2026-01-05T09:00:00Z",
"updated_at": "2026-03-10T14:00:00Z"
}
],
"total": 1,
"page": 1,
"page_size": 50,
"has_more": false
}Get Item
GET /items/{id}Returns a single catalog item by ID.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string (UUID) | The item ID |
Example Request
curl -H "Authorization: Bearer rb_live_YOUR_API_KEY" \
"https://api.rebased.app/api/v1/external/items/aa0e8400-e29b-41d4-a716-446655440000"Create Item
POST /itemsCreates a new catalog item.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Item name |
item_code | string | No | Unique item code (must be unique within your business) |
description | string | No | Item description |
item_type | string | No | SALES, PURCHASE, or TEXT (default: SALES) |
unit_price | decimal | Required for SALES/PURCHASE | Price per unit |
is_taxable | boolean | No | Whether the item is taxable (default: true) |
account_id | string | Yes | Revenue/expense account ID (from GET /accounts) |
tax_code_id | string | Yes | Tax code ID (from GET /tax-codes) |
Example Request
curl -X POST \
-H "Authorization: Bearer rb_live_YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Consulting - Hourly",
"item_code": "CONSULT-HR",
"description": "Professional consulting services",
"item_type": "SALES",
"unit_price": 150.00,
"is_taxable": true,
"account_id": "880e8400-e29b-41d4-a716-446655440000",
"tax_code_id": "990e8400-e29b-41d4-a716-446655440000"
}' \
"https://api.rebased.app/api/v1/external/items"Example Response (201 Created)
{
"id": "aa0e8400-e29b-41d4-a716-446655440000",
"item_code": "CONSULT-HR",
"name": "Consulting - Hourly",
"description": "Professional consulting services",
"item_type": "SALES",
"unit_price": 150.00,
"is_taxable": true,
"account_id": "880e8400-e29b-41d4-a716-446655440000",
"tax_code_id": "990e8400-e29b-41d4-a716-446655440000",
"is_active": true,
"created_at": "2026-04-04T09:00:00Z",
"updated_at": null
}Errors
| Status | Detail |
|---|---|
| 409 | Item code already exists |
| 422 | unit_price is required for SALES and PURCHASE items |
| 422 | item_type must be one of: SALES, PURCHASE, TEXT |
Item Object
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier (UUID) |
item_code | string | Unique item code |
name | string | Item name |
description | string | Item description |
item_type | string | SALES, PURCHASE, or TEXT |
unit_price | decimal | Price per unit |
is_taxable | boolean | Whether the item is taxable |
account_id | string | Revenue/expense account ID |
tax_code_id | string | Tax code ID |
is_active | boolean | Whether the item is active |
created_at | datetime | When the item was created |
updated_at | datetime | When the item was last updated |
Last updated on