They are answered by the XTRF community and our experts


Any experience with linking to PEPPOL?

Lorenzo L 3 years ago in API 0

Hello everyone,

Do you have experience with connecting your XTRF to PEPPOL for e-invoicing? If so, would you mind sharing some insight on how you were able to make this work? It would help us a tremendous amount.

Kind regards,



How to execute the Macro API parameterized?

Dennis Rosenbaum 3 years ago in API updated 3 years ago 4

Hi everyone,

I just found out that there is the possibility to execute the Macro API with parameters. This would be great as I currently use a sketchy workaround.

My API documentation doesn't say anything about the parameters, and this is what I have found in one of the XTRF documents:

Parameterized Macros Available via API calls
Why? HP REST API didn't officially support executing XTRF Macros. Macros didn't support additional parameters
that could modify their behavior. Support for macro parameters has been added.
What? API call POST /macros/{macroId}/run enables executing a macro operation with parameters.
Where? Home Portal API.
Reference: DEV-7597

Did someone get this to work already? Or can XTRF tell me what needs to be done in order to get the parameters to get over to the macro?

Kind regards,
Dennis Rosenbaum


Newbie API question.

Karl 3 years ago in API updated 3 years ago 2

My company is doing a deep dive evaluation on moving to XTRF and trying to kick the tires a bit on the API.
We've attempted posting this question though the "preferred" Stack Overflow channel, but not getting any feedback (and doesn't appear to be getting much traffic), and frankly we don't have a ton of time for waiting too long.
Here's a question one of my devs has posted on SO
 and we'd like to determine best course of debugging such matters.

thanks in advance for any help on this matter.


How do you add payables/receivables to a Smart Project using the Home Portal API?

Mike MacKechnie 3 years ago in API 0

We have a working API  to create Smart Projects, but we would like to add a payable (interpreter cost) and a receivable (client charge) to the Finance section.

We have been told in a previous XTRF ticket that this is possible, but I can't find any documentation. 

Does anyone know how to do this? Or point me at the documentation?


Enable XTRF chat through the API

Dennis Rosenbaum 4 years ago in API updated by Bogusław Reich (XTRF Product Owner) 3 years ago 3

We have seen the new Chat functionality which pleases us a lot, and I think everyone here is pleased as well as it is a long awaited feature.

There is a problem though, the only way to enable the chat is through the Home Portal. It is also not possible to enable the chat later on, when the project is already created. This seems like a strange design choice as we live in an API first and modular software world.

We create loads of projects through the API and are therefore unable to enjoy the chat.

I have asked this question on the XTRF Help Center as well, this is their response: 'we are considering such an option in the future version of the chat but at the moment I'm not able to provide any details on when this would be implemented.'

So I would like to know if more of the XTRF users are in need of a way to enable the chat through the API. Please let me know and maybe the development of this feature can be speed up.


Hi Dennis. Following the feedback we received also from other Chat users, we will open this feature soon to all Projects and Quotes, regardless of their origin. This is expected in the next minor version already (i.e. by the end of this year). As a result, chat will be available also in projects/quotes created via API, Client Portal, QRF or custom connectors.

As a side note, since the feature has been designed in a way that it automatically invites vendors to chat rooms and workspaces, we thought that it may be a good idea to give the PMs more "manual" control over it. Hence the idea of "use XTRF chat" checkbox. Currently, however, we don't see it as necessary anymore. If a given LSP or client of ours decides to use our Chat, they usually want it enabled for all projects - and this is the direction we'll take.


How to set up custom field filtering in subscription API

Thijs Senten 4 years ago in API updated 4 years ago 2

I'm reading up on the subscription API and see that it is possible to filter events on custom fields. I seem to be missing part of the picture though, especially with regard to the job_status_changed event. 

How can you automatically set up a custom field with a specific value for filtering on job level? 

- I don't think it's possible to do this in the workflow definitions (for Classic Projects). 

- Setting a default value for a custom field would also make no sense, because they would all be the same and useless for filtering. 

- Setting it manually rather defeats the purpose and is not really error-proof.

- Using a macro + periodic job makes it time-based and therefore also not error-proof.

- Using a project_created event to trigger setting the custom field maybe? That would limit the number of events from 'every job status change' to 'every new project created', so significantly fewer, but it still doesn't feel like a clean solution.

Is there anyone with experience in this who can explain it to me? 


Send Job Offer automatically

Dennis Rosenbaum 4 years ago in API updated by Robrecht Belien 4 years ago 4

Hi all,

I would like to automatically send out a Job Offer (Smart Project). The API doesn't seem to have this functionality. I am currently searching the JavaDoc for anything that let's me execute this job offer through a macro, but I haven't found it yet. 

Maybe one of you have automated this proces?

The exact functionality that I need is that I can create a Job offer automatically where I assign an activity/job and a rule (provider selection rule?). This is the current manual step that I take:

Image 1404


Convert Smart Quote to Smart Project through API/macro

Dennis Rosenbaum 4 years ago in API updated by mark 4 years ago 2

I would like to use the API (or macro) to convert a quote to a project.

Is there anyone that already done something like this?


trying to run a view of Jobs with deadlines in Classic Projects via the API

Mike MacKechnie 4 years ago in API updated 3 years ago 4

I have set up a view of Translation Jobs for a particular client, showing the deadline for each job. Creating the view on the Portal was easy, but I want to run it via the API so I can use the output to synchronise with another system.

How do I filter the job type?

I have tried ######/home-api/browser/?viewId=9325&&q.activityType:anyOf(1)

The internal ID of the Translation Job Type is 1, where as pre-Delivery is 69, but no matter what I code in the q.activityType:anyOf, the API always seems to deliver the pre-Delivery  jobs!

Am I using the wrong filter? Any help much appreciated. 


Smart Quote API fails with Can not deserialize instance of eu.xtrf.api.v2.dto.quote.QuoteCreateDTO

Mike MacKechnie 4 years ago in API updated by Bogusław Reich (XTRF Product Owner) 4 years ago 5

The full message is 

Can not deserialize instance of eu.xtrf.api.v2.dto.quote.QuoteCreateDTO out of START_ARRAY token
at [Source: org.glassfish.jersey.message.internal.EntityInputStream@2567c2c6; line: 1, column: 1]


The body is [
"clientId": 3315,
"name": "Test Smart Quote",
"serviceId": 115,
"opportunityOfferId": ""


Remove square brackets at the begining and at the end of the body. Your request should look like:

"clientId": 3315,
"name": "Test Smart Quote",
"serviceId": 115,
"opportunityOfferId": ""