Versions Compared

Old Version 2

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Laura Campo

Saved on

Key

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

Use this method to update a client or a supplier pricelist.

URL

(POST) companies/{companyid}/pricelists?token={tokenid}&pricelist={pricelistid}&data={data}

PARAMETERS

token

The token obtained on connection

Required

companyid

The id of the supplier.company

Required

pricelist The id of the pricelist to update Required

data

A json containing the company information (see below)

Required

 


JSON format of "data" parameter

Only specify those fields that you want to update. 


PricelistCode

The name of the pricelist. The first pricelist created for a supplier will be defined as the "Standard pricelist" and be assigned an empty code.

Even you specify a name for the first created pricelist, it will be ignored.

Be careful: you can't add different pricelists with the same name for one supplier.

OptionalRequired
CommentsInternal comments.Optional
DecimalPlacesThe number of decimals to which invoice totals will be rounded. A commonly used value is 2.Optional
CurrencyCode

The pricelist currency according to the ISO-4217 standard. Examples: "USD" or "EUR".

.See https://fr.wikipedia.org/wiki/ISO_4217 for a complete list.

If not specified and a standard pricelist exists, the new pricelist takes the currency from the standard pricelist. If creating the standard pricelist and currency is not set, "EUR" (Euro) will be chosen.

It is recommended to always set this property.

Optional
ContractNumberThe contract number.Optional

ReductionPercent

Reduction between 0 and 100 applied to standard prices. This is a decimal number such as 10.5 for 10,5%

FuzzyReduction

Json array containing reductions to apply to fuzzy matches and repetitions.

Example:

Code Block
[ {
	"Percentage": 90, 
	"Reduction": 20.5
}, 
{ 
	"Percentage": 100, 
	"Reduction": 40 
},
 {
    "Percentage": 110, 
	"Reduction": 80 
}]

The json above specifies a reduction of 80% for in-context matches (110%), a reduction of 40% for identicals (100%) and a reduction of 20,5% for matches in the range of 90% up to 99%.


The maximum allowed number of ranges is 6.		Optional

DoNotInherit

False if the new pricelist inherits services from the standard price list. See the Wordbee pricelist user interface for more details.

By default the value is false.		Optional

ApplySameOnPretrans

If true then Apply same discounts as specified with “FuzzyReductions” for pre-translations.

Otherwise, specify custom discounts using the properties below.		Optional
ReductionPretransExact

General discount applied to pre-translations from translation memories, previous file versions or machine translation.

If not set, the discounts for 100% and 110% specified in “FuzzyReductions” is used.

With the following fields you can further and optionally assign custom discounts for various types of pre-translation. 		Optional

ReductionPretransExactCtx

Discount for 110% (in-context) pre-translation from translation memories. If not set, the discount of “ReductionPretransExact” is used.Optional

ReductionPretransExactPrevCtx

Discount for 110% (in-context) pre-translation from previous file versions. If not set, the discount of “ReductionPretransExact” is used.Optional

ReductionPretransExactPrev

Discount for 100% pre-translation from previous file version. If not set, the discount of “ReductionPretransExact” is used.Optional

ReductionPretransExactMT

Discount for pre-translation by machine (MT). If not set, the discount of “ReductionPretransExact” is used.Optional

ReductionPretransFuzzy

Discount for fuzzy pre-translations, i.e. for leveraging memory matches below 100%.

If not set, the respective discounts ranges below 100% specified in “FuzzyReductions” are used.		Optional

Conversion

A currency conversion factor. Should be supplied if the pricelist currency differs from the default pricelist (of the same company).

Example:

If you default client pricelist uses Euros and you then add a USD client pricelist, you should specify a conversion rate like in: 1 EURO = (rate) * 1 USD


Conversion: { “Rate”: 1.223, “Date”: “2013-05-31T11:20:00“ }		Optional
MinAmountThe minimum charge printed in a single invoice or quote. When creating quotes or invoices, the system will print this amount if the actual total amount of the work is smaller.Optional


JSON format of field "Conversion"

...


RateA decimal. One unit in the standard pricelist currency equals this amount in the currency of the new pricelist.Required
DateAn optional date for the rate.Optional

...