Sign in
Items

Create Item

Create an item (product or service) with pricing, description, and revenue or expense accounts.

post/public/v1/items/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Request body

namestring required
is_activeboolean required
skustring required
descriptionstring
item_type'good' | 'service' | 'discount' required
record_status'draft' | 'posted' | 'archived'
product_tax_code_idinteger nullable
expense_account_idinteger nullable
income_account_idinteger nullable
deferral_account_idinteger nullable
asset_account_idinteger nullable
discount_account_idinteger nullable
default_classification_line_idsinteger[] nullable
default_rev_rec_method'straight_line' | 'straight_line_start_end_even' | 'daily_prorata' | 'milestone' | 'usage_tiered' | 'usage' | 'immediate' | 'deposit_release'
default_rev_rec_invoice_frequency'one_time' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually'
default_rev_rec_invoice_intervalinteger nullable

Response

Created

created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated

idinteger required
namestring required
skustring required
descriptionstring required
item_type'good' | 'service' | 'discount' required
is_activeboolean required
record_status'draft' | 'posted' | 'archived' required
product_tax_code_idinteger nullable
expense_account_idinteger nullable
income_account_idinteger nullable
deferral_account_idinteger nullable
asset_account_idinteger nullable
discount_account_idinteger nullable
default_classification_line_idsinteger[] nullable
default_rev_rec_method'straight_line' | 'straight_line_start_end_even' | 'daily_prorata' | 'milestone' | 'usage_tiered' | 'usage' | 'immediate' | 'deposit_release'
default_rev_rec_invoice_frequency'one_time' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'semi_annually' | 'annually'
default_rev_rec_invoice_intervalinteger nullable
default_standalone_selling_pricestring nullable
default_standalone_selling_price_currency_iso_4217_code'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL'
default_standalone_selling_price_exchange_ratestring nullable

Changes