XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. The documentation is generated from OpenAPI specification 3.0 available here The API client/consumer code may be easily generated in 60+ programming languages using an o
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://presentation.s.xtrf.eu/home-api
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
XTRF Home Portal API enables you to perform operations on Projects, Quotes, Customers, Vendors etc. as a XTRF Home Portal user. The documentation is generated from OpenAPI specification 3.0 available here 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 https://editor.swag
| method | path | what the vendor says it does |
|---|---|---|
GET | /accounting/customers/invoices | Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a spec |
POST | /accounting/customers/invoices | Creates a new invoice. Creates a new invoice from tasks. Tasks are grouped by client and currency, therefore m |
POST | /accounting/customers/invoices/documents | Generates client invoices' documents. Generates client invoices' documents. Client Invoices |
GET | /accounting/customers/invoices/ids | Returns client invoices' internal identifiers. Returns client invoices' internal identifiers. Client Invoices |
POST | /accounting/customers/invoices/sendReminders | Sends reminders. Returns number of sent e-mails. Sends reminders. Returns number of sent e-mails. Client Invoi |
GET | /accounting/customers/invoices/{invoiceId} | Returns client invoice details. Returns client invoice details. Client Invoices |
DELETE | /accounting/customers/invoices/{invoiceId} | Removes a client invoice. Removes a client invoice. Client Invoices |
GET | /accounting/customers/invoices/{invoiceId}/dates | Returns dates of a given client invoice. Returns dates of a given client invoice. Client Invoices |
GET | /accounting/customers/invoices/{invoiceId}/document | Generates client invoice document (PDF). Generates client invoice document (PDF). Client Invoices |
POST | /accounting/customers/invoices/{invoiceId}/duplicate | Duplicate client invoice. Duplicate client invoice. Client Invoices |
POST | /accounting/customers/invoices/{invoiceId}/duplicate/proForma | Duplicate client invoice as pro forma. Duplicate client invoice as pro forma. Client Invoices |
GET | /accounting/customers/invoices/{invoiceId}/paymentTerms | Returns payment terms of a given client invoice. Returns payment terms of a given client invoice. Client Invoi |
GET | /accounting/customers/invoices/{invoiceId}/payments | Returns all payments for the client invoice. Returns all payments for the client invoice. Client Invoices |
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 |
POST | /accounting/customers/invoices/{invoiceId}/sendReminder | Sends reminder. Sends reminder. Client Invoices |
DELETE | /accounting/customers/payments/{paymentId} | Removes a customer payment. Removes a customer payment. Client Invoices |
GET | /accounting/providers/invoices | Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a spec |
POST | /accounting/providers/invoices | Creates a new invoice. Creates a new invoice from jobs. Jobs are grouped by provider and currency, therefore m |
GET | /accounting/providers/invoices/ids | Returns vendor invoices' internal identifiers. Returns vendor invoices' internal identifiers. Vendor Invoices |
GET | /accounting/providers/invoices/{invoiceId} | Returns provider invoice details. Returns provider invoice details. Vendor Invoices |
DELETE | /accounting/providers/invoices/{invoiceId} | Removes a provider invoice. Removes a provider invoice. Vendor Invoices |
GET | /accounting/providers/invoices/{invoiceId}/document | Generates provider invoice document (PDF). Generates provider invoice document (PDF). Vendor Invoices |
GET | /accounting/providers/invoices/{invoiceId}/payments | Returns all payments for the vendor invoice. Returns all payments for the vendor invoice. Vendor Invoices |
POST | /accounting/providers/invoices/{invoiceId}/payments | Creates a new payment on the vendor account and assigns the payment to the invoice. Creates a new payment on t |
POST | /accounting/providers/invoices/{invoiceId}/send | Sends a provider invoice. Sends a provider invoice. Vendor Invoices |
POST | /accounting/providers/invoices/{invoiceId}/status | Changes invoice status to given status. Changes invoice status to given status. Vendor Invoices |
DELETE | /accounting/providers/payments/{paymentId} | Removes a provider payment. Removes a provider payment. Vendor Invoices |
GET | /browser | Searches for data (ie. customer, task, etc) and returns it in a tabular form. Searches for data (ie. customer, |
GET | /browser/csv | Searches for data (ie. customer, task, etc) and returns it in a CSV form. Searches for data (ie. customer, tas |
GET | /browser/views/details/for/{className} | Returns current view's detailed information, suitable for browser. Returns current view's detailed information |
GET | /browser/views/details/for/{className}/{viewId} | Returns view's detailed information, suitable for browser. Returns view's detailed information, suitable for b |
POST | /browser/views/details/for/{className}/{viewId} | Selects given view as current and returns its detailed information, suitable for browser. Selects given view a |
GET | /browser/views/for/{className} | Returns views' brief. Returns views' brief. Browser |
POST | /browser/views/for/{className} | Creates view for given class. Creates view for given class. Browser |
GET | /browser/views/{viewId} | Returns all view's information. Returns all view's information (ie. name, columns, filters, etc). Browser |
PUT | /browser/views/{viewId} | Updates all view's information. Updates all view's information (ie. name, columns, filters, etc). Browser |
DELETE | /browser/views/{viewId} | Removes a view. Removes a view. No content is returned upon success (204). Browser |
GET | /browser/views/{viewId}/columns | Returns columns defined in view. Returns columns defined in view. Browser |
PUT | /browser/views/{viewId}/columns | Updates columns in view. Updates columns in view. Browser |
DELETE | /browser/views/{viewId}/columns/{columnName} | Deletes a single column from view. Deletes a single column from view. Browser |
and 160 more operation(s) in this specification, all searchable.
specification origin: https://presentation.s.xtrf.eu/home-api/openapi.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.