Versions Compared

Key

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

...

plid

The price list ID

int 
codeThe 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.

  • 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
cnameThe company namestring
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
isClientPricelistBoolean. True if this is a client price list. False if it is a supplier price list.bool
currencyA three letter currency code such as EUR or USD. See also: settings/currencies/codesstring
currencytTitle of currency 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
decimalsNumber of decimals of price calculations. For example, you may want to show 2 decimals in invoices. Subtotals and totals will then be rounded accordingly.



reductions

Any reductions defined for pretranslations, fuzzy matches or repetitions.

See description further below.

object
minima

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

See description further below.

object
clients

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.

object?
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.

See description further below.


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

...