Automate XTRF Home Portal

What XTRF Home Portal is

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 writin

API host: presentation.s.xtrf.eu

What HumDay can do in XTRF Home Portal

167 documented operations change something in XTRF Home Portal. The 65 most useful are listed here.

• POSTCreates a new invoice./accounting/customers/invoices
• POSTCreates a new invoice./accounting/providers/invoices
• POSTCreates a new client./customers
• POSTCreates a new task for a given quote./quotes/{quoteId}/tasks
• POSTCreates a new task for a given project./projects/{projectId}/tasks
• POSTCreates a new person./customers/persons
• POSTAdds files to a given task./tasks/{taskId}/files/input
• DELETERemoves a customer payment./accounting/customers/payments/{paymentId}
• POSTUploads a temporary file (ie./files
• POSTCreates a new Classic Project./projects
• POSTSubscribe to event/subscription
• PUTUpdates contacts of a given task./tasks/{taskId}/contacts
• PUTSets user's password to a new value./users/{userId}/password
• POSTSends a provider invoice./accounting/providers/invoices/{invoiceId}/send
• POSTAdds a new payment to the client invoice./accounting/customers/invoices/{invoiceId}/payments
• POSTCreates a new payment on the vendor account and assigns the payment to the invoice./accounting/providers/invoices/{invoiceId}/payments
• DELETERemoves a customer price list./customers/priceLists/{priceListId}
• POSTCreates a new Smart Quote./v2/quotes
• POSTCreates a new Smart Project./v2/projects
• POSTCreates a new language combination for a given quote without creating a task./quotes/{quoteId}/languageCombinations
• POSTCreates a new language combination for a given project without creating a task./projects/{projectId}/languageCombinations
• POSTSends reminders. Returns number of sent e-mails./accounting/customers/invoices/sendReminders
• POSTSends a quote for customer confirmation./quotes/{quoteId}/confirmation/send
• DELETERemoves a task./tasks/{taskId}
• PUTUpdates an existing user./users/{userId}
• DELETERemoves a client invoice./accounting/customers/invoices/{invoiceId}
• DELETERemoves a provider payment./accounting/providers/payments/{paymentId}
• DELETEUnsubscribe from event/subscription/{subscriptionId}
• PUTAdds files to the quote as added by PM./v2/quotes/{quoteId}/files/add
• POSTUploads file to the quote as a file uploaded by PM./v2/quotes/{quoteId}/files/upload
• PUTAdds files to the project as added by PM./v2/projects/{projectId}/files/add
• POSTUploads file to the project as a file uploaded by PM./v2/projects/{projectId}/files/upload
• POSTAdds file links to the project as added by PM./v2/projects/{projectId}/files/addLink
• PUTUpdates name of a given task./tasks/{taskId}/name
• PUTUpdates dates of a given task./tasks/{taskId}/dates
• POSTStarts a task./tasks/{taskId}/start
• PUTUpdates custom fields of a given task./tasks/{taskId}/customFields
• PUTUpdates instructions of a given task./tasks/{taskId}/instructions
• PUTUpdates custom fields of a given user./users/{userId}/customFields
• PUTUpdates contact of a given client./customers/{customerId}/contact
• POSTDuplicate client invoice./accounting/customers/invoices/{invoiceId}/duplicate
• PUTUpdates Client Task PO Number of a given task./tasks/{taskId}/clientTaskPONumber
• POSTSends reminder./accounting/customers/invoices/{invoiceId}/sendReminder
• PUTAdds files to the project as delivered in the job./v2/jobs/{jobId}/files/delivered/add
• POSTUploads file to the project as a file delivered in the job./v2/jobs/{jobId}/files/delivered/upload
• POSTAdds file link to the project as a link delivered in the job./v2/jobs/{jobId}/files/delivered/addLink
• POSTGenerates client invoices' documents./accounting/customers/invoices/documents
• PUTUpdates contact of a given person./customers/persons/{personId}/contact
• POSTDuplicate client invoice as pro forma./accounting/customers/invoices/{invoiceId}/duplicate/proForma
• DELETERemoves a provider invoice./accounting/providers/invoices/{invoiceId}
• DELETERemoves a client./customers/{customerId}
• PUTUpdates an existing client./customers/{customerId}
• POSTSends invitations to Vendor Portal./providers/{providerId}/notification/invitation
• POSTGenerates a single use sign-in token./customers/persons/accessToken
• PUTUpdates given custom field of a given user./users/{userId}/customFields/{customFieldKey}
• POSTChanges invoice status to given status./accounting/providers/invoices/{invoiceId}/status
• DELETERemoves a person./customers/persons/{personId}
• PUTUpdates an existing person./customers/persons/{personId}
• POSTPrepares a ZIP archive that contains the specified files./v2/quotes/files/archive
• PUTUpdates contacts of a given project./projects/{projectId}/contacts
• PUTUpdates address of a given client./customers/{customerId}/address
• POSTPrepares a ZIP archive that contains the specified files./v2/projects/files/archive
• POSTSends invitation to Vendor Portal./providers/persons/{personId}/notification/invitation
• PUTUpdates categories of a given client./customers/{customerId}/categories
• PUTUpdates industries of a given client./customers/{customerId}/industries

What HumDay can read from XTRF Home Portal

These are the operations a schedule or a trigger can watch.

• GETReturns list of simple users representations/users
• GETReturns list of simple clients representations/customers
• GETReturns lists of files of a given task./tasks/{taskId}/files
• GETReturns contacts of a given task./tasks/{taskId}/contacts
• GETGenerates client invoice document (PDF)./accounting/customers/invoices/{invoiceId}/document
• GETReturns all payments for the client invoice./accounting/customers/invoices/{invoiceId}/payments
• GETReturns currently signed in user details./users/me
• GETReturns payment terms of a given client invoice./accounting/customers/invoices/{invoiceId}/paymentTerms
• GETReturns user details./users/{userId}
• GETReturns client invoice details./accounting/customers/invoices/{invoiceId}
• GETReturns time zone preferred by user currently signed in./users/me/timeZone
• GETLists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date./accounting/customers/invoices
• GETReturns all subscriptions/subscription
• GETReturns list of input and output files of a job./jobs/{jobId}/files
• GETReturns dates of a given task./tasks/{taskId}/dates
• GETReturns progress of a given task./tasks/{taskId}/progress
• GETReturns dates of a given client invoice./accounting/customers/invoices/{invoiceId}/dates
• GETReturns custom fields of a given task./tasks/{taskId}/customFields
• GETReturns instructions of a given task./tasks/{taskId}/instructions
• GETReturns custom fields of a given user./users/{userId}/customFields
• GETGenerates provider invoice document (PDF)./accounting/providers/invoices/{invoiceId}/document
• GETReturns all payments for the vendor invoice./accounting/providers/invoices/{invoiceId}/payments
• GETReturns contact of a given client./customers/{customerId}/contact
• GETReturns services list/services/all
• GETReturns active services list/services/active
• GETReturns details of a file./v2/quotes/files/{fileId}
• GETReturns list of files in a quote./v2/quotes/{quoteId}/files
• GETThis method can be used to determine if hooks are supported./subscription/supports
• GETReturns details of a file./v2/projects/files/{fileId}
• GETReturns list of files in a project./v2/projects/{projectId}/files
• GETDownloads a file./projects/files/{fileId}/download
• GETReturns contact of a given person./customers/persons/{personId}/contact
• GETReturns provider invoice details./accounting/providers/invoices/{invoiceId}
• GETReturns client details./customers/{customerId}
• GETReturns file metadata./jobs/{jobId}/files/{fileId}

How automating XTRF Home Portal works

1. Describe the outcome. Say what you want to happen, in your own words. No node graphs, no field mapping.
2. Approve the contract. HumDay writes down exactly what it will do, what it will touch, and what it will never do. You approve it before anything is built.
3. See it proven. The program runs and shows you the result before it is allowed near your live XTRF Home Portal account.
4. Grant access, then go live. You approve the specific XTRF Home Portal operations it may use — and only those.

Questions about XTRF Home Portal automation

Can HumDay connect to XTRF Home Portal?

Yes. HumDay reads XTRF Home Portal's own published API description and derives the operations from it, so there is no hand-built connector to wait for. 284 operations are documented.

Do I need to write code to automate XTRF Home Portal?

No. You describe the outcome you want in plain words. HumDay agrees a contract with you, writes the program, and shows you a test run before anything touches your XTRF Home Portal account.

What can HumDay do in XTRF Home Portal?

167 of the 284 documented operations change something in XTRF Home Portal, and 117 read from it. HumDay only ever uses the specific operations your approved contract needs.

Is my XTRF Home Portal account safe?

Your credentials are stored encrypted and are never shown in chat, code, or logs. Every run is limited to the operations you explicitly approved, and anything that writes to XTRF Home Portal is held behind that approval.

Where this came from

The operations above are read from a published API description for XTRF Home Portal at presentation.s.xtrf.eu/home-api/openapi.json. Descriptions are the provider’s own words, not ours. Last published 2023-03-06.