API Endpoint | Description |
---|---|
Creates an item by providing basic details such as name and amount. | |
Retrieves details an item by id. | |
Retrieves details of multiple items. | |
Updates the details of an item. | |
Deletes an item. |
Items
Create and manage items using Curlec APIs.
If your business requires you to create custom items, you can create pre-defined item templates beforehand and use these later as line items.
The Items entity has the following fields:
id
string
The unique identifier of the item.
active
boolean
Indicates the status of the item. Possible values:
true
(default): Item is in the active state.false
: Item is in the inactive state.
name
string
The name of the item.
description
string
A text description about the item.
amount
integer
The price of the item.
unit_amount
integer
The per unit billing amount for each individual unit.
currency
string
The currency in which the amount should be charged.
type
string
Here, it must be invoice
.
unit
integer
The number of units of the item billed in the invoice.
tax_inclusive
boolean
Indicates whether the base amount includes tax.
true
: The base amount includes tax.false
: The base amount does not include tax. By default, the value is set tofalse
.
hsn_code
integer
The 8-digit code used to classify the product as per the Harmonised System of Nomenclature.
sac_code
integer
The 6-digit code used to classify the service as per the Services Accounting Code.
tax_rate
string
The percentage at which an individual or a corporation is taxed.
tax_id
string
: The identification number that gets displayed on invoices issued to the customer.
tax_group_id
string
: The identification number for the tax group. A tax group is a collection of taxes that can be applied as a single set of rules.
created_at
integer
Unix timestamp, at which the item was created. For example, 1649843796
.
You can create and manage items using APIs or from the
.Was this page helpful?
ON THIS PAGE