Product

📘

Required roles

  • Product-*

Learn more about Products in our Knowledge Base.

Properties

Property

Type

Required

Information

BusinessId

int

Yes

BusinessName

string

No

Read-only

Name

string

Yes

Description

string

Yes

InvoiceLineDisplayAs

string

No

Sku

string

No

Tags

string

No

DisplayOrder

int

No

Price

float

No

Visible

boolean

No

SyncToSquare

boolean

No

CurrencyId

int

Yes

CurrencyCode

string

No

Read-only

TaxRateId

int

No

ReducedTaxRateId

int

No

ExemptTaxRateId

int

No

FinancialAccountId

int

No

AvailableAs

enum

No

Valid values

OnlyForContacts

boolean

No

OnlyForMembers

boolean

No

Tariffs

array_int

No

Archived

boolean

No

Starred

boolean

No

TrackStock

boolean

No

AllowNegativeStock

boolean

No

CurrentStock

int

No

StockAlertLevel

int

No

ApplyProRating

boolean

No

InvoiceCoworker

boolean

No

SyncToNexKiosk

boolean

No

CreateDeliveryWhenPurchased

boolean

No

ImageFileName

string

No

Id

int

Yes

Read-only

UpdatedOn

timestamp

No

Read-only

CreatedOn

timestamp

No

Read-only

UniqueId

string

No

Read-only

SystemId

string

No

Related records

Property

Record type

BusinessId

Business

CurrencyId

Currency

TaxRateId

TaxRate

ReducedTaxRateId

TaxRate

ExemptTaxRateId

TaxRate

FinancialAccountId

FinancialAccount