Get Started
API Reference
- Api keys
- Items
- GETRetrieves the item list.
- POSTCreate a new item (product or service).
- GETGet the given item (product or service).
- PUTEdit the given item (product or service).
- DELDelete the given item (product or service).
- PATCHInactivate the given item (product or service).
- PATCHActivate the given item (product or service).
- GETRetrieves the item associated invoices transactions.
- GETRetrieves the item associated bills transactions.
- GETRetrieves the item associated estimates transactions.
- GETRetrieves the item associated receipts transactions.
- GET
- Inventory Adjustments
- Branches
- Warehouses
- Accounts
- Inventory Cost
- Sale Invoices
- Pdf Templates
- Tax Rates
- Payments Received
- Import
- resources
- Payment Links
- stripe
- Item Categories
- Expenses
- Warehouse Transfers
- Customers
- Vendors
- Sale Estimates
- Sale Receipts
- Bills
- Landed Cost
- Manual Journals
- Credit Notes
- Credit Note Refunds
- Credit Notes Apply Invoice
- Vendor Credits
- Vendor Credits Apply Bills
- Bill Payments
- Vendor Credits Refunds
- Bank Accounts
- Banking Plaid
- banking-plaid
- Banking Categorization
- Banking Transactions
- Banking Uncategorized Transactions
- Banking Pending Transactions
- Bank Rules
- Banking Recognized Transactions
- Banking Transactions Matching
- Transactions Locking
- Settings
- Reports
- Dashboard
- Roles
- Subscriptions
- Organization
- Payment Services
- Attachments
- Export
- Views
- Currencies
- misc
- Users
- Contacts
Items
Get the given item (product or service).
GET
/
api
/
items
/
{id}
Copy
{
"id": 1,
"name": "Ergonomic Office Chair Model X-2000",
"type": "inventory",
"typeFormatted": "Inventory Item",
"code": "CHAIR-X2000",
"sellable": true,
"purchasable": true,
"sellPrice": 399.99,
"sellPriceFormatted": "$399.99",
"costPrice": 299.99,
"costPriceFormatted": "$299.99",
"currencyCode": "USD",
"costAccountId": 1001,
"costAccount": {},
"inventoryAccountId": 3001,
"inventoryAccount": {},
"sellAccountId": 2001,
"sellAccount": {},
"categoryId": 5,
"category": {},
"sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
"purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
"quantityOnHand": 50,
"note": "Available in black, gray, and navy colors. 5-year warranty included.",
"active": true,
"sellTaxRateId": 1,
"sellTaxRate": {},
"purchaseTaxRateId": 1,
"purchaseTaxRate": {},
"itemWarehouses": [
"<any>"
],
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z"
}
Headers
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Path Parameters
The item id
Response
200
application/json
The item details have been successfully retrieved.
The response is of type object
.
Copy
{
"id": 1,
"name": "Ergonomic Office Chair Model X-2000",
"type": "inventory",
"typeFormatted": "Inventory Item",
"code": "CHAIR-X2000",
"sellable": true,
"purchasable": true,
"sellPrice": 399.99,
"sellPriceFormatted": "$399.99",
"costPrice": 299.99,
"costPriceFormatted": "$299.99",
"currencyCode": "USD",
"costAccountId": 1001,
"costAccount": {},
"inventoryAccountId": 3001,
"inventoryAccount": {},
"sellAccountId": 2001,
"sellAccount": {},
"categoryId": 5,
"category": {},
"sellDescription": "Premium ergonomic office chair with adjustable height and lumbar support",
"purchaseDescription": "Ergonomic office chair - Model X-2000 with standard features",
"quantityOnHand": 50,
"note": "Available in black, gray, and navy colors. 5-year warranty included.",
"active": true,
"sellTaxRateId": 1,
"sellTaxRate": {},
"purchaseTaxRateId": 1,
"purchaseTaxRate": {},
"itemWarehouses": [
"<any>"
],
"createdAt": "2024-03-20T10:00:00Z",
"updatedAt": "2024-03-20T10:00:00Z"
}
Assistant
Responses are generated using AI and may contain mistakes.