Operations overview


Method Path Summary
GET /quotes/tasks/{quoteTaskId} Returns details of quote task represented by given id.
GET /quotes/tasks/{quoteTaskId}/files Returns input and output files (including subdirectories) for task with given id.
PUT /quotes/{quoteId}/acceptance Accepts given quote.
DELETE /quotes/{quoteId}/acceptance Rejects given quote.
GET /quotes/{quoteId}/confirmation Serves Project Confirmation document in PDF.
GET /quotes/{quoteId}/tasks Returns list of tasks from quote with given id.
GET /quotes/{quoteId}/tasks/count Returns number of tasks in quote with given id.
GET /quotes/{quoteId}/files Returns all files from quote with given id.
PUT /quotes/{quoteId}/office Changes office for quote with given id.
GET /quotes Returns a list of quotes.
POST /quotes Creates quote or requests project with language combinations and tasks according to given request.
GET /quotes/{quoteId} Returns quote info for quote with given id.
PUT /quotes/{quoteId} Updates quote with given id.
POST /quotes/{quoteId} Performs specific action on given quote.
GET /quotes/count Returns number of quotes with specified status.
GET /quotes/files/{fileId}/zipContent Returns tree of files and directories contained in this zip file.
GET /quotes/files/{fileId} Downloads workflow job file with given id.
GET /alternating-quotes Returns a list of alternating quotes.
GET /alternating-quotes/count Returns number of quotes with specified status.
GET /alternating-quotes/{quoteId} Returns alternating quotes details for given id of alternating quotes group.
DELETE /alternating-quotes/{quoteId}/acceptance Rejects all quotes from given alternating quotes group.

Operations details

GET /quotes/tasks/{quoteTaskId}

Returns details of quote task represented by given id.

Parameters
quoteTaskId
path
long

GET /quotes/tasks/{quoteTaskId}/files

Returns input and output files (including subdirectories) for task with given id.

Parameters
quoteTaskId
path
long

PUT /quotes/{quoteId}/acceptance

Accepts given quote.

Parameters
quoteId
path
long

DELETE /quotes/{quoteId}/acceptance

Rejects given quote.

Parameters
quoteId
path
long

GET /quotes/{quoteId}/confirmation

Serves Project Confirmation document in PDF.

Parameters
quoteId
path
long id of a quote
inline
query
boolean determines whether to serve file inline (by browser plugin) or as attachment (download prompt)

GET /quotes/{quoteId}/tasks

Returns list of tasks from quote with given id.

Parameters
quoteId
path
long id of a quote
start
query
int offset of the first retrieved task
limit
query
int maximum number of tasks to be returned, at most 50

GET /quotes/{quoteId}/tasks/count

Returns number of tasks in quote with given id.

Parameters
quoteId
path
long id of a quote

GET /quotes/{quoteId}/files

Returns all files from quote with given id.

Parameters
quoteId
path
long id of a quote

PUT /quotes/{quoteId}/office

Changes office for quote with given id. A new price profile (from the new office) should be specified and will be applied to the quote. Usually you should also recalculate rates during such change. When quote is associated with an opportunity then office will also be changed for all alternating quotes in that opportunity.

Parameters
quoteId
path
long
body
body
ChangeOfficeDTO

GET /quotes

Returns a list of quotes.

Parameters
status
query
List[com.radzisz.xtrf.model.quote.QuoteStatus] restircts result to quotes with given status (REQUESTED, PENDING, SENT, ACCEPTED, ACCEPTED_BY_CUSTOMER, REJECTED or SPLITTED), multiple values allowed (e.g. status=REQUESTED&status=WAITING_FOR_APPROVAL)
start
query
int offset of the first retrieved quote
limit
query
int maximum number of quotes to be returned, at most 50
search
query
string restricts result to quotes with at least one of properties(idNumber, refNumber, name, contact person) containing given string
createdOnFrom
query
long restricts result to quotes with createdOn equal or later than given. Miliseconds UTC
createdOnTo
query
long restricts result to quotes with createdOn equal or earlier than given. Miliseconds UTC
expirationDateFrom
query
long restricts result to quotes with expirationDate equal or later than given. Miliseconds UTC
expirationDateTo
query
long restricts result to quotes with expirationOn equal or earlier than given. Miliseconds UTC

POST /quotes

Creates quote or requests project with language combinations and tasks according to given request. Available workflows, specializations and languages can be retrieved via /system/values/workflows, /system/values/specializations, /system/values/languages. Specifying priceProfile is optional when currently logged in client has only one price profile. Otherwise you can obtain list of price profiles under path /customers/{customerId}/sales/priceProfiles First contact person from persons list will be set as main contact person of a quote. The second will be set as Send Back contact person. Other persons will be treated as Additional Contacts. Possible contact persons are available under /customers/{customerId}/persons. Files can be attached by sending them to /system/session/files. They will receive ids which you can put in files or referenceFiles list. As a result you will receive an object representing created quote if everything is correct. Otherwise you will receive a response with error code. Reason of the error will be present in header X-Error-Message.

Parameters
body
body
quoteRequest

GET /quotes/{quoteId}

Returns quote info for quote with given id.

Parameters
quoteId
path
long

PUT /quotes/{quoteId}

Updates quote with given id. Accepts quote in the same format as returned by GET /quotes/{quoteId}. Currently only name and refNumber are being updated.

Parameters
quoteId
path
long
body
body
quote

POST /quotes/{quoteId}

Performs specific action on given quote.

Parameters
quoteId
path
long
action
form
eu.xtrf.api.rest.api.quote.QuoteAction

GET /quotes/count

Returns number of quotes with specified status.

Parameters
status
query
List[com.radzisz.xtrf.model.quote.QuoteStatus] restircts result to quotes with given status (REQUESTED, PENDING, SENT, ACCEPTED, ACCEPTED_BY_CUSTOMER, REJECTED or SPLITTED), multiple values allowed (e.g. status=REQUESTED&status=WAITING_FOR_APPROVAL)
search
query
string restricts result to quotes with at least one of properties(idNumber, refNumber, name) containing given string
createdOnFrom
query
long restricts result to quotes with createdOn equal or later than given. Miliseconds UTC
createdOnTo
query
long restricts result to quotes with createdOn equal or earlier than given. Miliseconds UTC
expirationDateFrom
query
long restricts result to quotes with expirationDate equal or later than given. Miliseconds UTC
expirationDateTo
query
long restricts result to quotes with expirationOn equal or earlier than given. Miliseconds UTC

GET /quotes/files/{fileId}/zipContent

Returns tree of files and directories contained in this zip file. The response contains one directory with: the name of the zip file, directories contained in this zip file, recursively, files contained in this zip file.

Parameters
fileId
path
long

GET /quotes/files/{fileId}

Downloads workflow job file with given id.

Parameters
fileId
path
string

GET /alternating-quotes

Returns a list of alternating quotes.

Parameters
status
query
List[com.radzisz.xtrf.model.quote.QuoteStatus] restircts result to quotes with given status (REQUESTED, PENDING, SENT, ACCEPTED, ACCEPTED_BY_CUSTOMER, REJECTED or SPLITTED), multiple values allowed (e.g. status=REQUESTED&status=PENDING)
start
query
int offset of the first retrieved group of alternating quotes
limit
query
int maximum number of alternating quotes groups to be returned
search
query
string restricts result to quotes with at least one of properties(idNumber, refNumber, name, contact person) containing given string
createdOnFrom
query
long restricts result to quotes with createdOn equal or later than given. Miliseconds UTC
createdOnTo
query
long restricts result to quotes with createdOn equal or earlier than given. Miliseconds UTC
expirationDateFrom
query
long restricts result to quotes with expirationDate equal or later than given. Miliseconds UTC
expirationDateTo
query
long restricts result to quotes with expirationOn equal or earlier than given. Miliseconds UTC

GET /alternating-quotes/count

Returns number of quotes with specified status.

Parameters
status
query
List[com.radzisz.xtrf.model.quote.QuoteStatus] restircts result to quotes with given status (REQUESTED, PENDING, SENT, ACCEPTED, ACCEPTED_BY_CUSTOMER, REJECTED or SPLITTED), multiple values allowed (e.g. status=REQUESTED&status=PENDING)
search
query
string restricts result to quotes with at least one of properties(idNumber, refNumber, name) containing given string
createdOnFrom
query
long restricts result to quotes with createdOn equal or later than given. Miliseconds UTC
createdOnTo
query
long restricts result to quotes with createdOn equal or earlier than given. Miliseconds UTC
expirationDateFrom
query
long restricts result to quotes with expirationDate equal or later than given. Miliseconds UTC
expirationDateTo
query
long restricts result to quotes with expirationOn equal or earlier than given. Miliseconds UTC

GET /alternating-quotes/{quoteId}

Returns alternating quotes details for given id of alternating quotes group.

Parameters
quoteId
path
long One of alternating quotes id

DELETE /alternating-quotes/{quoteId}/acceptance

Rejects all quotes from given alternating quotes group.

Parameters
quoteId
path
long One of alternating quotes id


Data Types

BigDecimal

Name Type Description
scale int -
precision int -

ChangeOfficeDTO

Name Type Description
recalculateRates boolean -
priceProfile priceProfile -
office OfficeDTO -

CustomFieldDTO

Name Type Description
key string -
value string -
name string -
availableForCustomerPortal boolean -

OfficeDTO

Name Type Description
name string -

contact

Name Type Description
smsEnabled boolean -
www string -
socialMediaContacts Array[socialMediaContact] -
mobile string -
email string -
fax string -
phones Array[string] -

file

Name Type Description
url string -
size long -
delete_url string -
name string -
delete_type string -
fileStats fileStats -
id int -

fileStats

Name Type Description
words long -
charactersWithoutSpaces long -
lines long -
charactersWithSpaces long -
pages long -

language

Name Type Description
displayName string -
name string -
symbol string -
id long -

languageCombination

Name Type Description
sourceLanguage language -
targetLanguage language -
hasAssociatedTask boolean -

moneyAmount

Name Type Description
currency string -
amount BigDecimal -
formattedAmount string -

person

Name Type Description
position string -
name string -
email string -
id long -
version int -

priceProfile

Name Type Description
defaultContactPerson person -
name string -
id long -

quote

Name Type Description
refNumber string -
projectManager user -
customerNotes string -
startDate Date -
languageCombinations Array[languageCombination] -
totalAgreed moneyAmount -
hasInputResources boolean -
expiryDate Date -
budgetCode string -
hasInputWorkfiles boolean -
name string -
specialization string -
quoteConfirmationAvailable boolean -
tmSavings moneyAmount -
idNumber string -
salesPerson user -
service string -
estimatedDeliveryDate Date -
status string -
deadline Date -
isQuote boolean -
autoAccept boolean -
workflow string -
office OfficeDTO -
accepter xtrfUser -
id long -

quoteRequest

Name Type Description
customerProjectNumber string -
sourceLanguage language -
targetLanguages Array[language] -
sendBackTo person -
referenceFiles Array[file] -
budgetCode string -
persons Array[person] -
priceProfile priceProfile -
files Array[file] -
customFields Array[CustomFieldDTO] -
additionalPersons Array[person] -
name string -
specialization specialization -
deliveryDate Date -
service workflow -
notes string -
workflow workflow -
autoAccept boolean -
office OfficeDTO -
person person -

socialMedia

Name Type Description
addressSuffix string -
addressPrefix string -
name string -
id long -

socialMediaContact

Name Type Description
contact string -
socialMedia socialMedia -
id long -

specialization

Name Type Description
localizedName string -
name string -
id long -

user

Name Type Description
lastName string -
contact contact -
type string -
position string -
name string -
id long -
firstName string -

workflow

Name Type Description
localizedName string -
name string -
id long -

xtrfUser

Name Type Description
type string -
position string -
name string -
id long -