Skip to main content
PATCH
Update Item (partial)

Authorizations

X-API-KEY
string
header
required

Headers

Idempotency-Key
string

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.

Maximum string length: 255

Path Parameters

item_id
integer
required

Body

application/json
name
string | null
Required string length: 2 - 256
is_active
boolean | null
sku
string | null
Required string length: 1 - 64
description
string | null
Maximum string length: 512
item_type
enum<string> | null
Available options:
good,
service,
discount
record_status
enum<string> | null
Available options:
draft,
posted,
archived
product_tax_code_id
integer | null
expense_account_id
integer | null
income_account_id
integer | null
deferral_account_id
integer | null
asset_account_id
integer | null
discount_account_id
integer | null
default_classification_line_ids
integer[] | null
default_rev_rec_method
enum<string> | null
Available options:
straight_line,
straight_line_start_end_even,
daily_prorata,
milestone,
usage_tiered,
usage,
immediate,
deposit_release
default_rev_rec_invoice_frequency
enum<string> | null
Available options:
one_time,
daily,
weekly,
monthly,
quarterly,
semi_annually,
annually
default_rev_rec_invoice_interval
integer | null
Required range: x >= 1
default_standalone_selling_price
default_standalone_selling_price_currency_iso_4217_code
Available options:
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

Response

OK

created_at
string<date-time>
required

Date and time the record was created

updated_at
string<date-time>
required

Date and time the record was last updated

id
integer
required
name
string
required
sku
string
required
description
string
required
item_type
enum<string>
required
Available options:
good,
service,
discount
is_active
boolean
required
record_status
enum<string>
required
Available options:
draft,
posted,
archived
created_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

updated_by
AuditActorSchemaOut · object | null

Schema for audit actor information.

product_tax_code_id
integer | null
expense_account_id
integer | null
income_account_id
integer | null
deferral_account_id
integer | null
asset_account_id
integer | null
discount_account_id
integer | null
default_classification_line_ids
integer[] | null
default_rev_rec_method
enum<string> | null
Available options:
straight_line,
straight_line_start_end_even,
daily_prorata,
milestone,
usage_tiered,
usage,
immediate,
deposit_release
default_rev_rec_invoice_frequency
enum<string> | null
Available options:
one_time,
daily,
weekly,
monthly,
quarterly,
semi_annually,
annually
default_rev_rec_invoice_interval
integer | null
default_standalone_selling_price
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
default_standalone_selling_price_currency_iso_4217_code
enum<string> | null
Available options:
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_rate
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Last modified on August 28, 2026