Fill in the fields below, then reference the result from later steps as {{getItem.response.data}}.
Request
Path parameters
item_idstringrequired
Item ID or code. For ID no prefix is used e.g. `e28zov4fw0v2`. For code use prefix `code-`, e.g. `code-red`.
Response
Returns 200 with an object. Read it in later steps with {{getItem.response.data.<field>}}.
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>
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.
namestringrequired
Fields must be created in the UI before values can be assigned to them.
valuestringrequired
Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
source_record_typestring
The type of record a custom field was automatically copied from.
One ofaccountplanproductsubscription
source_record_idstring
The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
