They are answered by the XTRF community and our experts


Vendor Portal API

Sancho Leath 11 months ago in API • updated by Jussi Rautio 11 months ago 2

Question for all you API users. Based on API commands are not yet available for the Vendor Portal. Have you found any workarounds (scripted jobs, etc.) to pull data from the Vendor Portal?

Example: We would like to access the memoQ Handoff Package in the Home Portal. Currently it is only available on the Vendor Portal. Until XTRF makes that data package available in HP, we would have to use some automated workaround to give our PMs a break.

This is the end game we have in mind:

Create a Scripted Job in XTRF with the following actions as each T or R1 job is started:

- download and copy memoQ Handoff package from VP to corresponding HP project

- unzip this package and add contents of ProjectTM and ProjectTB subfolders to the started job as Reference Files

This way, we can finally have a workaround for all those vendors who do not use memoQ and rely on Project TM (.tmx) and TB (.csv) as additional reference material for the job. To make it more sophisticated the Scripted Job can be conditional based on the CAT tool entry in the vendor profile.


Please share an experience of the use of API

Svitlana (Proftranslation LSP) 1 year ago in API • updated by Dennis Rosenbaum 1 year ago 20

Anyone use the access to API?
If so, could you please share an experience? For what purpose, what have you achieved with it, etc.?


API Connection Advise

Michal Shinitzky 1 year ago in API 0


We are trying to establish a connection to XTRF's API.

We have tried first with the DEMO portal: but for some reason we get an error that we have no idea what causes it.

When we reach stage 3B - we got the following error:

"An error occurred while sending quote. Please check if API is online and if all files are not null." Can you advice what are we doing wrong?

I'll be also happy if someone, with experience with XTRF API connection can contact us to help us with establishing the first few steps.



Sending commands through the API

Dennis Rosenbaum 1 year ago in API 0


I would like to know whether it is possible to execute Commands so that I can edit SMART projects the same way the XTRF code base does.

The javadocs don't cover all the Commands, neither does the API. As I do understand it would be a lot of work to make all the Commands available as a specific implementation. But it would be of real great use to execute a Generic Command.
Maybe for a command like this:


Executing the command as an API call like so: {apiUrl}/commands/{command-name}?arg[0]={argument0}&arg[1]={argument1}
So for this specific example: {apiUrl}/commands/MarkQuoteAsSentCommand?arg[0]=INIBY7QGPJBJLPF5MFJXRRKHCA

This way you don't need to provide full documentation nor creating a whole new interface layer for all commands. We could just look up the commands within the logs and execute them in this generic way.

Kind regards,

Dennis Rosenbaum


API or Library(C#) avilable to integrate CRM with XTRF

Avinash 1 year ago in API • updated by Dennis Rosenbaum 12 months ago 2

Hello ,I want to integrate my CRM with XTRF using API or Library so is this possible? if Pssoible then tell me api or Library name for intrgration 


Is it possible to update client invoice payment dat via API?

Robrecht Belien 5 months ago in API • updated by Tomas Buchta 4 months ago 3

Hi I can't find any function in the API docs to add client invoice payments. But Xtrf and Quickbooks have an integration so it should be possible via code. Having this functionality would be great for us.


XTRF 8 allows for parametrized macros via API. That is the only known way to add clients payments.

The integration with QuickBooks is a hard-coded one that bypasses the API.


How to get job id of existing job in XTRF smart project

WK Automotive 5 months ago in API • updated by Łukasz Kaleta (XTRF Product Manager) 5 months ago 5

I would like to update the status of existing jobs in XTRF smart projects using the XTRF Home Portal API.

The API call requires a job ID, but I don't where to find this ID.

End point: .../v2/jobs/{jobId}/status

Following the solution of a similar question on stackoverflow, I have defined a view with a list of jobs that require updating. However, there seems to be no column that holds the {jobId} that is required for the API. There is a column called "Internal ID" that contains a 4-digit number (in my case). But when I use that number in the API call, there's an error:

"Invalid Job ID of a Smart Job. Use new form of Job ID for Smart Jobs (e.g. 2QROVSCO3ZG3NM6KAZZBXH5HMI)."

So apparently, there is a new form for the job ID. Is there a specific column for the view that I should use, or is there another way to retrieve this job ID?


Subscription API - callback

Eric Kruis 6 months ago in API • updated by Łukasz Kaleta (XTRF Product Manager) 6 months ago 6

We are implementing the Subscription API. From documentation we see that "Subscriptions are automatically removed if they do not work".

I can imagine that our custom application we are developing will not always available (ie planned maintenance, lost internet connection).

How can we see which subscription status changes are missed? Is there a log table in XTRF? Or is there a queue, where we can 'refire' the missed call from XTRF?


Issues with API since the upgrade

Michal Shinitzky 6 months ago in API 0


This question is for all those API developers:

Since the upgrade some function in our API code aren't working as they were:

1. Attach a file to a project/quote request.

2. New potential client - when we create a new potential client and then send the quote, we get a 403 error. Any idea why is this happening?

thank you in advance!


Searching answer

BIRT Eclipse report templates: how to add EU VAT number

Stan 6 months ago in API • updated by Peter Kolar 5 months ago 5


The dynamic fields corresponding to EU VAT disappeared in the new XTRF templates. While I can see a field with our company EU VAT –

(xtrfContext.getRootObject().getCustomer().getBranch().getCountrySpecificFiscalCodeValue() != "" ? reportContext.getMessage("pdf.eu_vat", reportContext.getLocale()) + " " + xtrfContext.getRootObject().getCustomer().getBranch().getCountrySpecificFiscalCodeValue() : "")

 – I would like to know there the XTRF BIRT expressions are stored. XTRF Knowledge base here at UserEcho seems not to cover this important issue.