Skip to main content
Products are goods or services that a company offers to its customers. They can be used on Invoices and Contracts.

​
The Product Object

​
id
string<uuid>

Unique identifier for the object

​
companyId
string<uuid>

ID of the company

​
name
string

Name of the product

​
pricingType
enum<string>

Pricing type of the product

  • FIXED - The product has a single price per unit
  • PACKAGE - The product is sold in packages with a fixed quantity
Available options:
FIXED,
PACKAGE
​
billingRecurrence
enum<string>

Billing frequency for the product. Used in contracts

  • ONE_TIME - The product is billed once
  • MONTHLY - The product is billed every month
  • QUARTERLY - The product is billed every three months
  • HALF_YEARLY - The product is billed every six months
  • YEARLY - The product is billed every year
Available options:
ONE_TIME,
MONTHLY,
QUARTERLY,
HALF_YEARLY,
YEARLY
​
pricings
object[]

List of product price per currency

​
state
enum<string>

Product state

  • ACTIVE - The product is active and can be used in invoices and contracts
  • ARCHIVED - The product is archived and cannot be used in new invoices or contracts
Available options:
ACTIVE,
ARCHIVED
​
defaultTaxId
string<uuid> | null

ID of the default tax code for this product. Will be assigned to invoice lines when creating a line with this product

​
defaultAvataxCode
string | null

Default Avalara tax code. Used when the invoice tax engine is AVATAX. Will be assigned to invoice lines when creating a line with this product

​
defaultLedgerAccountId
string<uuid> | null

ID of the default ledger account for this product. Will be assigned to invoice lines when creating a line with this product

​
externalSource
object | null

The external system where this product was synced from

​
createdAt
string<date-time>

Timestamp when the product was created

​
updatedAt
string<date-time>

Timestamp when the product was last updated

​
customProperties
object[] | null

List of custom properties associated with the product