Quotes

Quotes are always related to a translationTask. Each translationTask can have multiple quotes, which usually are from different translation vendors. It is also possible that one translation vendor sends more than one quote as he wants to offer alternative quotes. The customer can decide what quote should be accepted.

Endpoints

Method URI
GET /rest/api/quotes/{quote_id}
PATCH /rest/api/quotes/{quote_id}

Default Schema

{
  "connectorQuoteId": "5968807b1e6226cb73830c69",
  "connectorEnquiryId": "596880741e6226cb73830c65",
  "createdAt": "2017-07-14T08:27:41.842Z",
  "number": "541189",
  "price": {
    "netAmount": "198.66",
    "vatPercentage": "19",
    "currency": "EUR",
    "totalDiscountPercent": "1.5",
    "vatAmount": "37.75",
    "grossAmount": "236.41"
  },
  "state": "OFFERED",
  "tapQuoteEnquiryId": "QpZHeysEeDQ5gY7Df",
  "supplierName": "DEMO Vendor",
  "target": "nb-NO",
  "textAmount": {
    "type": "lines",
    "amount": 71,
    "discountedAmount": 70
  },
  "translationTaskId": "3xs8fFiBueQwFs9cN",
  "orderNumber": "DMY-10000091022",
  "id": "5968807d3e6b510001bb42fc"
}

Properties

quote

Property Writeable Value
id readonly The id that identifies the quote.
state The state of a quote. The state can be:
OFFERED
A quote in this state is the response of an LSP for a language of a translationTask
ACCEPTED
A quote in this state has been accepted and will be transmitted to the LSP.
REJECTED
A quote in this state was rejected. Either directly from the user or because another quote for the language was accepted by the user.
CANCELLED
A quote in this state has been cancelled by the user.
number readonly The unique number of the quote provided by the appropriate translation vendor.
price readonly This object includes all price properties regarding the quote.
See price
target readonly The target language of the quote.
textAmount readonly This object includes all text amount properties which are the basis for the price information of the quote.
See textAmount
createdAt readonly The date when the quote has been created. The date time will be provided as ISO 8601 date format.
orderNumber readonly The order number coming from the LSP. Only if the state of the quote is ACCEPTED
supplierName readonly The name of the translation vendor.
connectorQuoteId readonly The id of the quote in the LSP-vendor-connector (please see the LSP integration guide for further information)
connectorEnquiryId readonly The enquiry id in the LSP-vendor-connector.
tapQuoteEnquiryId readonly The id of the quote enquiry.
translationTaskId readonly The referred translationTask.

price

Property Writeable Value
netAmount readonly The net amount of the quote. The net amount has a maximum of 4 decimals.
vatPercentage readonly The vat percentage as number applied to the quote and provided by the translation vendor.
currency readonly The currency of the quote provided in ISO 4217 currency format.
totalDiscountPercent readonly The total discount applied to the quote in percent. Usually the discount is granted because of translation memory matches and repetitions.
vatAmount readonly The vat amount of the quote set and rounded from the translation vendor.
grossAmount readonly The gross amount of the quote. The gross amount has as well a maximum of 4 decimals.

textAmount

Property Writeable Value
type readonly Describes the unit in which the text amount is calculated and offered by the vendor.
amount readonly The complete text amount of all documents the quote refers to. The text amount is provided in the unit described in the type property.
discountedAmount readonly The discounted text amount. This is the amount which is used for the price calculation (amount after tm discount).

Description of Endpoints

GET  /rest/api/quotes/{quote_id}

Gets a quote by a it's id.

Example Request:

GET /rest/api/quotes/577135d30f627d65ba122ce8 HTTP/1.1

Example Response:

{
  "connectorQuoteId": "5968807b1e6226cb73830c69",
  "connectorEnquiryId": "596880741e6226cb73830c65",
  "createdAt": "2017-07-14T08:27:41.842Z",
  "number": "541189",
  "price": {
    "netAmount": "198.66",
    "vatPercentage": "19",
    "currency": "EUR",
    "totalDiscountPercent": "1.5",
    "vatAmount": "37.75",
    "grossAmount": "236.41"
  },
  "state": "ACCEPTED",
  "tapQuoteEnquiryId": "QpZHeysEeDQ5gY7Df",
  "supplierName": "24translate TEST",
  "target": "nb-NO",
  "textAmount": {
    "type": "lines",
    "amount": 71,
    "discountedAmount": 70
  },
  "translationTaskId": "3xs8fFiBueQwFs9cN",
  "id": "5968807d3e6b510001bb42fc"
}

PATCH  /rest/api/quotes/{quote_id}

Updates quotes of translationTasks.

A quote of an LSP can be accepted or rejected. Accepting one quote will reject the other quotes automatically. Furthermore an accepted quote can be cancelled (state: CANCELLED) if the translation documents for this quote were not delivered yet.

Example Request:

PATCH /rest/api/quotes/596880813e6b510001bb42fd HTTP/1.1

{
  "state": "ACCEPTED"
}

Example Response:

{
  "connectorQuoteId": "5968807f1e6226cb73830c6a",
  "connectorEnquiryId": "596880741e6226cb73830c66",
  "createdAt": "2017-07-14T08:27:45.241Z",
  "number": "541190",
  "price": {
    "netAmount": "89.46",
    "vatPercentage": "19",
    "currency": "EUR",
    "totalDiscountPercent": "1.5",
    "vatAmount": "17.00",
    "grossAmount": "106.46"
  },
  "state": "ACCEPTED",
  "tapQuoteEnquiryId": "cWMQ8Z2zcyZesjauu",
  "supplierName": "24translate TEST",
  "target": "es-MX",
  "textAmount": {
    "type": "lines",
    "amount": 71,
    "discountedAmount": 70
  },
  "translationTaskId": "3xs8fFiBueQwFs9cN",
  "id": "596880813e6b510001bb42fd"
}