XTRF Home Portal API API

by xtrf.eu

API keyHTTPSBooks

Overview

XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. <br>The documentation is generated from OpenAPI specification 3.0 available <a href="/home-api/openapi.json">here</a> <br> The API client/consumer code may be easily generated in 60+ programming languages using an open source code generator available at the time of writing this documentation at <a href='https://editor.swagger.io/'>https://editor.swagger.io/</a> Thank you for using XTRF Application Programming interface (XTRF API). By using the API you agree to the terms below. If you disagree with any of these terms, XTRF does not grant you a license to use the XTRF API. XTRF reserves the right to update and change these terms from time to time without a prior notice of API users. You can always find the most recent version of these terms here:

XTRF Home Portal API is a books API from xtrf.eu. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 284 endpoints.

At a glance

Authentication: API key
HTTPS: Yes
CORS: Unknown
Category: Books
Base URL: https://presentation.s.xtrf.eu/home-api
Version: 2.0
Endpoints: 284
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://presentation.s.xtrf.eu/home-api/accounting/customers/invoices" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch("https://presentation.s.xtrf.eu/home-api/accounting/customers/invoices", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://presentation.s.xtrf.eu/home-api/accounting/customers/invoices",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
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.
POST	`/accounting/customers/invoices/documents`	Generates client invoices' documents.
GET	`/accounting/customers/invoices/ids`	Returns client invoices' internal identifiers.
POST	`/accounting/customers/invoices/sendReminders`	Sends reminders. Returns number of sent e-mails.
GET	`/accounting/customers/invoices/{invoiceId}`	Returns client invoice details.
DELETE	`/accounting/customers/invoices/{invoiceId}`	Removes a client invoice.
GET	`/accounting/customers/invoices/{invoiceId}/dates`	Returns dates of a given client invoice.
GET	`/accounting/customers/invoices/{invoiceId}/document`	Generates client invoice document (PDF).
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/{invoiceId}/paymentTerms`	Returns payment terms of a given client 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.
POST	`/accounting/customers/invoices/{invoiceId}/sendReminder`	Sends reminder.
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/ids`	Returns vendor invoices' internal identifiers.
GET	`/accounting/providers/invoices/{invoiceId}`	Returns provider invoice details.
DELETE	`/accounting/providers/invoices/{invoiceId}`	Removes a provider invoice.
GET	`/accounting/providers/invoices/{invoiceId}/document`	Generates provider invoice document (PDF).
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.
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.
GET	`/browser`	Searches for data (ie. customer, task, etc) and returns it in a tabular form.
GET	`/browser/csv`	Searches for data (ie. customer, task, etc) and returns it in a CSV form.
GET	`/browser/views/details/for/{className}`	Returns current view's detailed information, suitable for browser.
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.
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.
GET	`/browser/views/{viewId}/columns`	Returns columns defined in view.
PUT	`/browser/views/{viewId}/columns`	Updates columns in 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}/filter`	Returns view's filter.
PUT	`/browser/views/{viewId}/filter`	Updates view's filter.
PUT	`/browser/views/{viewId}/filter/{filterProperty}`	Updates view's filter property.
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/{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	`/customers`	Returns list of simple clients representations
POST	`/customers`	Creates a new client.
GET	`/customers/ids`	Returns clients' internal identifiers.
POST	`/customers/persons`	Creates a new person.
POST	`/customers/persons/accessToken`	Generates a single use sign-in token.
GET	`/customers/persons/ids`	Returns persons' internal identifiers.
GET	`/customers/persons/{personId}`	Returns person details.
PUT	`/customers/persons/{personId}`	Updates an existing person.
DELETE	`/customers/persons/{personId}`	Removes a person.
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/{customerId}`	Returns client details.
PUT	`/customers/{customerId}`	Updates an existing client.
DELETE	`/customers/{customerId}`	Removes a client.
GET	`/customers/{customerId}/address`	Returns address of a given client.
PUT	`/customers/{customerId}/address`	Updates address of a given client.
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`	Returns custom fields of a given client.
PUT	`/customers/{customerId}/customFields`	Updates custom fields 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}/industries`	Returns industries of a given client.
PUT	`/customers/{customerId}/industries`	Updates industries of a given client.
GET	`/dictionaries/active`	Returns active dictionary entities for all types.
GET	`/dictionaries/all`	Returns dictionary entities for all types. Both active and not active ones.
GET	`/dictionaries/currency/{isoCode}/exchangeRate`	Returns currency exchange rates.
POST	`/dictionaries/currency/{isoCode}/exchangeRate`	Adding currency exchange rates.
GET	`/dictionaries/{type}/active`	Returns active values from a given dictionary.
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.
POST	`/files`	Uploads a temporary file (ie. for XML import). Returns token which can be used in other API calls.
GET	`/jobs/{jobId}`	Returns job details by jobId.
PUT	`/jobs/{jobId}/dates`	Updates dates of a given job.
GET	`/jobs/{jobId}/files`	Returns list of input and output files of a job.
POST	`/jobs/{jobId}/files/output`	assignFileToJobOutput
GET	`/jobs/{jobId}/files/{fileId}`	Returns file metadata.
PUT	`/jobs/{jobId}/instructions`	Updates instructions for a job.
PUT	`/jobs/{jobId}/status`	Changes job status if possible (400 Bad Request is returned otherwise).
PUT	`/jobs/{jobId}/vendor`	Assigns vendor to a job in a project.