Create a product

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
namestringRequired>=1 character<=100 characters
Name of the product.
descriptionstringOptional<=2000 characters
Description of the product.
external_referencestringOptional>=1 character<=255 characters

A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.

ledger_account_idstringOptionalformat: "uuid"
measure_unit_idstringOptionalformat: "uuid"

The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).

priceobjectOptional
smallest_amountdoubleOptional>=0<=2147483647
The smallest amount allowed for this product.
typeenumOptional
Specifies whether this offering is a product or service. This may affect the applicable tax rates.
Allowed values:

Response

Successful Response
idstringformat: "uuid"
Unique ID of the product.
created_atdatetime
Time at which the product was created. Timestamps follow the ISO 8601 standard.
updated_atdatetime
Time at which the product was last updated. Timestamps follow the ISO 8601 standard.
entity_idstringformat: "uuid"
namestring
Name of the product.
descriptionstring or null
Description of the product.
entity_user_idstring or nullformat: "uuid"
external_referencestring or null>=1 character<=255 characters

A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.

ledger_account_idstring or nullformat: "uuid"
measure_unit_idstring or nullformat: "uuid"

The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).

priceobject or null
smallest_amountdouble or null>=0<=2147483647
The smallest amount allowed for this product.
typeenum or null
Specifies whether this offering is a product or service. This may affect the applicable tax rates.
Allowed values:

Errors