services/pricelists/{plid}

plid

The price list ID

The price list ID

The name of the price list.

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!

Indicates if the price list is enabled or disabled. A disabled price list cannot be used for cost calculation.

Boolean. True if this is the default price list of the client, supplier or master company.

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.

Any reductions defined for pretranslations, fuzzy matches or repetitions.

See description further below.

Minimum prices. Used to set for example a minimum of Euro 50 for a batch of work.

See description further below.

Used with client price lists. The list of client company IDs to which the price list is assigned. Null if the price list is not a client price list.

See description further below.

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.

See description further below.

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.

Pretranslation discounts

Discounts applicable for pretranslations.

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%. 

Optional. Reduction for 110% (perfect) pretranslations.

If null then the discount is taken from pretranslations.reductionExact  

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

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

Optional. Reduction for machine translations. If null then the discount is taken from pretranslations.reductionExact

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.

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%.

All % intervals with the corresponding discount. Example:

"items": [
	{
		"min": 100,
		"max": 110,
		"reduction": 40.0
	},
	{
		"min": 75,
		"max": 99,
		"reduction": 10.0
	}
]

• min: The lower inclusive % range
• max: The upper inclusive % range
• reduction: The applicable reduction between 0 and 100 (a decimal)

An optional minimum amount for a batch of work.

The minimum is typically calculated when costing a batch of work and is reflected in the invoice.

For example, when assigning a job to a supplier, a minimum amount to invoice may apply for the work. In the same way, a minimum fee may be set for any work asked for by clients. 

Zero, one or more minima for specific language combinations. The language minima always take precedence over the global minimum.

This is a list of minima with these properties:

• src: The source language code. Null to indicate "Any language".
• trg: The target language code. Null to indicate "Any language". You cannot have a minimum with both src and trg set to null.
• srct: The source language title
• trgt: The target language title
• amount: The minimum amount (decimal).

When calculating the grand total for an invoice, the respective language minima will be applied to the sub-totals of the work items in these languages.

The default price list ID

If true then the price list inherits all the services from the default price list. Of course, it is possible to replace individual prices by simply explicitly adding services with the same languages, task code and product code. This effectively "hides" the inherited service and replaces it.

By default this option is ticked off in any newly created price list. In general you should be careful working with inheritance, it is great to create price lists with global discounts or different currencies but at the same time makes price management a little bit more difficult.

The list of client company IDs to which the price list is explicitly assigned.

Boolean:

• true: Price lists can be selected for a client only if explicitly assigned in array cids
• false: The price list can be used with ANY client whether it was explicitly assigned or not.

When false, the explicit assignment is then for informational purposes for the project manager.

Any client specific price lists should best be configured with hideIfNoClients equals true