Versions Compared

Old Version 1

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 2

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

plid

The price list ID

Integer, Mandatory
svcidThe service IDInteger, Mandatory


RESULTS

The result is a JSON object:

...

The default price list for this company. It is one of the price lists listed below.

With My Company and suppliers, the default is the first item when sorted by code alphabetically.

...

The list of price lists with basic properties. See description below.

To get all properties use pricing/pricelists/{id}

...

Each element in items represents a price list:

...

The price list ID

...

The name of the price list.

...

service properties are:

id


string 
svcidThe unique service ID.int
plidThe unique price list ID.int
id

A unique identifier that concatenates price list ID and service ID. The format is:

  • C{price list ID}-{service ID} : For master, client or supplier company price list services
  • P{price list ID}-{service ID} : For services assigned to internal workers

This ID is redundant. We show it in Wordbee Translator for convenience for the user.


cid

The company which owns the price list , i.e. which provides the services in the price listto which this service is attached.

  • Internal and client price lists are always owned by the master company ("My company"): The master company provides the services to clients!
  • Supplier price lists are always owned by supplier companies. The supplier companies provide services to the master company ("My company") and which then resells services to its clients.

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
enabled

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

bool
isDefault

True if this is the default price list for the company in the API URL.

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
currencyA
int
pidIf the service is assigned to a specific person and not a company, then this is the person's unique ID.int?
inherited

True if this service is inherited from the parent price list or explicitly defined in the present price list.

Please check inheritance options in this API method: pricing/pricelists/{id}

bool
disabledBoolean. If true then this service is currently disabled.bool



src

The source language code of the service.

The special code "*" is a placeholder for any language: The service can be used for any source language.

To discover all languages see settings/languages

string
trg

The target language code of the service.

The special code "*" is a placeholder for any language: The service can be used for any source language.

string
srctThe source language titlestring
trgtThe target language titlestring
taskThe service task code such as TR for translation or RV for revision. To discover all task types, see settings/tasks/codesstring
tasktThe task print title, such as "Translation", "Revision", etc.string



codeAn optional product code. Empty string if no code.string
commentsOptional internal comments (never visible to external users or unauthorized internals)string?
ratingA user defined service rating from 0 (not set) to 6 (best).int
ratingManager

The average rating given by managers and over the past weeks. This information is automatically populated from the Wordbee business analytics tools and the rating features.

0 means no data available. 1 is the lowest and 6 the highest rating.

decimal



unitThe unit that will be costed. Such as WD (words) or CH (characters). See this API to obtain a list of all units: Price unitsstring
unittThe unit print title.string
unitsCount

Indicates the number of units (unit) that the service amount includes.

In most cases this will be 1, but not in all, see below:

Examples: "20 cents per 1 word", "20 cents per 15 characters", etc.

int
amountThe service amount. It can be null if no amount is specified.decimal?
amountt

A user friendly text with the service price. Null if amount is null.

For example:

  • "EUR 0.01 per Word"
  • "USD 0.2 per 50 Characters"
string?
currencyThe three letter currency code such as EUR or USD.string
currencytcurrencySymbolTitle of The currency symbol such as "Euro" or "US dollars"string
commentsInternal comments. Not accessible to external users. Empty string if none.string
contractnoInternal contract number assigned to this price list. This field is visible to internal users only. Empty string if none.string$.string




Deadline calculation
leadHours

Used for deadline calculation. Defines the number of hours upon transmission of a request until the time in hours the work typically starts.

0 if not set or no lead time.

int
unitsPerDay

Used for deadline calculation. Defines the number of units the service provider can do in a work day.

0 if not set or no lead time.

int




Discounts
discountMode

Defines how discounts are calculated for this specific service:

  • No : No discounts
  • PriceList : The discounts defined in the price list do apply
  • Custom : The service defines its own specific discounts

All the below properties apply to Custom mode only.

string
discountModeTypeA numeric value for the discount mode. This can be disregarded.int?
discountPretrans100

Optional. Discount for 100% pretranslations. A value between 0 and 100. Applicable only if mode is "Custom". 

decimal?
discountPretrans110Optional. Discount for 110% (perfect) pretranslations. A value between 0 and 100. Applicable only if mode is "Custom".decimal?
discountPretransMTOptional. Discount for machine translations. A value between 0 and 100. Applicable only if mode is "Custom".decimal?
discountPretransFuzzyOptional. Discount for fuzzy pretranslations, i.e. pretranslations at below 100% leveraging similarity. A value between 0 and 100. Applicable only if mode is "Custom".decimal?

discountMatch1
discountMatch2
...
discountMatch6

Optional. Discount for fuzzy (untranslated) matches or repetitions.

The respective fuzzy interval (1 to 6) must be defined in the price list.

decimal?




Backup service
backupServiceIdOptional service ID that shall be used by a manager if the present service is not available. Typically the backup service points to a price list of an alternative supplier.int?
backupPriceListIdThe price list of the backup service, see above.int?




Custom fields
cfser

An array with all the service level custom fields. The array elements each have these properties:

  • id: The custom field ID composed of the field domain (always 9) and the sequential number of the custom field
  • value: The value

Example:

Code Block
"cfser": [
	{
		"id": "9-1",
		"value": "Alpha"
	},
	{
		"id": "9-6",
		"value": "No"
	}
]


See this API to obtain a list of all defined custom fields: settings/customfields


object[]
cfser1, cfser2...

Same as the array above but with the custom fields printed as separate properties. This is redundant information.






Changes
changeUserIdThe user who created or last updated this service.int
changeDateDate of last change of this service.


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.

...