Gets a price lists with all properties:
- Name, Code and Status
- Discounts
- Minimum prices
Content:
URL
(GET) /api/pricing/pricelists/{id}PARAMETERS
URL parameters are:
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 |
Reductions
The reductions object has these properties:
Pretranslation discounts Discounts applicable for pretranslations. | object | |
| pretranslations.reductionExact | Optional. The default reduction for any kind of 100% or 110% pretranslations. More specific reductions can be set to override, see below. Null means that no such reduction is set. The reduction is a decimal number between 0 and 100. For example, 20.50 means that the calculated price will be reduced by 20.50%. | decimal? |
| pretranslations.reductionExactCtx | Optional. Reduction for 110% (perfect) pretranslations. If null then the discount is taken from pretranslations.reductionExact | decimal? |
| pretranslations.reductionExactPrevCtx | Optional. Reduction for 110% (perfect) pretranslations from a previous document version. This applies when you upload a new version of a document and translations are carried over from the previous version while the context (segment before and after) is carried over as well. If null then the discount is taken from pretranslations.reductionExact | decimal? |
| pretranslations.reductionExactPrev | Optional. Reduction for 100% (perfect) pretranslations from a previous document version. This applies when you upload a new version of a document and translations are carried over from the previous version while the context (segment before and after) is not carried over. Also compare to reductionExactPrevCtx. If null then the discount is taken from pretranslations.reductionExact | decimal? |
| pretranslations.reductionExactMT | Optional. Reduction for machine translations. If null then the discount is taken from pretranslations.reductionExact | decimal? |
| pretranslations.reductionExactAnySpecial | Boolean that summarizes whether any of the specialised discounts reductionExactCtx, reductionExactPrevCtx, reductionExactPrev or reductionExactMT are set. | bool |
| pretranslations.reductionFuzzy | Optional. Reduction for <100% pre-translations. A word count profile allows to leverage translations for pre-translations even if they do not match exactly. We name this the fuzzy pretranslation threshold. | decimal? |
Fuzzy match & repetitions discounts Groups all discounts for fuzzy matches and repetitions WITHOUT pretranslation. The word count profile defines under which condition hits are leveraged with a translation or not. A typical case is when the similarity % is below a certain threshold such as 95%. | object | |
| fuzzymatches.any | Boolean indicating if there are any such discounts defined. | bool |
| fuzzymatches.any110 | Boolean indicating if there are any such discounts defined for 110% (perfect) fuzzy matches / repetitions without pretranslation | bool |
| fuzzymatches.items | All % intervals with the corresponding discount. Example: "items": [
{
"min": 100,
"max": 110,
"reduction": 40.0
},
{
"min": 75,
"max": 99,
"reduction": 10.0
}
]
|
Price minima
The minima object has these properties:
| global | object | |
| languages |
Default price list
The default property contains information of the parent price list. It is set if and only if the present price list is not the default price list of the company, i.e. isDefault is false.
The object has these properties:
| default.plid | The default price list ID | int |
| default.code | The default price list code. | string |
| currency | A three letter currency code such as EUR or USD. | string |
| currencyt | Title of currency such as "Euro" or "US dollars" | string |
| inheritServices | bool | |
| inheritReduction | decimal? | |
| conversionRate | decimal? | |
| conversionRateDate | datetime? |
EXAMPLES
The following example is for a manager user accessing a job which is proposed to him/her. As a manager, the user has management level actions as well.
{
"id": "c231",
"jobid": 231,
"iscodyt": true,
"status": 1,
"statust": "Not assigned",
"hasPredecessor": false,
"assignment": {
"mode": 0,
"modet": "Fixed assignment",
"cid": null,
"cname": null,
"uid": null,
"uname": null,
"wasAccepted": false
},
"readOnly": false,
"actions": [
{
"id": "OPENING_ACCEPT_INACTIVE",
"title": "Yes, I want to reserve this upcoming job!",
"desc": "This job is still inactive but you can already reserve it now. This will put your name on the job.",
"isinfo": false,
"isprimary": true,
"affectsRights": true,
"style": "Green",
"uicontrol": "Terms"
},
{
"id": "OPENING_DECLINE",
"title": "Unfortunately, I have to decline this proposal.",
"desc": "This will remove the job opening from your job list.",
"isinfo": false,
"isprimary": true,
"affectsRights": true,
"style": "Gray",
"uicontrol": "None"
},
{
"id": "ADMIN_STATUS_NOTASSIGNED",
"title": "Change status to 'Not assigned'",
"desc": null,
"isinfo": false,
"isprimary": false,
"affectsRights": true,
"style": "Default",
"uicontrol": "None"
},
{
"id": "ADMIN_STATUS_NOTSTARTED",
"title": "Change status to 'Not started'",
"desc": null,
"isinfo": false,
"isprimary": false,
"affectsRights": true,
"style": "Default",
"uicontrol": "None"
}
],
"uicontrols": {
"Terms": { "termsShow": true },
"None": null
},
}