Products
Product is the goods sold or services provided to a customer.
Data Model
| Field | Type | Description | Example data |
|---|---|---|---|
| id | string | Unique identifier for each product. | 409364895 |
| metaId | string | Another identifier of this product or the id in its origin data source (when it comes from an integration). | prod_3402 |
| creationDate | string | Date of product creation (Date of creation of this products on its origin data source, for example). | 2022-02-02T14:13:53.644Z |
| code | number | Unique code identifies the product (rather than using the random id field generated for each entry in our database). | 345KL |
| parentId | string | If multiple records represent the same product (coming from different data sources, for example), you can choose one product to represent all of them and call it a parent; then assign this Id as parentId to the other products. | 62541 |
| name | string | Product name in the accounting platform. | Product X |
| description | string | The product’s description. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. | $360/Year subscription |
| price | number | Product price. | 350 |
| groupId | string | Id of group on which this product belongs to. | 4587 |
| metaGroupId | string | Id of product's group in its origin data source (when it comes from an integration). | gp_236 |
| unit | string | Product definition is a label that represents units of this product. | Website |
| accountId | string | Financial account Id of this product. | 19802367 |
| taxId | string | Id of product's tax. | 6 |
| metaTaxId | string | Id of product's tax in its origin data source (when it comes from an integration). | vat_6030 |
| billingPeriod | string | Billing period. Options: “month”, “year”. | month |
| billingFrequency | number | Billing frequency. | 1 |
| currencyId | string | Currency Id of this product's price. | 3168 |
| metaCurrencyId | string | Currency Id of this product's price in its origin data source (when it comes from an integration). | EUR |
| setupFee | number | Product setup fee. | 75 |
| archived | boolean | Indicates whether this product is archived or not. | false (not archived) true (archived) |
| isNew | boolean | Indicates whether this product is new or not. | false (not new) true (new) |
| tiers | JSON | Different pricing packages based on how many units the user will order. | {"tiers": [{"amount": 5600,"start": 1,"up_to": 1},{"amount": 1900,"start": 2,"up_to": -1}]}, |
| dataSourceId | string | Id of the data source (Manual Calqulate, or integrations). | 4779 |
| orgId | string | Organization Id in which this product belongs. | 718987154 |
| createdAt | string | Date of creation of this entry in Calqulate's Database. | 2022-02-02T14:13:53.644Z |
| updatedAt | string | Date of last update done on this entry in Calqulate's Database. | 2022-02-02T14:13:53.644Z |
| deletedAt | string | Date of deletion of this entry from Calqulate's Database. | 2022-02-02T14:13:53.644Z |
Updated over 1 year ago
What’s Next
The links below take you to further information within Calqulate library's Guides and API Reference.