xtrf-home-portal-api — quality + safety report

---
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. |
| DELETE | /accounting/customers/payments/{paymentId} | Removes a customer payment. |
| GET | /accounting/providers/invoices | Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date. |
| POST | /accounting/providers/invoices | Creates a new invoice. |
| GET | /accounting/providers/invoices/{invoiceId}/payments | Returns all payments for the vendor invoice. |
| POST | /accounting/providers/invoices/{invoiceId}/payments | Creates a new payment on the vendor account and assigns the payment to the invoice. |
| GET | /accounting/providers/invoices/{invoiceId} | Returns provider invoice details. |
| DELETE | /accounting/providers/invoices/{invoiceId} | Removes a provider invoice. |
| GET | /accounting/providers/invoices/ids | Returns vendor invoices' internal identifiers. |
| GET | /accounting/providers/invoices/{invoiceId}/document | Generates provider invoice document (PDF). |
| POST | /accounting/providers/invoices/{invoiceId}/send | Sends a provider invoice. |
| POST | /accounting/providers/invoices/{invoiceId}/status | Changes invoice status to given status. |
| DELETE | /accounting/providers/payments/{paymentId} | Removes a provider payment. |

### 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 | Returns client details. |
| GET | /customers/{customerId}/categories | Returns categories of a given client. |
| PUT | /customers/{customerId}/categories | Updates categories of a given client. |
| GET | /customers/{customerId}/contact | Returns contact of a given client. |
| PUT | /customers/{customerId}/contact | Updates contact of a given client. |
| GET | /customers/{customerId}/correspondenceAddress | Returns correspondence address of a given client. |
| PUT | /customers/{customerId}/correspondenceAddress | Updates correspondence address of a given client. |
| GET | /customers/{customerId}/customFields/{customFieldKey} | Returns custom field of a given client. |
| PUT | /customers/{customerId}/customFields/{customFieldKey} | Updates given custom field of a given client. |
| GET | /customers/{customerId}/customFields | Returns custom fields of a given client. |
| PUT | /customers/{customerId}/customFields | Updates custom fields of a given client. |
| GET | /customers/{customerId}/settings/specializations | Returns specializations available for a given client in the Client Portal. |
| GET | /customers/{customerId}/industries | Returns industries of a given client. |
| PUT | /customers/{customerId}/industries | Updates industries of a given client. |
| GET | /customers/{customerId}/settings/languages | Returns languages available for a given client in the Client Portal. |
| GET | /customers/{customerId}/offices | Returns list of offices in the office structure in which the client is located. |
| GET | /customers/{customerId}/services | Returns list of available services for a client. |

### 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 o

… (truncated)