Request
Curl
Response
Success
Parameters
from
: integer Unix timestamp, in seconds, from when the items are to be fetched.
to
: integer Unix timestamp, in seconds, till when the items are to be fetched.
count
: integer Number of items to be fetched.
- Default value:
10 - Maximum value:
100 - This can be used for pagination, in combination with the
skipparameter.
skip
: integer Number of records to be skipped while fetching the items.
active
: integer Fetches number of active or inactive items.
- The value is
1for active items. - The value is
0for inactive items.
Parameters
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. Check the list of supported currencies.
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.
Errors
The API “ provided is invalid.- code: 4xx
- description: The API credentials passed in the API call differ from the ones generated on the Dashboard.- Different keys for test mode and live modes.
- Expired API key.
- solution: The API keys must be active and entered correctly with no whitespace before or after the keys.