Skip to main content

services/pricelists/{plid}/services/new (POST)

To create a new pricelist service in a pricelist.

URL

(POST) /api/services/pricelists/{plid}/services/new

PARAMETERS

URL parameters are:

plid

The price list ID

Integer, Mandatory

The body must include a JSON object with the properties below.

disabled

Boolean. true to disable and false to enable the service..

Default if not specified: false

bool, Optional

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, Mandatory

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, Mandatory

task

The service task code such as TR for translation or RV for revision. To discover all task types, see settings/tasks/codes

string, Mandatory

code

Optional product code.

string?, Optional

comments

Optional internal comments (never visible to external users or unauthorized internals).

string?, Optional

rating

Optional rating from 0 (not set) to 6 (best).

Default if not specified: 3

int, Optional

unit

The unit that will be costed. Such as WD (words) or CH (characters).

See this API to obtain a list of all units: Price units

string, Mandatory

unitsCount

Indicates the number of units (unit) that the service amount includes. In most cases this will be 1, but not in all: Examples: "20 cents per 1 word", "20 cents per 15 characters", etc.

Default if not specified: 1

int, Optional

amount

Optional service amount.

Services can be defined without an amount (null value).

Default if not specified: null

decimal?, Optional

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.

Default if not specified: 0 (no lead time)

int, Optional

unitsPerDay

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

Default if not specified: 0 (not specified)

int, Optional

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.

Default if not specified: No

string, Optional

discountModeType

A numeric value for the discount mode. This can be disregarded.

int?, Optional

discountPretrans100

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

decimal?, Optional

discountPretrans110

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

decimal?, Optional

discountPretransMT

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

decimal?, Optional

discountPretransFuzzy

Optional. 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?, Optional

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?, Optional

Backup service

backupServiceId

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

Default if not specified: null (no backup service)

int?, Optional

backupPriceListId

The price list of the backup service, see above. Must be specified if backupServiceId is set,

Default if not specified: null (no backup service)

int?, Optional

Custom fields

cfser

Optional.

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
"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

Default if not specified: null (no custom fields).

object[]?, Optional

AI Agent

aiAgent

Assigning an agent to the service means that the job created for this service will be carried out by an AI Agent.

Assigning an agent:

Example:

CODE
"aiAgent": {
    "id": "69020c5df4e5bac1a15dfd62",
    "p": {
        "prompt_translation": "Translation is for a medical expert audience"
    }
}
  • id: The AI Flow identifier. See (link to be added).

  • p: Optional dictionary of parameters. Each flow defines the parameters it accepts.

Removing an agent

Set either aiAgent or aiAgent.id to null

RESULTS

The method returns the updated service.

The properties are the same as described here: services/pricelists/{plid}/services/{svcid}

ACCESS RIGHTS

See Services.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.