Costing / Flex

What value would have an API like Flex if it is agnostic about prices and costs? If you are an LSP and you expose the API to your clients, then you definitely will want to configure prices for each client, for each language and (maybe) for each project. All this is configured inside Wordbee Translator and then available via Flex immediately.

1 How to get cost when pushing content
2 How to preview cost prior to pushing
3 Obtain configured unit prices and discounts
4 Prerequisites
5 Access rights

How to get cost when pushing content

Check the optional URL parameter includeCost. When set to true, the result includes the cost of the push.

documents/{id}/contents/push

To configure and activate client costing please see the Prerequisites chapter below.

How to preview cost prior to pushing

Check the optional URL parameter includeCost. When set to true, the result includes the cost of the push. This matches the amount in the created client invoice document:

documents/{id}/contents/push/preview

The API caller can then see the cost and decide to proceed with pushing the content.

To configure and activate client costing please see the Prerequisites chapter below.

Obtain configured unit prices and discounts

Show applicable unit prices and discounts to a client (via API). A client definitely will want to see this information.

See documents/{id}/pricing (GET)

Prerequisites

For the above API methods and features to work properly, please verify the correct setup:

Make sure that the Wordbee Translator project containing the Flex document is assigned to the correct client.
Enable Flex client costing in the project’s workflow profile (navigate to the “Flex” tab). Define the type of services to cost, such as Translation, Translation + Revision etc.
Configure the services, unit prices and any discounts in the price list assigned to the client. Add any missing services.
Verify that the user is given API 2 access, from Settings > API 2.
Make sure that the user has access right R401 is enabled in the assigned user profile.

Note that any internal manager-level API 2 user can also use any of the above features. This may also be useful for testing purposes.

Access rights

The following user profiles can obtain cost information:

A user of the project client. The user must have access right R401 enabled (gives access to all orders/data within the client).
An internal manager level user.

Any other users will not be able to see cost information.