XTRF Home Portal API

Tools (286)

Extracted live via the executor SDK.

• browser.browseCsv

  Searches for data (ie. customer, task, etc) and returns it in a CSV form.

• browser.browseJson

  Searches for data (ie. customer, task, etc) and returns it in a tabular form.

• browser.create

  Creates view for given class.

• browser.delete

  Removes a view. No content is returned upon success (204).

• browser.deleteColumn

  Deletes a single column from view.

• browser.get

  Returns all view's information (ie. name, columns, filters, etc).

• browser.getColumns

  Returns columns defined in view.

• browser.getColumnSettings

  Returns column's specific settings. For example when column describes money amount we can decide whether it should display currency or not.

• browser.getCurrentViewDetails

  Returns current view's detailed information, suitable for browser.

• browser.getFilter

  Returns view's filter.

• browser.getLocalSettings

  Returns view's local settings (for current user).

• browser.getOrder

  Returns view's order settings.

• browser.getPermissions

  Returns view's permissions.

• browser.getSettings

  Returns view's settings (ie. name).

• browser.getViewDetails

  Returns view's detailed information, suitable for browser.

• browser.getViewsBrief

  Returns views' brief.

• browser.selectViewAndGetItsDetails

  Selects given view as current and returns its detailed information, suitable for browser.

• browser.update

  Updates all view's information (ie. name, columns, filters, etc).

• browser.updateColumns

  Updates columns in view.

• browser.updateColumnSettings

  Updates column's specific settings. For example when column describes money amount we can decide whether it should display currency or not.

• browser.updateFilter

  Updates view's filter.

• browser.updateFilterProperty

  Updates view's filter property.

• browser.updateLocalSettings

  Updates view's local settings (for current user).

• browser.updateOrder

  Updates view's order settings.

• browser.updatePermissions

  Updates view's permissions.

• browser.updateSettings

  Updates view's settings.

• clientInvoices.create1

  Creates a new invoice from tasks. Tasks are grouped by client and currency, therefore multiple invoices can be created.If any of the tasks cannot be invoiced (ie. it is already invoiced, not invoiceable, not associated with a project) then an error is reported.

• clientInvoices.createPayment

  Adds a new payment to the client invoice. The invoice payment status (Not Paid, Partially Paid, Fully Paid) is automatically recalculated.

• clientInvoices.delete1

  Removes a client invoice.

• clientInvoices.delete2

  Removes a customer payment.

• clientInvoices.downloadDocuments

  Generates client invoices' documents.

• clientInvoices.duplicate

  Duplicate client invoice.

• clientInvoices.duplicateAsProForma

  Duplicate client invoice as pro forma.

• clientInvoices.getAll

  Lists all client invoices in all statuses (including not ready and drafts) that have been updated since a specific date.

• clientInvoices.getAllIds

  Returns client invoices' internal identifiers.

• clientInvoices.getById

  Returns client invoice details.

• clientInvoices.getDates

  Returns dates of a given client invoice.

• clientInvoices.getDocument

  Generates client invoice document (PDF).

• clientInvoices.getPayments

  Returns all payments for the client invoice.

• clientInvoices.getPaymentTerms

  Returns payment terms of a given client invoice.

• clientInvoices.sendReminder

  Sends reminder.

• clientInvoices.sendReminders

  Sends reminders. Returns number of sent e-mails.

• clients.create2

  Creates a new person. Required fields are presented in the example. Other fields (from PUT) may also be specified here.

• clients.create3

  Creates a new client. All available fields are presented in PUT request.

  Required fields:

  • name
  • fullName
  • contact -> emails -> primary
• clients.delete3

  Removes a person.

• clients.delete4

  Removes a customer price list.

• clients.delete5

  Removes a client.

• clients.generateSingleUseSignInToken

  Generates a single use sign-in token for the customer person found for given login or e-mail. Returns 'url' and 'token' which allows to sign-in to customer portal as this person. Token is valid for two minutes and can be used only once. To sign-in to customer portal you should post 'token' provided as the 'accessToken' form param to the 'url' using POST method.Detailed description is available in the Customer API authentication.

• clients.getAddress

  Returns address of a given client.

• clients.getAllIds1

  Returns persons' internal identifiers.

• clients.getAllIds2

  Returns clients' internal identifiers.

• clients.getAllNamesWithIds

  Returns list of simple clients representations

• clients.getById1

  Returns person details.

• clients.getById2

  Returns client details.

• clients.getCategories

  Returns categories of a given client.

• clients.getContact

  Returns contact of a given person.

• clients.getContact1

  Returns contact of a given client.

• clients.getCorrespondenceAddress

  Returns correspondence address of a given client.

• clients.getCustomField

  Returns custom field of a given client.

• clients.getCustomFields

  Returns custom fields of a given person.

• clients.getCustomFields1

  Returns custom fields of a given client.

• clients.getIndustries

  Returns industries of a given client.

• clients.update1

  Only specified fields will be changed. One may not specify embeddable fields here - use separate API calls for updating them.

• clients.update2

  Only specified fields will be changed (id is required). One may not specify embeddable fields here - use separate API calls for updating them.

• clients.updateAddress

  Updates address of a given client.

• clients.updateCategories

  Updates categories of a given client.

• clients.updateContact

  Updates contact of a given person. Sets that this person uses specific address and contact (not the one from customer).

• clients.updateContact1

  Updates contact of a given client.

• clients.updateCorrespondenceAddress

  Updates correspondence address of a given client.

• clients.updateCustomField

  Updates given custom field of a given client.

• clients.updateCustomFields

  Updates custom fields of a given person.

• clients.updateCustomFields1

  Updates custom fields of a given client.

• clients.updateIndustries

  Updates industries of a given client.

• currencyExchangeRates.createExchangeRate

  Adding currency exchange rates via API

• currencyExchangeRates.getByIsoCode

  Returns currency exchange rates.

• dictionaries.getActive

  Returns active dictionary entities for all types.

• dictionaries.getActiveByType

  Returns active values from a given dictionary.

• dictionaries.getAll1

  XTRF holds many user-defined dictionaries (ie. countries). Each dictionary contains a set of values (ie. Poland or Germany). A default value may be defined for a dictionary.

  Dictionary values are identified using internal identifier which is constant and unique among other values from the same dictionary. Please note that name used in dictionary values is presented in the locale of the current identity. The same dictionary value can have different names, ie. "Poland" for one user, "Polska" for another one.

  Possible dictionary types with short explanation:

  • calculationUnit - predefined values of how to calculate the volume of work into the price
  • category - labels to organize data on the platform
  • country - list of countries used on the platform
  • currency - currencies used in financial operations in the system
  • industry - industry sectors which clients specialize in
  • jobType - services offered by a company used in customized workflows
  • language - list of languages and its values used on the platform
  • leadSource - lead/recruitment places where new clients and vendors may be found
  • personDepartment - departments in which contact person may be assigned to
  • personPosition - positions in which user may be associated with
  • province - states and provinces used in various documents on the platform
  • specialization - list of specific qualifications required to perform a specific job in the task, for ex. medical, military

• dictionaries.getAll3

  Returns workflows list. Both active and not active ones.

• dictionaries.getAllActive

  Returns active workflows list

• dictionaries.getAllByType

  Returns all values (both active and not active) from a given dictionary.

• dictionaries.getByTypeAndId

  Returns specific value from a given dictionary.

• files.uploadFile

  When a file is required by an operation (ie. task creation) it must be uploaded previously to the API. Uploading a file will result in a file token, which can be used to reference this file in other API calls. Each file must be uploaded separately. Keep in mind that file token has limited validity (ie. 10 minutes). Therefore files must be uploaded just before issuing API call which reference them.

• jobsClassic.assignFileToJobOutput

  POST /jobs/{jobId}/files/output

• jobsClassic.assignVendor

  Assigns vendor to a job in a project.

• jobsClassic.changeStatus

  Changes job status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:

  • OPEN – available when the job has one of the following statuses: ACCEPTED, CANCELED
  • ACCEPTED – available when the job has one of the following statuses: OPEN (Vendor and dates have to be set before calling the operation), STARTED
  • STARTED – available when the job has one of the following statuses: ACCEPTED, READY
  • READY – available when the job has one of the following statuses: STARTED
  • CANCELLED – available when the job has one of the following statuses: OPEN, ACCEPTED, STARTED, OFFERS_SENT
  • OFFERS_SENT – not available as a target status for this operation

• jobsClassic.getJobDetails

  Returns job details by jobId.

• jobsClassic.getJobFiles

  Returns list of input and output files of a job.

• jobsClassic.getJobFiles1

  Returns file metadata.

• jobsClassic.updateDates

  Updates dates of a given job.

• jobsClassic.updateInstructions

  Updates instructions for a job.

• jobsSmartV2.addExternalFileLink

  POST /v2/jobs/{jobId}/files/addExternalLink

• jobsSmartV2.addFileLinks

  Adds file link to the project as a link delivered in the job. The following properties can be specified for each file link:

  • url (required, 400 Bad Request is returned otherwise)
  • category (required, 400 Bad Request is returned otherwise)
  • languageIds – when the file category depends on a list of languages
  • languageCombinationIds – when the file category depends on a list of language combinations

• jobsSmartV2.addFiles

  Adds files to the project as delivered in the job. The files have to be uploaded beforehand (see "POST /jobs/{jobId}/files/upload" operation). The following properties can be specified for each file:

  • category (required, 400 Bad Request is returned otherwise)
  • languageIds – when the file category depends on a list of languages
  • languageCombinationIds – when the file category depends on a list of language combinations

• jobsSmartV2.assignVendor1

  Assigns vendor to a job in a project.

• jobsSmartV2.changeDates

  Updates dates of a given job.

• jobsSmartV2.changeStatus1

  Changes job status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:

  • OPEN – available when the job has one of the following statuses: ACCEPTED, CANCELED
  • ACCEPTED – available when the job has one of the following statuses: OPEN (Vendor and dates have to be set before calling the operation), STARTED
  • STARTED – available when the job has one of the following statuses: ACCEPTED, READY
  • READY – available when the job has one of the following statuses: STARTED
  • CANCELLED – available when the job has one of the following statuses: OPEN, ACCEPTED, STARTED, OFFERS_SENT
  • OFFERS_SENT – not available as a target status for this operation

• jobsSmartV2.getByExternalId

  GET /v2/jobs/for-external-id

• jobsSmartV2.getDeliveredFiles

  Returns list of files delivered in the job.

• jobsSmartV2.getFileById1

  Returns details for a job.

• jobsSmartV2.getSharedReferenceFiles

  Returns list of files shared with the job as Reference Files.

• jobsSmartV2.getSharedWorkFiles

  Returns list of files shared with the job as Work Files.

• jobsSmartV2.shareAsReferenceFiles

  Shares selected files as Reference Files with a job in a project. The files and the job have to be part of the same project. The operation is finished successfully even if some of the selected files were already shared with the job. If a file was shared with the job as Work File, it will now be shared as Reference File (and not as Work File).

• jobsSmartV2.shareAsWorkFiles

  Shares selected files as Work Files with a job in a project. The files and the job have to be part of the same project. The operation is finished successfully even if some of the selected files were already shared with the job. If a file was shared with the job as Reference File, it will now be shared as Work File (and not as Reference File).

• jobsSmartV2.stopSharing

  Stops sharing selected files with a job in a project. The files and the job have to be part of the same project. The operation is finished successfully even if some of the selected files were not shared with the job.

• jobsSmartV2.updateInstructions4

  Updates instructions for a job. See also "PUT /projects/{projectId}/vendorInstructions" and "PUT /quotes/{quoteId}/vendorInstructions" for updating instructions for all jobs in a project or quote.

• jobsSmartV2.uploadFile1

  Uploads file to the project as a file delivered in the job. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see "PUT /jobs/{jobId}/files/add" operation).

• license.getLicense

  Returns license content.

• license.refresh

  Refreshes license content. This method returns OK immediately and license is refreshed asynchronously. It takes a while (usually a few seconds) for the license to be actually refreshed.

• macros.run

  Runs a specified macro on a specified list of items ("list" variable in the macro code). The list of items can be empty if the macro doesn't use it. Additional custom parameters can be provided to the macro when necessary ("params" variable in the macro code).

  
  Note: Macros that support parameters can be also run from GUI (Views in Home Portal),so they should also handle the empty parameters map (e.g. by defining default values when parameters are not provided).

• projectsClassic.create5

  Creates a new Classic Project. If the specified service ID refers to Smart Project, 400 Bad Request is returned instead.

• projectsClassic.createLanguageCombination

  Creates a new language combination for a given project without creating a task.

• projectsClassic.createPayable

  Adds a payable to a project.

• projectsClassic.createReceivable

  Adds a receivable to a project.

• projectsClassic.createTask

  Creates a new task for a given project.

  Required fields:

  • languageCombination
  • specializationId
  • workflowId
• projectsClassic.delete12

  Removes a project.

• projectsClassic.deletePayable

  Deletes a payable.

• projectsClassic.deleteReceivable

  Deletes a receivable.

• projectsClassic.getAllIds6

  Returns projects' internal identifiers.

• projectsClassic.getById7

  Returns project details. If the specified project ID refers to Smart Project, 400 Bad Request is returned instead.

• projectsClassic.getContacts

  Returns contacts of a given project.

• projectsClassic.getCustomFields5

  Returns custom fields of a given project.

• projectsClassic.getDates1

  Returns dates of a given project.

• projectsClassic.getFileById

  Downloads a file.

• projectsClassic.getFinance

  Returns finance of a given project.

• projectsClassic.getInstructions

  Returns instructions of a given project.

• projectsClassic.updateContacts

  Updates contacts of a given project.

• projectsClassic.updateCustomFields3

  Updates custom fields of a given project.

• projectsClassic.updateDates1

  Updates dates of a given project.

• projectsClassic.updateInstructions1

  Updates instructions of a given project.

• projectsClassic.updatePayable

  Updates a payable.

• projectsClassic.updateReceivable

  Updates a receivable.

• projectsSmartV2.addExternalFileLinks

  POST /v2/projects/{projectId}/files/addExternalLink

• projectsSmartV2.addFileLinks1

  Adds file links to the project as added by PM. The following properties can be specified for each file link:

  • url (required, 400 Bad Request is returned otherwise)
  • category (required, 400 Bad Request is returned otherwise)
  • languageIds – when the file category depends on a list of languages
  • languageCombinationIds – when the file category depends on a list of language combinations

• projectsSmartV2.addFiles1

  Adds files to the project as added by PM. The files have to be uploaded beforehand (see "POST /v2/projects/{projectId}/files/upload" operation). The following properties can be specified for each file:

  • category (required, 400 Bad Request is returned otherwise)
  • languageIds – when the file category depends on a list of languages
  • languageCombinationIds – when the file category depends on a list of language combinations

• projectsSmartV2.addJobToProcess

  Returns process id.

• projectsSmartV2.archive

  Prepares a ZIP archive that contains the specified files.

• projectsSmartV2.changeStatus2

  Changes project status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:

  • CANCELLED – available when the job has one of the following statuses: OPEN, STARTED

• projectsSmartV2.create6

  Creates a new Smart Project. If the specified service ID refers to Classic Project, 400 Bad Request is returned instead.

• projectsSmartV2.createPayable2

  Adds a payable to a project.

• projectsSmartV2.createReceivable2

  Adds a receivable to a project.

• projectsSmartV2.deletePayable2

  Deletes a payable.

• projectsSmartV2.deleteReceivable2

  Deletes a receivable.

• projectsSmartV2.getByExternalId1

  Returns project details.

• projectsSmartV2.getById9

  Returns project details. If the specified project ID refers to Classic Project, 400 Bad Request is returned instead.

• projectsSmartV2.getCatToolProjectInfo

  Returns if cat tool project is created or queued.

• projectsSmartV2.getContacts2

  Returns Client Contacts information for a project

• projectsSmartV2.getCustomFields8

  Returns a list of custom field keys and values for a project.

• projectsSmartV2.getDeliverableFiles

  Returns list of files in a project, that are ready to be delivered to client. A file is considered deliverable to client when all of the following criteria are met:

  • the file was added to a job in the last step in the process
  • the file is marked as verified (if it was added in a verification step and the file is verifiable, according to its category)
  • the job is finished (has Ready status)

• projectsSmartV2.getFileById2

  Returns details of a file.

• projectsSmartV2.getFileContentById

  Downloads a file content.

• projectsSmartV2.getFiles

  Returns list of files in a project. Only files added to the project (i.e. files that have assigned category and languages) are listed.

• projectsSmartV2.getFinance2

  Returns finance information for a project.

• projectsSmartV2.getJobs

  Returns list of jobs in a project.

• projectsSmartV2.getProcessId

  Returns process id.

• projectsSmartV2.updateClientDeadline

  Updates Client Deadline for a project.

• projectsSmartV2.updateClientNotes

  Updates Client Notes for a project.

• projectsSmartV2.updateClientReferenceNumber

  Updates Client Reference Number for a project.

• projectsSmartV2.updateContacts2

  Updates Client Contacts for a project.

• projectsSmartV2.updateCustomField2

  Updates a custom field with a specified key in a project

• projectsSmartV2.updateInternalNotes

  Updates Internal Notes for a project.

• projectsSmartV2.updateOrderedOn

  Updates Order Date for a project.

• projectsSmartV2.updatePayable2

  Updates a payable.

• projectsSmartV2.updateReceivable2

  Updates a receivable.

• projectsSmartV2.updateSourceLanguage

  Updates source language for a project.

• projectsSmartV2.updateSpecialization

  Updates specialization for a project.

• projectsSmartV2.updateTargetLanguages

  Updates target languages for a project.

• projectsSmartV2.updateVendorInstructions

  Updates instructions for all vendors performing the jobs in a project. See also "PUT /jobs/{jobId}/instructions" for updating instructions for a specific job in a project or quote.

• projectsSmartV2.updateVolume

  Updates volume for a project.

• projectsSmartV2.uploadFile2

  Uploads file to the project as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see "PUT /v2/projects/{projectId}/files/add" operation

• quotesClassic.createLanguageCombination1

  Creates a new language combination for a given quote without creating a task.

• quotesClassic.createPayable1

  Adds a payable.

• quotesClassic.createReceivable1

  Adds a receivable.

• quotesClassic.createTask1

  Creates a new task for a given quote. Required fields are presented in the example.

• quotesClassic.delete13

  Removes a quote.

• quotesClassic.deletePayable1

  Deletes a payable.

• quotesClassic.deleteReceivable1

  Deletes a receivable.

• quotesClassic.getAllIds7

  Returns quotes' internal identifiers.

• quotesClassic.getById8

  Returns quote details. If the specified quote ID refers to Smart Quote, 400 Bad Request is returned instead.

• quotesClassic.getCustomFields6

  Returns custom fields of a given quote.

• quotesClassic.getDates2

  Returns dates of a given quote.

• quotesClassic.getFinance1

  Returns finance of a given quote.

• quotesClassic.getInstructions1

  Returns instructions of a given quote.

• quotesClassic.send1

  Sends a quote for customer confirmation. Quote status is changed to SENT and a document is sent to the customer.

• quotesClassic.start

  Starts a quote.

• quotesClassic.updateCustomFields4

  Updates custom fields of a given quote.

• quotesClassic.updateInstructions2

  Updates instructions of a given quote.

• quotesClassic.updatePayable1

  Updates a payable.

• quotesClassic.updateReceivable1

  Updates a receivable.

• quotesSmartV2.addFiles2

  Adds files to the quote as added by PM. The files have to be uploaded beforehand (see "POST v2/quotes/{quoteId}/files/upload" operation). The following properties can be specified for each file:

  • category (required, 400 Bad Request is returned otherwise)
  • languageIds – when the file category depends on a list of languages
  • languageCombinationIds – when the file category depends on a list of language combinations

• quotesSmartV2.archive1

  Prepares a ZIP archive that contains the specified files.

• quotesSmartV2.changeStatus3

  Changes quote status if possible (400 Bad Request is returned otherwise). The status has to be specified using one of the following keys:

  • PENDING – available when the job has one of the following statuses: REQUESTED, REJECTED
  • SENT – available when the job has one of the following statuses: PENDING
  • APPROVED – available when the job has one of the following statuses: REQUESTED, PENDING, SENT, APPROVED_BY_CLIENT
  • REJECTED – available when the job has one of the following statuses: REQUESTED, PENDING, SENT

• quotesSmartV2.create7

  Creates a new Smart Quote. If the specified service ID refers to Classic Quote, 400 Bad Request is returned instead.

• quotesSmartV2.createPayable3

  Adds a payable to a quote.

• quotesSmartV2.createReceivable3

  Adds a receivable to a quote.

• quotesSmartV2.deletePayable3

  Deletes a payable.

• quotesSmartV2.deleteReceivable3

  Deletes a receivable.

• quotesSmartV2.getById10

  Returns quote details. If the specified quote ID refers to Classic Quote, 400 Bad Request is returned instead.

• quotesSmartV2.getContacts3

  Returns Client Contacts information for a quote.

• quotesSmartV2.getCustomFields9

  Returns a list of custom field keys and values for a project.

• quotesSmartV2.getFileById3

  Returns details of a file.

• quotesSmartV2.getFileContentById1

  Downloads a file content.

• quotesSmartV2.getFiles1

  Returns list of files in a quote. Only files added to the quote (i.e. files that have assigned category and languages) are listed.

• quotesSmartV2.getFinance3

  Returns finance information for a quote.

• quotesSmartV2.getJobs1

  Returns list of jobs in a quote.

• quotesSmartV2.updateBusinessDays

  Updates Business Days for a quote.

• quotesSmartV2.updateClientNotes1

  Updates Client Notes for a quote.

• quotesSmartV2.updateClientReferenceNumber1

  Updates Client Reference Number for a quote.

• quotesSmartV2.updateContacts3

  Updates Client Contacts for a quote.

• quotesSmartV2.updateCustomField3

  Updates a custom field with a specified key in a quote.

• quotesSmartV2.updateExpectedDeliveryDate

  Updates Expected Delivery Date for a quote.

• quotesSmartV2.updateInternalNotes1

  Updates Internal Notes for a quote.

• quotesSmartV2.updatePayable3

  Updates a payable.

• quotesSmartV2.updateQuoteExpiry

  Updates Quote Expiry Date for a quote.

• quotesSmartV2.updateReceivable3

  Updates a receivable.

• quotesSmartV2.updateSourceLanguage1

  Updates source language for a quote.

• quotesSmartV2.updateSpecialization1

  Updates specialization for a quote.

• quotesSmartV2.updateTargetLanguages1

  Updates target languages for a quote.

• quotesSmartV2.updateVendorInstructions1

  Updates instructions for all vendors performing the jobs in a quote. See also "PUT /jobs/{jobId}/instructions" for updating instructions for a specific job in a project or quote.

• quotesSmartV2.updateVolume1

  Updates volume for a quote.

• quotesSmartV2.uploadFile3

  Uploads file to the quote as a file uploaded by PM. Only one file can be uploaded at once. When the upload is finished the file has to be added by specifying its category and languages (see "PUT /v2/quotes/{quoteId}/files/add" operation).

• reports.delete11

  Removes a report.

• reports.duplicate1

  Duplicates a report.

• reports.exportToXml

  Exports reports definition to XML.

• reports.generateCsv

  Generates CSV content for a report.

• reports.generatePrinterFriendly

  Generates printer friendly content for a report.

• reports.importFromXml

  Imports a report definition from an XML using a file token. To obtain the token, you first need to upload a temporary XML file, as specified in the Files section. Note that the name of the imported report must be unique.

• reports.setPreferred

  Marks report as preferred or not.

• subscription.areHooksSupported

  This method can be used to determine if hooks are supported.

• subscription.getAll4

  Returns all subscriptions. Subscriptions are automatically removed if they do not work (ie. if 404 status is returned). To improve notification reliability one can use this method to check if subscription is still active and re-subscribe if necessary.

• subscription.subscribe

  Subscribe to event. Returns subscription Id.

• subscription.unsubscribe

  Unsubscribe from job status changed event

• tasksClassic.addFile

  Adds files to a given task.

• tasksClassic.delete14

  Removes a task.

• tasksClassic.getContacts1

  Returns contacts of a given task.

• tasksClassic.getCustomFields7

  Returns custom fields of a given task.

• tasksClassic.getDates3

  Returns dates of a given task.

• tasksClassic.getInstructions2

  Returns instructions of a given task.

• tasksClassic.getProgress

  Returns progress of a given task. Progress contains information about task's status (ie. opened or ready) and current phase (ie. translation). Workflow phase is defined as the first one which contains not ready jobs (ie. opened or started). When no such job exists then workflow phase is not included.

• tasksClassic.getTaskFiles

  Returns several lists of files for a given task: input files divided by type, output files, bundles, files per job, preview files.

• tasksClassic.start1

  Starts a task.

• tasksClassic.updateClientTaskPoNumber

  Updates Client Task PO Number of a given task.

• tasksClassic.updateContacts1

  Updates contacts of a given task.

• tasksClassic.updateCustomFields5

  Updates custom fields of a given task.

• tasksClassic.updateDates2

  Updates dates of a given task.

• tasksClassic.updateInstructions3

  Updates instructions of a given task.

• tasksClassic.updateName

  Updates name of a given task.

• users.changePassword

  Sets user's password to a new value.

• users.getAllNamesWithIds1

  Returns list of simple users representations

• users.getById6

  Returns user details.

• users.getCustomField1

  Returns custom field of a given user.

• users.getCustomFields4

  Returns custom fields of a given user.

• users.getMe

  Returns currently signed in user details.

• users.getTimeZone

  Returns time zone preferred by user currently signed in.

• users.update3

  Updates an existing user.

• users.updateCustomField1

  Updates given custom field of a given user.

• users.updateCustomFields2

  Updates custom fields of a given user.

• vendorInvoices.create4

  Creates a new invoice from jobs. Jobs are grouped by provider and currency, therefore multiple invoices can be created.If any of the jobs cannot be invoiced (ie. it is already invoiced) then an error is reported.

• vendorInvoices.createPayment1

  Creates a new payment on the vendor account and assigns the payment to the invoice.

• vendorInvoices.delete6

  Removes a provider invoice.

• vendorInvoices.delete7

  Removes a provider payment.

• vendorInvoices.getAll2

  Lists all vendor invoices in all statuses (including not ready and drafts) that have been updated since a specific date.

• vendorInvoices.getAllIds3

  Returns vendor invoices' internal identifiers.

• vendorInvoices.getById3

  Returns provider invoice details.

• vendorInvoices.getDocument1

  Generates provider invoice document (PDF).

• vendorInvoices.getPayments1

  Returns all payments for the vendor invoice.

• vendorInvoices.send

  Sends a provider invoice.

• vendorInvoices.setStatus

  Changes invoice status to given status.

• vendors.delete10

  Removes a provider.

• vendors.delete8

  Removes a person.

• vendors.delete9

  Removes a provider price list.

• vendors.getAddress1

  Returns address of a given provider.

• vendors.getAllIds4

  Returns persons' internal identifiers.

• vendors.getAllIds5

  Returns providers' internal identifiers.

• vendors.getById4

  Returns person details.

• vendors.getById5

  Returns provider details.

• vendors.getCompetencies

  Returns competencies of a given provider.

• vendors.getContact2

  Returns contact of a given person.

• vendors.getContact3

  Returns contact of a given provider.

• vendors.getCorrespondenceAddress1

  Returns correspondence address of a given provider.

• vendors.getCustomFields2

  Returns custom fields of a given person.

• vendors.getCustomFields3

  Returns custom fields of a given provider.

• vendors.sendInvitations

  Sends invitation to Vendor Portal.

• vendors.sendInvitations1

  Sends invitations to Vendor Portal.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools