...
- Name, Code and Status
- Discounts
- Minimum prices
Content:
| Table of Contents |
|---|
URL
(GET) /api/pricing/pricelists/{id}...
id | The price list ID | Integer, Mandatory |
RESULTS
...
Main properties
The price list properties are:
| plid | The price list ID | int |
| code | The price list code. The default price lists (generally) has an empty string. This field can be set by the user in the UI. | string |
| name | The name of the price list. | string |
| cid | The company which owns the price list, i.e. which provides the services in the price list.
In other words: A price lists is always owned by the company which provides the listed services. Passing a client company to the API URL will return price lists owned by the master company. Hence be careful to understand the difference between the cid passed in the URL and cid of a price list. It is not necessarily the same! | int |
| cname | The company name | string |
| enabled | Indicates if the price list is enabled or disabled. A disabled price list cannot be used for cost calculation. | bool |
| isDefault | Boolean. True if this is the default price list of the client, supplier or master company. | bool |
| isDraft | Indicates if the price list is a draft. Wordbee Translator proposes price list drafting workflows that involve the supplier company. Please check out the online user guides for how this works. | bool |
| isClientPricelist | Boolean. True if this is a client price list. False if it is a supplier price list. | bool |
| currency | A three letter currency code such as EUR or USD. | string |
| currencyt | Title of currency such as "Euro" or "US dollars" | string |
| comments | Internal comments. Not accessible to external users. Empty string if none. | string |
| contractno | Internal contract number assigned to this price list. This field is visible to internal users only. Empty string if none. | string |
| reductions | See description below. | object |
| minima | Minimum prices. Used to set for example a minimum of Euro 50 for a batch of work. See description below. | object |
| clients | Used with client price lists. The list of client company IDs to which the price list is assigned. Note that only price lists owned by the master company can be assigned to clients. Supplier price lists cannot. | int[]? |
| decimals | Number of decimals of price calculations. For example, you may want to show 2 decimals in invoices. Subtotals and totals will then be rounded accordingly. | int |
| default | If the present price list is not the default (see isDefault) then this object contains the complete default price list. Otherwise this property is null. | object? |
| rights | Access rights details. Specifies the exact actions permitted on the price list. This information is only relevant if you intend to build a UI to view and edit price lists. | object |
...