xtrf-home-portal-api

name	xtrf-home-portal-api
description	XTRF Home Portal API skill. Use when working with XTRF Home Portal for browser, accounting, customers. Covers 341 endpoints.
version	1.0.0
generator	lapsh

XTRF Home Portal API

API version: 2.0

Auth

ApiKey X-AUTH-ACCESS-TOKEN in header

Base URL

https://presentation.s.xtrf.eu/home-api

Setup

1. Set your API key in the appropriate header
2. GET /browser/csv -- verify access
3. POST /browser/views/for/{className} -- create first for

Endpoints

341 endpoints across 20 groups. See references/api-spec.lap for full details.

browser

Method	Path	Description
GET	/browser/csv	Searches for data (ie. customer, task, etc) and returns it in a CSV form.
GET	/browser	Searches for data (ie. customer, task, etc) and returns it in a tabular form.
GET	/browser/views/for/{className}	Returns views' brief.
POST	/browser/views/for/{className}	Creates view for given class.
GET	/browser/views/{viewId}	Returns all view's information.
PUT	/browser/views/{viewId}	Updates all view's information.
DELETE	/browser/views/{viewId}	Removes a view.
DELETE	/browser/views/{viewId}/columns/{columnName}	Deletes a single column from view.
GET	/browser/views/{viewId}/columns/{columnName}/settings	Returns column's specific settings.
PUT	/browser/views/{viewId}/columns/{columnName}/settings	Updates column's specific settings.
GET	/browser/views/{viewId}/columns	Returns columns defined in view.
PUT	/browser/views/{viewId}/columns	Updates columns in view.
GET	/browser/views/details/for/{className}	Returns current view's detailed information, suitable for browser.
GET	/browser/views/{viewId}/filter	Returns view's filter.
PUT	/browser/views/{viewId}/filter	Updates view's filter.
GET	/browser/views/{viewId}/settings/local	Returns view's local settings (for current user).
PUT	/browser/views/{viewId}/settings/local	Updates view's local settings (for current user).
GET	/browser/views/{viewId}/order	Returns view's order settings.
PUT	/browser/views/{viewId}/order	Updates view's order settings.
GET	/browser/views/{viewId}/permissions	Returns view's permissions.
PUT	/browser/views/{viewId}/permissions	Updates view's permissions.
GET	/browser/views/{viewId}/settings	Returns view's settings.
PUT	/browser/views/{viewId}/settings	Updates view's settings.
GET	/browser/views/details/for/{className}/{viewId}	Returns view's detailed information, suitable for browser.
POST	/browser/views/details/for/{className}/{viewId}	Selects given view as current and returns its detailed information, suitable for browser.
PUT	/browser/views/{viewId}/filter/{filterProperty}	Updates view's filter property.

accounting

Method	Path	Description
GET	/accounting/customers/invoices	Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.
POST	/accounting/customers/invoices	Creates a new invoice.
GET	/accounting/customers/invoices/{invoiceId}/payments	Returns all payments for the client invoice.
POST	/accounting/customers/invoices/{invoiceId}/payments	Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.
GET	/accounting/customers/invoices/{invoiceId}	Returns client invoice details.
DELETE	/accounting/customers/invoices/{invoiceId}	Removes a client invoice.
POST	/accounting/customers/invoices/documents	Allows for downloading multiple client invoice documents.
POST	/accounting/customers/invoices/xmlDocuments	Allows for downloading multiple client invoice xml documents.
POST	/accounting/customers/invoices/{invoiceId}/duplicate	Duplicate client invoice.
POST	/accounting/customers/invoices/{invoiceId}/duplicate/proForma	Duplicate client invoice as pro forma.
GET	/accounting/customers/invoices/ids	Returns client invoices' internal identifiers.
GET	/accounting/customers/invoices/{invoiceId}/dates	Returns dates of a given client invoice.
GET	/accounting/customers/invoices/{invoiceId}/document	Allows for downloading a given client invoice document.
GET	/accounting/customers/invoices/{invoiceId}/paymentTerms	Returns payment terms of a given client invoice.
GET	/accounting/customers/invoices/{invoiceId}/xmlDocument	Allows for downloading a given client invoice xml document.
POST	/accounting/customers/invoices/{invoiceId}/sendReminder	Sends reminder.
POST	/accounting/customers/invoices/sendReminders	Sends reminders. Returns number of sent e-mails.

customers

Method	Path	Description
POST	/customers/persons	Creates a new person.
GET	/customers/persons/{personId}	Returns person details.
PUT	/customers/persons/{personId}	Updates an existing person.
DELETE	/customers/persons/{personId}	Removes a person.
POST	/customers/persons/accessToken	Generates a single use sign-in token.
GET	/customers/persons/ids	Returns persons' internal identifiers.
GET	/customers/persons/{personId}/contact	Returns contact of a given person.
PUT	/customers/persons/{personId}/contact	Updates contact of a given person.
GET	/customers/persons/{personId}/customFields	Returns custom fields of a given person.
PUT	/customers/persons/{personId}/customFields	Updates custom fields of a given person.
DELETE	/customers/priceLists/{priceListId}	Removes a customer price list.
GET	/customers	Returns list of simple clients representations
POST	/customers	Creates a new client.
GET	/customers/{customerId}	Returns client details.
PUT	/customers/{customerId}	Updates an existing client.
DELETE	/customers/{customerId}	Removes a client.
GET	/customers/{customerId}/priceProfiles/active	Returns list of active price profiles for a client.
GET	/customers/{customerId}/address	Returns address of a given client.
PUT	/customers/{customerId}/address	Updates address of a given client.
GET	/customers/ids	Returns clients' internal identifiers.
GET	/customers/{customerId}/budgetCodes	Returns list of available budget codes for a client.
GET	/customers/byAlias

files

Method	Path	Description
POST	/files	Uploads a temporary file (ie. for XML import). Returns token which can be used in other API calls.

license

Method	Path	Description
GET	/license	Returns license content.
POST	/license/refresh	Refreshes license content.

macros

Method	Path	Description
POST	/macros/{macroId}/run	Executes a macro.

confidential-groups

Method	Path	Description
POST	/confidential-groups/sensitiveClients/client	Adds client to sensitive clients list.
GET	/confidential-groups/sensitiveClients	Returns sensitive clients list.
PUT	/confidential-groups/sensitiveClients	Updates sensitive clients list.
GET	/confidential-groups/sensitiveClients/isSensitive/{clientId}	Check if client is sensitive.
DELETE	/confidential-groups/sensitiveClients/client/{sensitiveClientId}	Removes sensitive client from sensitive clients list.
POST	/confidential-groups/trustedVendors/vendor	Adds vendor to trusted vendors list.
GET	/confidential-groups/trustedVendors	Returns trusted vendors list.
PUT	/confidential-groups/trustedVendors	Updates trusted vendors list.
DELETE	/confidential-groups/trustedVendors/vendor/{trustedVendorId}	Removes trusted vendor from trusted vendors list.

projectGroups

Method	Path	Description
GET	/projectGroups	Returns all project groups.
POST	/projectGroups	Creates a new Project Groups.
GET	/projectGroups/{projectGroupId}	Returns project group details.
PUT	/projectGroups/{projectGroupId}	Update project group details.
DELETE	/projectGroups/{projectGroupId}	Removes a project group.
PUT	/projectGroups/{projectGroupId}/linkProjects	Add projects to project group.
PUT	/projectGroups/{projectGroupId}/linkQuotes	Add quotes to project group.
PUT	/projectGroups/{projectGroupId}/unlinkProjects	Remove projects from project group.
PUT	/projectGroups/{projectGroupId}/unlinkQuotes	Remove quotes from project group.

providers

Method	Path	Description
GET	/providers/persons/{personId}	Returns person details.
DELETE	/providers/persons/{personId}	Removes a person.
GET	/providers/persons/ids	Returns persons' internal identifiers.
GET	/providers/persons/{personId}/contact	Returns contact of a given person.
GET	/providers/persons/{personId}/customFields	Returns custom fields of a given person.
POST	/providers/persons/{personId}/notification/invitation	Sends invitation to Vendor Portal.
DELETE	/providers/priceLists/{priceListId}	Removes a provider price list.
GET	/providers/{providerId}	Returns provider details.
DELETE	/providers/{providerId}	Removes a provider.
GET	/providers/{providerId}/address	Returns address of a given provider.
GET	/providers/ids	Returns providers' internal identifiers.
GET	/providers/{providerId}/competencies	Returns competencies of a given provider.
GET	/providers/{providerId}/contact	Returns contact of a given provider.
GET	/providers/{providerId}/correspondenceAddress	Returns correspondence address of a given provider.
GET	/providers/{providerId}/customFields	Returns custom fields of a given provider.
POST	/providers/{providerId}/notification/invitation	Sends invitations to Vendor Portal.

reports

Method	Path	Description
DELETE	/reports/{reportId}	Removes a report.
POST	/reports/{reportId}/duplicate	Duplicates a report.
POST	/reports/export/xml	Exports reports definition to XML.
GET	/reports/{reportId}/result/csv	Generates CSV content for a report.
GET	/reports/{reportId}/result/printerFriendly	Generates printer friendly content for a report.
POST	/reports/import/xml	Imports reports definition from XML.
PUT	/reports/{reportId}/preferred	Marks report as preferred or not.

services

Method	Path	Description
GET	/services/all	Returns services list
GET	/services/active	Returns active services list

settings

Method	Path	Description
GET	/settings/customFields	Returns Custom Fields configuration.

subscription

Method	Path	Description
GET	/subscription/supports	This method can be used to determine if hooks are supported.
GET	/subscription	Returns all subscriptions
POST	/subscription	Subscribe to event
DELETE	/subscription/{subscriptionId}	Unsubscribe from event

system

Method	Path	Description
GET	/system/configuration/email	Get email configuration
GET	/system/configuration/ftp	Get FTP configuration
GET	/system/configuration	Get basic system configuration
GET	/system/timeZone	Get system timezone information

users

Method	Path	Description
PUT	/users/{userId}/password	Sets user's password to a new value.
GET	/users	Returns list of simple users representations
GET	/users/{userId}	Returns user details.
PUT	/users/{userId}	Updates an existing user.
GET	/users/{userId}/customFields/{customFieldKey}	Returns custom field of a given user.
PUT	/users/{userId}/customFields/{customFieldKey}	Updates given custom field of a given user.
GET	/users/{userId}/customFields	Returns custom fields of a given user.
PUT	/users/{userId}/customFields	Updates custom fields of a given user.
GET	/users/me	Returns currently signed in user details.
GET	/users/me/timeZone	Returns time zone preferred by user currently signed in.

dictionaries

Method	Path	Description
GET	/dictionaries/active	Returns active dictionary entities for all types.
GET	/dictionaries/{type}/active	Returns active values from a given dictionary.
GET	/dictionaries/all	Returns dictionary entities for all types. Both active and not active ones.
GET	/dictionaries/{type}/all	Returns all values (both active and not active) from a given dictionary.
GET	/dictionaries/{type}/{id}	Returns specific value from a given dictionary.
GET	/dictionaries/{type}/all/default	Returns a default value from a given dictionary.
GET	/dictionaries/currency/{isoCode}/exchangeRate	Returns currency exchange rates.
POST	/dictionaries/currency/{isoCode}/exchangeRate	Adding currency exchange rates.
POST	/v2/dictionaries/language
PATCH	/v2/dictionaries/language/{languageId}
POST	/v2/dictionaries/specialization
PATCH	/v2/dictionaries/specialization/{specializationId}

jobs

Method	Path	Description
POST	/jobs/{jobId}/files/output
PUT	/jobs/{jobId}/vendor	Assigns vendor to a job in a project.
PUT	/jobs/{jobId}/status	Changes job status if possible (400 Bad Request is returned otherwise).
GET	/jobs/{jobId}	Returns job details by jobId.
GET	/jobs/{jobId}/files	Returns list of input and output files of a job.
GET	/jobs/{jobId}/files/{fileId}	Returns file metadata.
PUT	/jobs/{jobId}/dates	Updates dates of a given job.
PUT	/jobs/{jobId}/instructions	Updates instructions for a job.
POST	/v2/jobs/{jobId}/files/addExternalLink
POST	/v2/jobs/{jobId}/files/delivered/addLink	Adds file link to the project as a link delivered in the job.
PUT	/v2/jobs/{jobId}/files/delivered/add	Adds files to the project as delivered in the job.
PUT	/v2/jobs/{jobId}/vendor	Assigns vendor to a job in a project.
PUT	/v2/jobs/{jobId}/dates	Updates dates of a given job.
PUT	/v2/jobs/{jobId}/status	Changes job status if possible (400 Bad Request is returned otherwise).
GET	/v2/jobs/{jobId}	Returns details for a job.
DELETE	/v2/jobs/{jobId}	Deletes a job.
GET	/v2/jobs/for-external-id
GET	/v2/jobs/{jobId}/files/delivered	Returns list of files delivered in the job.
GET	/v2/jobs/{jobId}/files/sharedReferenceFiles	Returns list of files shared with the job as Reference Files.
GET	/v2/jobs/{jobId}/files/sharedWorkFiles	Returns list of files shared with the job as Work Files.
POST	/v2/jobs/merge	Merges given list of jobs into one job.
PUT	/v2/jobs/{jobId}/files/sharedReferenceFiles/share

projects

Method	Path	Description
POST	/projects	Creates a new Classic Project.
POST	/projects/{projectId}/languageCombinations	Creates a new language combination for a given project without creating a task.
POST	/projects/{projectId}/finance/payables	Adds a payable to a project.
POST	/projects/{projectId}/finance/receivables	Adds a receivable to a project.
POST	/projects/{projectId}/tasks	Creates a new task for a given project.
GET	/projects/{projectId}	Returns project details.
DELETE	/projects/{projectId}	Removes a project.
PUT	/projects/{projectId}/finance/payables/{payableId}	Updates a simple payable.
DELETE	/projects/{projectId}/finance/payables/{payableId}	Deletes a payable.
PUT	/projects/{projectId}/finance/receivables/{receivableId}	Updates a simple receivable.
DELETE	/projects/{projectId}/finance/receivables/{receivableId}	Deletes a receivable.
GET	/projects/ids	Returns projects' internal identifiers.
GET	/projects/{projectId}/contacts	Returns contacts of a given project.
PUT	/projects/{projectId}/contacts	Updates contacts of a given project.
GET	/projects/{projectId}/customFields	Returns custom fields of a given project.
PUT	/projects/{projectId}/customFields	Updates custom fields of a given project.
GET	/projects/{projectId}/dates	Returns dates of a given project.
PUT	/projects/{projectId}/dates	Updates dates of a given project.
GET	/projects/files/{fileId}/download	Downloads a file.
GET	/projects/{projectId}/finance	Returns finance of a given project.
GET	/projects/{projectId}/instructions

quotes

Method	Path	Description
POST	/quotes/{quoteId}/languageCombinations	Creates a new language combination for a given quote without creating a task.
POST	/quotes/{quoteId}/finance/payables	Adds a payable.
POST	/quotes/{quoteId}/finance/receivables	Adds a receivable.
POST	/quotes/{quoteId}/tasks	Creates a new task for a given quote.
GET	/quotes/{quoteId}	Returns quote details.
DELETE	/quotes/{quoteId}	Removes a quote.
PUT	/quotes/{quoteId}/finance/payables/{payableId}	Updates a simple payable.
DELETE	/quotes/{quoteId}/finance/payables/{payableId}	Deletes a payable.
PUT	/quotes/{quoteId}/finance/receivables/{receivableId}	Updates a simple receivable.
DELETE	/quotes/{quoteId}/finance/receivables/{receivableId}	Deletes a receivable.
GET	/quotes/ids	Returns quotes' internal identifiers.
GET	/quotes/{quoteId}/customFields	Returns custom fields of a given quote.
PUT	/quotes/{quoteId}/customFields	Updates custom fields of a given quote.
GET	/quotes/{quoteId}/dates	Returns dates of a given quote.
GET	/quotes/{quoteId}/finance	Returns finance of a given quote.
GET	/quotes/{quoteId}/instructions	Returns instructions of a given quote.
PUT	/quotes/{quoteId}/instructions	Updates instructions of a given quote.
POST	/quotes/{quoteId}/confirmation/send	Sends a quote for customer confirmation.
POST	/quotes/{quoteId}/start	Starts a quote.
POST	/v2/quotes/{quoteId}/files/addExternalLinks
POST	/v2/quotes/{quoteId}/externalInfo
POST	/v2/quotes/{quoteId}/files/addLink

tasks

Method	Path	Description
POST	/tasks/{taskId}/files/input	Adds files to a given task.
DELETE	/tasks/{taskId}	Removes a task.
GET	/tasks/{taskId}/contacts	Returns contacts of a given task.
PUT	/tasks/{taskId}/contacts	Updates contacts of a given task.
GET	/tasks/{taskId}/customFields	Returns custom fields of a given task.
PUT	/tasks/{taskId}/customFields	Updates custom fields of a given task.
GET	/tasks/{taskId}/dates	Returns dates of a given task.
PUT	/tasks/{taskId}/dates	Updates dates of a given task.
GET	/tasks/{taskId}/instructions	Returns instructions of a given task.
PUT	/tasks/{taskId}/instructions	Updates instructions of a given task.
GET	/tasks/{taskId}/progress	Returns progress of a given task.
GET	/tasks/{taskId}/files	Returns lists of files of a given task.
POST	/tasks/{taskId}/start	Starts a task.
PUT	/tasks/{taskId}/clientTaskPONumber	Updates Client Task PO Number of a given task.
PUT	/tasks/{taskId}/name	Updates name of a given task.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all csv?" -> GET /browser/csv
• "List all browser?" -> GET /browser
• "Get for details?" -> GET /browser/views/for/{className}
• "Get view details?" -> GET /browser/views/{viewId}
• "Update a view?" -> PUT /browser/views/{viewId}
• "Delete a view?" -> DELETE /browser/views/{viewId}
• "Delete a column?" -> DELETE /browser/views/{viewId}/columns/{columnName}
• "List all settings?" -> GET /browser/views/{viewId}/columns/{columnName}/settings
• "List all columns?" -> GET /browser/views/{viewId}/columns
• "Get for details?" -> GET /browser/views/details/for/{className}
• "List all filter?" -> GET /browser/views/{viewId}/filter
• "List all local?" -> GET /browser/views/{viewId}/settings/local
• "List all order?" -> GET /browser/views/{viewId}/order
• "List all permissions?" -> GET /browser/views/{viewId}/permissions
• "List all settings?" -> GET /browser/views/{viewId}/settings
• "Get for details?" -> GET /browser/views/details/for/{className}/{viewId}
• "Update a filter?" -> PUT /browser/views/{viewId}/filter/{filterProperty}
• "List all invoices?" -> GET /accounting/customers/invoices
• "Create a invoice?" -> POST /accounting/customers/invoices
• "List all payments?" -> GET /accounting/customers/invoices/{invoiceId}/payments
• "Create a payment?" -> POST /accounting/customers/invoices/{invoiceId}/payments
• "Get invoice details?" -> GET /accounting/customers/invoices/{invoiceId}
• "Delete a invoice?" -> DELETE /accounting/customers/invoices/{invoiceId}
• "Create a document?" -> POST /accounting/customers/invoices/documents
• "Create a xmlDocument?" -> POST /accounting/customers/invoices/xmlDocuments
• "Create a duplicate?" -> POST /accounting/customers/invoices/{invoiceId}/duplicate
• "Create a proForma?" -> POST /accounting/customers/invoices/{invoiceId}/duplicate/proForma
• "List all ids?" -> GET /accounting/customers/invoices/ids
• "List all dates?" -> GET /accounting/customers/invoices/{invoiceId}/dates
• "List all document?" -> GET /accounting/customers/invoices/{invoiceId}/document
• "List all paymentTerms?" -> GET /accounting/customers/invoices/{invoiceId}/paymentTerms
• "List all xmlDocument?" -> GET /accounting/customers/invoices/{invoiceId}/xmlDocument
• "Create a sendReminder?" -> POST /accounting/customers/invoices/{invoiceId}/sendReminder
• "Create a sendReminder?" -> POST /accounting/customers/invoices/sendReminders
• "Delete a payment?" -> DELETE /accounting/customers/payments/{paymentId}
• "Create a person?" -> POST /customers/persons

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP