Fill in the fields below, then reference the result from later steps as {{listItems.response.data}}.
Request
Query parameters
idsarray<string>
Filter results by their IDs. Up to 200 IDs can be passed at once using
commas as separators, e.g. `ids=h1at4d57xlmy,gyqgg0d3v9n1,jrsm5b4yefg6`.
**Important notes:**
* The `ids` parameter cannot be used with any other ordering or filtering
parameters (`limit`, `order`, `sort`, `begin_time`, `end_time`, etc)
* Invalid or unknown IDs will be ignored, so you should check that the
results correspond to your request.
* Records are returned in an arbitrary order. Since results are all
returned at once you can sort the records yourself.
limitinteger
Limit number of records 1-200.
Default 20
orderstring
Sort order.
One ofascdescDefault "desc"
sortstring
Sort field. You *really* only want to sort by `updated_at` in ascending
order. In descending order updated records will move behind the cursor and could
prevent some records from being returned.
One ofcreated_atupdated_atDefault "created_at"
begin_timestring (date-time)
Inclusively filter by begin_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
end_timestring (date-time)
Inclusively filter by end_time when `sort=created_at` or `sort=updated_at`.
**Note:** this value is an ISO8601 timestamp. A partial timestamp that does not include a time zone will default to UTC.
statestring
Filter by state.
One ofactiveinactive
Response
Returns 200 with an object. Read it in later steps with {{listItems.response.data.<field>}}.
objectstring
Will always be List.
has_moreboolean
Indicates there are more results on subsequent pages.
nextstring
Path to subsequent page of results.
dataarray<object>
idstring
objectstring
codestring
Unique code to identify the item.
statestring
The current state of the item.
One ofactiveinactive
namestring
This name describes your item and will appear on the invoice when it's purchased on a one time basis.
descriptionstring
Optional, description.
external_skustring
Optional, stock keeping unit to link the item to other inventory systems.
accounting_codestring
Accounting code for invoice line items.
revenue_schedule_typestring
One ofat_range_endat_range_startevenlynever
performance_obligation_idstring
The ID of a performance obligation. Performance obligations are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.
liability_gl_account_idstring
The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.
revenue_gl_account_idstring
The ID of a general ledger account. General ledger accounts are
only accessible as a part of the Recurly RevRec Standard and
Recurly RevRec Advanced features.
avalara_transaction_typeinteger
Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
avalara_service_typeinteger
Used by Avalara for Communications taxes. The transaction type in combination with the service type describe how the item is taxed. Refer to [the documentation](https://help.avalara.com/AvaTax_for_Communications/Tax_Calculation/AvaTax_for_Communications_Tax_Engine/Mapping_Resources/TM_00115_AFC_Modules_Corresponding_Transaction_Types) for more available t/s types.
tax_codestring
Optional field used by Avalara, Vertex, and Recurly's In-the-Box tax solution to determine taxation rules. You can pass in specific tax codes using any of these tax integrations. For Recurly's In-the-Box tax offering you can also choose to instead use simple values of `unknown`, `physical`, or `digital` tax codes.
harmonized_system_codestring
The Harmonized System (HS) code is an internationally standardized system of names and numbers to classify traded products. The HS code, sometimes called Commodity Code, is used by customs authorities around the world to identify products when assessing duties and taxes. The HS code may also be referred to as the tariff code or customs code. Values should contain only digits and decimals.
tax_exemptboolean
`true` exempts tax on the item, `false` applies tax on the item.
custom_fieldsarray<object>4 fields
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
