Schemas · wxrks API

AccountDto

`active`	`boolean`
`aiReviewEnabled`	`boolean`
`allowInviteUsers`	`boolean`
`certificates`	Certificate[]
`costsLogfileType`	`stringPRE_ANALYSE` `POST_ANALYSE`
`createDate`	`integer (int64)`
`customProjectCancellationOptionsEnabled`	`boolean`
`customReviewCategorizationEnabled`	`boolean`
`customSubdomain`	`string`
`disabledQualityFilter`	`boolean`
`disabledRateFilter`	`boolean`
`disabledTagFilter`	`boolean`
`emailDomain`	`string`
`logoUrl`	`string`
`name`	`string`
`notifyZendeskEnabled`	`boolean`
`payoneerApiUrl`	`string`
`payoneerAuthUrl`	`string`
`payoneerClientId`	`string`
`payoneerClientSecret`	`string`
`payoneerProgramId`	`string`
`projectAutomationEnabled`	`boolean`
`sendLearntToKanban`	`boolean`
`settings`	Settings
`ssoClientId`	`string`
`ssoClientSecret`	`string`
`ssoDomains`	`map<string, string>`
`ssoUrl`	`string`
`status`	`stringACTIVE` `INACTIVE` `TRIAL`
`stripeId`	`string`
`subdomain`	`string`
`subscriptionId`	`string`
`type`	`stringCLI` `PERSONAL` `BUSINESS` `ENTERPRISE` `OTHER`
`useCustomReviewCategoriesOnly`	`boolean`
`uuid`	`string (uuid)`

AIInstructions

Domain, audience, tone and other guidance for the translation.

`audience`	`string`
`creativity`	`string`
`domain`	`string`
`formality`	`string`
`guideline`	`string`
`tone`	`string`
`userPrompt`	`string`

AnalysisConfigDto

`analyzeByLanguage`	`boolean`
`analyzeByProvider`	`boolean`
`calculateMachineTranslationReuse`	`boolean`
`calculateNonTranslatableReuse`	`boolean`
`calculateTranslationMemoryReuse`	`boolean`
`id`	`string (uuid)`
`ignoreConfirmedSegments`	`boolean`
`ignoreLockedSegments`	`boolean`
`ignoreNumbers`	`boolean`
`includeNetRate`	`boolean`

AnalysisItemByFileDto

`analysisTotals`	AnalysisTotalsDto[]
`fileName`	`string`
`sourceLocale`	`string`
`targetLocale`	`string`
`uuidFromWorkUnitId`	`string (uuid)`
`workUnitId`	`string`

AnalysisItemByLangPairDto

`analysisTotals`	AnalysisTotalsDto[]
`sourceLocale`	`string`
`targetLocale`	`string`

AnalysisTotalsDto

`analysisItemType`	`stringALL` `TM_MATCH` `CS_MATCH` `REPETITION` `MT_MATCH` `NON_TRANSLATABLE` `CONFIDENCE_CONFIRMED`
`isMissingMatch`	`boolean`
`match`	`number (double)`
`matchEnd`	`number (double)`
`matchLabel`	`string`
`matchOrZeroIfNull`	`number (double)`
`netChars`	`number (double)`
`netRateFactor`	`number (double)`
`netSegments`	`number (double)`
`netWords`	`number (double)`
`totalChars`	`number (double)`
`totalSegments`	`number (double)`
`totalWords`	`number (double)`

ApiLoginDto

`accessKey`	`string`
`secret`	`string`

AsyncRequestDto

`data`	`object`
`error`	`object`
`id`	`string`
`status`	`stringNEW` `RUNNING` `ERROR` `WARN` `DONE`

BulkAssignTask

`taskUuids`	`string (uuid)[]` The tasks to assign.
`tasksUuids`deprecated	`string (uuid)[]` Same as `taskUuids`. The misspelled name stays until the next API version.
`userUuid`	`string (uuid)`

BulkCreateWorkUnit

`accountUuid`	`string (uuid)`
`documentUuid`	`string (uuid)`
`entityWorkflows`	Workflow[]
`messageUuid`	`string (uuid)`
`projectResourceUuid`	`string (uuid)`
`targetLocales`	`string[]`
`workUnitAutomation`	`boolean`
`workflowSequences`	`map<string, integer>`
`workflows`	`string[]`

BulkImportKitRequest

`applyStatusFromFile`	`boolean` XLIFF only: apply each unit's `bwx:locked`, `bwx:confirmed` and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without `bwx:confirmed` follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit.
`confirmAllNotEmpty`	`boolean` Confirm every segment with a non-empty target, changed or not.
`confirmOnlyChangeSegments`	`boolean` Write only the segments whose text changed, and confirm them.
`importType`required	`stringXLIFF` `XLSX` Format of the imported file.
`updateTm`	`boolean` Add the confirmed segments this import writes to the project's translation memories.
`workUnitUuids`	`string (uuid)[]` Import only the files of these work units. Leave empty to import every file in the kit. A vendor always imports into their own assigned work units, whatever this list says.

BwxFontMappings

`sourceFonts`	`string[]`
`sourceLocale`	`string`
`targetFont`	`string`
`targetLocale`	`string`
`uuid`	`string (uuid)`

CacheProgress

`current`	`integer`
`fixedSegments`	`integer`
`key`	`string`
`remainingSegments`	`integer`
`skippedSegments`	`integer`
`status`	`string`
`total`	`integer`
`unfixedSegments`	`integer[]`
`url`	`string`

Certificate

`arn`	`string`
`certificate`	`string`
`chain`	`string`
`domain`	`string`
`key`	`string`
`metadata`	`map<string, object>`

CheckDuplicatedTermsRequest

`glossaryIds`required	`integer (int64)[]` Ids (`bwGlossaryId`) of the glossaries to check. Each must be readable by the caller.
`sourceLanguage`required	`string`
`sourceTerm`required	`string`
`targetLanguage`required	`string`
`targetTerm`required	`string`
`taskUuids`	`string (uuid)[]` Tasks that give a vendor access to their projects' glossaries.

ClientAddressDto

`additionalInfo`	`string`
`city`	`string`
`neighborhood`	`string`
`number`	`string`
`state`	`string`
`street`	`string`
`zip`	`string`

ClientCreateDtoV3

`addLoggedUserToClient`	`boolean`
`contactPersonUuid`	`string (uuid)`
`country`	`string`
`currency`	`string`
`name`	`string`
`organizationUuid`	`string (uuid)`
`timezone`	`string`

ClientDto

`externalId`	`string`
`id`	`string (uuid)`
`name`	`string`

ClientIdNameDto

The org unit of orgUnitUuid, filled in by wxrks on reads.

`id`	`integer (int64)`
`name`	`string`
`sourceLanguage`	`string`
`targetLanguage`	`string[]`
`uuid`	`string (uuid)`

ClientTaxInfoDto

`issueNfe`	`boolean`
`municipalRegistration`	`string`
`requirePurchaseOrder`	`boolean`
`retainIr`	`boolean`
`retainIss`	`boolean`
`simplesNacional`	`boolean`

ClientTmSettingsDto

`atlasTmId`	`integer (int64)`
`client`	OrganizationalUnitDto
`createdBy`	UserRef
`creationDate`	`integer (int64)`
`defaultThreshold`	`number (double)`
`fixPreTranslateMismatchTags`	`boolean`
`fixSuggestionMismatchTags`	`boolean`
`fixTags`	`boolean`
`isDefault`	`boolean`
`name`	`string`
`penalty`	`number (double)`
`read`	`boolean`
`settings`	Settings
`sourceLocale`	`string`
`targetLocales`	`string[]`
`tmUuid`	`string (uuid)`
`uuid`	`string (uuid)`
`write`	`boolean`

CodeUomSpan

`end`	`integer`
`start`	`integer`
`type`	`string`
`value`	`string`

ConceptDTO

`id`	`integer (int64)`
`writable`	`boolean`

ConceptEntryDtoV3

`createdDate`	`integer (int64)`
`definition`	`string`
`id`	`integer (int64)`
`note`	`string`
`terms`	TermEntryDto[]
`uuid`	`string (uuid)`

ConfigOrgUnitsDto

`country`	`string`
`defaultContactPerson`	UserRef
`fileParams`	ResourceFileParamsDto[]
`glossaryList`	GlossaryDto[]
`id`	`integer (int64)`
`instructions`	`string`
`name`	`string`
`organizationUuid`	`string (uuid)`
`priceList`	PriceListDto
`resourceUuids`	`string (uuid)[]`
`targetLanguages`	`string[]`
`tmList`	ClientTmSettingsDto[]
`tmSettings`	MultiConfigTmSettingsDto[]
`uuid`	`string (uuid)`
`workflows`	`string[]`

ContinuousFileUploadDto

`file`	`string (binary)`
`locales`	`string[]`
`path`	`string`
`reference`	`string`
`source`	`string`
`tags`	`string[]`
`workflows`	`string[]`

ContinuousProject

`ciTag`	`string`
`contactUUID`	`string (uuid)`
`contentMode`	`stringFILES` `KEY_VALUE`
`instructions`	`string`
`notes`	`string`
`orgUnitUUID`	`string (uuid)`
`reference`	`string`
`source`	`string`
`tags`	`string[]`
`totalExpectedWorkUnits`	`integer`

CostDto

`costPerUnit`	`number`
`costType`	`stringTRANSLATIONS` `FILE_ENGINEERING` `QA` `NONE`
`costsLogfileId`	`string (uuid)`
`creationTimestamp`	`integer (int64)`
`description`	`string`
`displayOrder`	`integer`
`filename`	`string`
`id`	`integer (int64)`
`matchEnd`	`integer`
`matchStart`	`integer`
`noPriceList`	`boolean`
`rateType`	`stringPERCENTAGE` `NOMINAL`
`reason`	`string`
`sourceLanguage`	`string`
`targetLanguage`	`string`
`total`	`number (double)`
`unitType`	`stringWORD` `PAGE` `MINUTE` `HOUR` `DAY` `FEE` `DISCOUNT`
`units`	`number`
`uuid`	`string (uuid)`

CostInfoDto

`amount`	`number (double)`
`calculatedCost`	`number (double)`
`costType`	`string`
`costUnitType`	`string`
`costValue`	`number (double)`
`description`	`string`
`minimumFee`	`number`
`noPriceList`	`boolean`
`reason`	`string`
`uuid`	`string (uuid)`

CostsDto

`langPairCosts`	LangPairCostDto[]
`totalCost`	`number`

CreatedPayable

`currency`	`string`
`dueDate`	`integer (int64)`
`index`	`integer`
`name`	`string`
`payableAmount`	`number (double)`
`uuid`	`string (uuid)`

CreateLogfileRequest

`allWorkUnitsAtLevel`	`integer` Analyse every work unit at this workflow level.
`calculateMachineTranslationReuse`	`boolean`
`calculateNonTranslatableReuse`	`boolean`
`calculateTranslationMemoryReuse`	`boolean`
`classifyConfidenceApproved`	`boolean`
`confidenceOverRepetition`	`boolean` Defaults to the project's setting.
`countWordsFrom`	`stringSOURCE` `TARGET` Defaults to `SOURCE`.
`ignoreConfirmedSegments`	`boolean`
`ignoreLockedSegments`	`boolean`
`ignoreNumbers`	`boolean`
`maxSegmentTimestamp`	`integer (int64)` Only segments changed up to this time (epoch milliseconds) count.
`name`	`string` Name of the logfile.
`ntOverRepetition`	`boolean` Defaults to the project's setting.
`taskIds`	`string (uuid)[]` Tasks to analyse.
`taskUuids`	`string (uuid)[]`
`tmOverRepetition`	`boolean` Defaults to the project's setting.
`type`required	`stringPRE_ANALYSE` `POST_ANALYSE` `COMPARE`
`workUnitIds`	`string (uuid)[]` Work units to analyse. Without work units, tasks or `allWorkUnitsAtLevel`, every work unit of the project.
`workflow`	`string`

CreateProjectDto

`assigneeUUID`	`string (uuid)`
`contactUUID`	`string (uuid)`
`contentMode`	`stringFILES` `KEY_VALUE`
`creatorUUID`	`string (uuid)`
`currency`	`string`
`isContinuous`	`boolean`
`notes`	`string`
`orgUnitUUID`	`string (uuid)`
`reference`	`string`
`sourceLocale`	`string`
`tags`	`string[]`
`timezone`	`string`

CreateProjectResourceDto

`name`	`string`
`notes`	`string`
`path`	`string`
`previewUrl`	`string`
`tags`	`string`
`targetLocales`	`string[]`

CreateReceivableRequest

`contactUser`required	ReceivableUuidRef
`currency`required	`string`
`customReceivableByUser`	`boolean`
`dueDate`required	`integer (int64)` Due date of the first installment, epoch milliseconds.
`equally`	`boolean` Split the amount equally between installments. Defaults to true.
`firstInstallmentValue`	`number (double)` Amount of the first installment when the split is not equal.
`intervalBetweenDues`	`integer` Days between installment due dates. Defaults to 30.
`invoiceFirstOnly`	`boolean` Invoice the first installment only. Defaults to false.
`manualInvoice`	`boolean`
`multipleInstallments`	`boolean` Defaults to false.
`numInstallments`	`integer` With `multipleInstallments`. Defaults to 1.
`organizationalUnit`required	ReceivableUuidRef
`projects`	ReceivableProjectRef[]
`purchaseOrder`	`string`
`taxes`	ReceivableTaxRef[]

CreateUserRequest

`address`	`string`
`address2`	`string`
`avatar`	`string`
`cellPhone`	`string`
`city`	`string`
`companyName`	`string`
`country`	`string`
`currency`	`string`
`dailyRate`	`number`
`defaultWorkflowRates`	`map<string, object>[]`
`email`required	`string`
`entryPoint`	`stringWORKS_HOME` `PORTAL_HOME`
`externalId`	`string`
`hourlyRate`	`number`
`invoicingDayOfMonth`	`stringDAY_15` `DAY_30`
`invoicingPeriodicity`	`integer`
`minimumFee`	`number`
`name`required	`string`
`notes`	`string`
`notifyUser`	`boolean` Email the new user their access. Defaults to true.
`orgUnits`	UserAssociationRef[]
`organizations`required	UserAssociationRef[]
`pagesRate`	`number`
`paymentMethod`	`stringPAYONEER` `PAYPAL` `BANK` `QUICKBOOKS`
`payoneerId`	`string`
`paypalAccount`	`string`
`phone`	`string`
`postalCode`	`string`
`roles`	`string[]` Roles to grant. You can only grant roles you are allowed to manage; `USER` is always granted.
`skypeId`	`string`
`slackHandle`	`string`
`state`	`string`
`status`	`stringActive` `Inactive` `Disabled` The user's status. Read ignoring case. New users default to Active.
`supportedLanguagePairs`	UserLanguagePairRef[]
`tags`	`string[]`
`targetAccountUuid`	`string (uuid)` wxrks staff only: the account to create the user in. Ignored for anyone else.
`taxId`	`string`
`taxpayerId`	`string`
`timezone`	`string`
`uuid`	`string (uuid)` Leave it out to create a user. The uuid of an existing user updates that user.
`wordRate`	`number`

CurrencyRateDto

`rate`	`number (double)`
`sourceCurrency`	`string`
`targetCurrency`	`string`
`unsupportedByDefault`	`boolean`

CurrencySummaryDto

`convertedValue`	`number`
`originalValue`	`number`
`percentage`	`number`

CustomFieldDto

`entities`	`string[]`
`entity`	`string`
`entityCode`	`stringDEFAULT` `PROJECT` `TASK` `USER` `ORGANIZATION` `ORG_UNIT` `GLOSSARY` `PAYABLE` `INVOICE` `TRANSLATION_MEMORY`
`multivalueDefault`	`string[]`
`name`	`string`
`sameNameEntities`	`string[]`
`scope`	CustomFieldScope
`scopeNames`	`map<string, string>`
`type`	`stringBOOL` `TEXT` `NUMERIC` `MULTIVALUE` `FREE_TEXT`
`uuid`	`string (uuid)`
`value`	`string`
`values`	`string[]`

CustomFieldScope

`entityExcludedUsers`	`string (uuid)[]`
`entityGlossaries`	`string (uuid)[]`
`entityMemories`	`string (uuid)[]`
`entityOrgUnitMembers`	`string (uuid)[]`
`entityOrgUnits`	`string (uuid)[]`
`entityOrganizations`	`string (uuid)[]`
`entityUserRoles`	`string[]`
`fillExcludedUsers`	`string (uuid)[]`
`fillOrgUnits`	`string (uuid)[]`
`fillRoles`	`string[]`
`recordOrgUnits`	`string (uuid)[]`
`recordTypes`	`string[]`
`viewExcludedUsers`	`string (uuid)[]`
`viewOrgUnits`	`string (uuid)[]`
`viewRoles`	`string[]`

DownloadFiltersDto

`dataTransformationParamsMap`	`string`
`filenames`	`string[]`
`locales`	`string[]`
`projectStatus`	`stringDELETED` `CANCELLED` `DRAFT` `PENDING` `APPROVED` `DELIVERED` `INVOICED` `PARTIALLY_INVOICED` `NOT_INVOICED` `CONTINUOUS`
`resources`	`string (uuid)[]`
`retrieveLatestDeliveredWorkflow`	`boolean`
`updateDataTransformation`	`boolean`

DownloadTranslatedFiles

`downloadUrl`	`string`
`error`	`string`
`requestUuid`	`string (uuid)`
`status`	`string`

EloquaConfig

`accountUuid`	`string (uuid)` The account of the org unit, set by wxrks.
`active`	`boolean`
`companyName`	`string`
`defaultWorkflows`	`string[]`
`name`	`string`
`orgUnit`	ClientIdNameDto
`orgUnitUuid`	`string (uuid)`
`password`	`string`
`username`	`string`
`uuid`	`string (uuid)`

EntityTaxDto

`calculationType`	`stringINCREASE` `DECREASE`
`enabled`	`boolean`
`entityType`	`stringUSER` `ORG_UNIT`
`entityUuid`	`string (uuid)`
`name`	`string`
`taxUuid`	`string (uuid)`
`type`	`string`
`uuid`	`string (uuid)`
`value`	`number`

FatClientDto

`accountCode`	`string`
`accountUuid`	`string (uuid)`
`address`	ClientAddressDto
`aiReviewEnabled`	`boolean`
`autoBilling`	`boolean`
`autopilotEnabled`	`boolean`
`billingEmail`	`string`
`categorizationDisabled`	`boolean`
`clientLanguages`	`string`
`confidenceMatchOverRepetitionEnabled`	`boolean`
`consolidateProjects`	`boolean`
`contactNotes`	`string`
`contactPerson`	UserRef
`contactPersonEmailNotifications`	`boolean`
`continuousPlatformTag`	`string`
`continuousProjectConfig`	`string`
`continuousSealed`	`boolean`
`contract`	`boolean`
`contractEndDate`	`integer (int64)`
`contractStartDate`	`integer (int64)`
`costsLogfileType`	`stringPRE_ANALYSE` `POST_ANALYSE`
`country`	`string`
`currency`	`string`
`customFields`	`map<string, object>[]`
`customReceivableByUser`	`boolean`
`daysUntilPaymentDue`	`integer (int64)`
`defaultProjectManager`	UserRef
`defaultSourceLanguage`	`string`
`disableMachineTranslate`	`boolean`
`disabledQualityFilter`	`boolean`
`disabledRateFilter`	`boolean`
`disabledTagFilter`	`boolean`
`emails`	`string[]`
`externalId`	`string`
`id`	`integer (int64)`
`ignoreTranslationMemories`	`boolean`
`instructions`	`string`
`invoiceGroupingKey`	`string`
`invoiceInfo`	`string`
`invoicingType`	`string`
`isClientTerminology`	`boolean`
`isolatedTags`	`boolean`
`localeRegion`	`map<string, string>`
`logo`	`string`
`memo`	`string`
`mobile`	`string`
`mtSettings`	MtSettingsDto
`name`	`string`
`netRateSettings`	NetRateSettingsDto
`notes`	`string`
`notifyProjectComments`	`boolean`
`notifyZendeskEnabled`	`boolean`
`ntMatchOverRepetitionEnabled`	`boolean`
`organization`	OrganizationDto
`overrideDefaultRegex`	`boolean`
`paymentMethod`	`stringCHECK` `PAYPAL` `CREDITCARD` `DEPOSIT` `WIRE` `ACH` `BANKING_TICKET`
`phone`	`string`
`projectAutomationEnabled`	`boolean`
`projectCountWordsFrom`	`stringSOURCE` `TARGET`
`projectManagerEmailNotifications`	`boolean`
`quickBooksId`	`string`
`quickBooksProductServiceId`	`string`
`quoteNotes`	QuoteNotes[]
`regex`	`string`
`sendAvailableTasksEmail`	`boolean`
`sendInvoiceToRequester`	`boolean`
`sendLearntToKanban`	`boolean`
`sendQuoteAuto`	`boolean`
`sendReceivableEmailNotification`	`boolean`
`settings`	Settings
`showPaymentPolicy`	`boolean`
`showRequester`	`boolean`
`splitLargeJobs`	`boolean`
`status`	`string`
`tags`	`string[]`
`taskCountWordsFrom`	`stringSOURCE` `TARGET`
`taskPaymentType`	`stringWORD` `HOUR`
`taxInfo`	ClientTaxInfoDto
`taxpayerId`	`string`
`timezone`	`string`
`tmMatchOverRepetitionEnabled`	`boolean`
`trackingCategory`	`string`
`trackingCategoryType`	`string`
`uuid`	`string (uuid)`
`vendorEmailNotifications`	`boolean`
`webhookEnabled`	`boolean`
`website`	`string`
`xeroId`	`string`
`zendeskUrl`	`string`
`zendeskUser`	`string`

FileParams

`applyAll`	`boolean`
`applySourceSegmentation`	`boolean`
`defaultFilter`	`string`
`defaultFilterScope`	`stringORG_UNIT` `ACCOUNT`
`defaultFilterSettings`	`boolean`
`extensionFile`	`string`
`extractTerms`	`boolean`
`parameters`	`map<string, object>`
`parserFilter`	`string`
`projectResourceId`	`string (uuid)`
`segmentationFileUrl`	`string`
`segmentationParams`	`map<string, object>`
`tagRegex`	`string`
`termsParams`	`map<string, object>`

FileType

`applySourceSegmentation`	`boolean`
`filters`	Filter
`label`	`string`
`parameters`	map<string, Parameter>
`terms`	TermsParams

Filter

`defaultFilter`	`string`
`types`	map<string, Type>

GenesisAnalysisDto

`allWorkUnitsAtLevel`	`integer`
`analysisWorkflow`	`string`
`attempt`	`integer`
`config`	AnalysisConfigDto
`countWordsFrom`	`stringSOURCE` `TARGET`
`creationDate`	`integer (int64)`
`failureReason`	`string`
`fileContent`	`string (byte)[]`
`finishedDate`	`integer (int64)`
`id`	`string (uuid)`
`isCostLogFile`	`boolean`
`isTaskPaymentLogFile`	`boolean`
`itemsByFile`	AnalysisItemByFileDto[]
`itemsByLangPair`	AnalysisItemByLangPairDto[]
`name`	`string`
`previousName`	`string` The name the logfile had before its last rename. Empty when it was never renamed.
`progress`	GenesisAnalysisProgressDto
`projectId`	`string (uuid)`
`renamedAt`	`integer (int64)` When the last rename happened, in epoch milliseconds.
`renamedBy`	`string` Who made the last rename.
`startedDate`	`integer (int64)`
`status`	`string`
`targetLocales`	`string[]` The target locales of the analysis.
`targetsLocales`deprecated	`string[]` Same as `targetLocales`. The misspelled name stays until the next API version.
`type`	`stringPRE_ANALYSE` `POST_ANALYSE` `COMPARE`
`workUnitsAtProjectStepLevel`	`integer`
`workflow`	`string`

GenesisAnalysisProgressDto

`currentStep`	`string`
`percentage`	`integer`
`processedSegments`	`integer`
`totalSegments`	`integer`

GenesisAnalysisSummaryDto

`language`	`string`
`totalChars`	`integer (int64)`
`totalSegments`	`integer (int64)`
`totalWords`	`integer (int64)`

GenesisProjectProcessSummaryDto

`count`	`integer`
`status`	`string`

GithubConfig

`accountUuid`	`string (uuid)` The account of the org unit, set by wxrks.
`defaultWorkflows`	`string[]`
`githubToken`	`string`
`githubUrl`	`string`
`githubUser`	`string`
`name`	`string`
`orgUnit`	ClientIdNameDto
`orgUnitUuid`	`string (uuid)`
`uuid`	`string (uuid)`

GlossaryCreateRequest

`customAttributes`	`map<string, object>[]` Each item has `name`, `type` (`SINGLE_VALUE`, `SINGLE_SELECT` or `MULTI_SELECT`), `value` and, for the select types, `options`.
`domain`	`string` Domain name; created in the organization when it doesn't exist.
`languages`required	`string[]` At least two languages.
`name`required	`string`
`note`	`string`
`orgUnits`	GlossaryOrgUnitRef[] Org units the caller must have access to.
`organization`required	GlossaryOrganizationRef
`subDomain`	`string` Subdomain name; created in the organization when it doesn't exist.

GlossaryDto

`allLanguages`	`string[]`
`bwGlossaryId`	`integer (int64)`
`createdBy`	UserDto
`creationDate`	`integer (int64)`
`customAttributes`	`map<string, object>[]`
`customFields`	`map<string, object>[]`
`domain`	`string`
`enabledTerminologyFlow`	`boolean`
`isDefault`	`boolean`
`languages`	`string[]`
`lastImportJob`	GlossaryJobDto
`name`	`string`
`note`	`string`
`orgUnits`	OrganizationalUnitDto[]
`organization`	OrganizationDto
`requiredTermFields`	RequiredTermFields
`subDomain`	`string`
`totalConcepts`	`integer`
`uuid`	`string (uuid)`

GlossaryJobDto

`creationDate`	`integer (int64)`
`endTime`	`integer (int64)`
`failureReason`	`string`
`fileName`	`string`
`glossaryId`	`integer (int64)`
`id`	`integer (int64)`
`jobExecutionId`	`integer (int64)`
`jobName`	`string`
`jobType`	`string`
`processingTime`	`string`
`skippedTermsCount`	`integer`
`startTime`	`integer (int64)`
`status`	`string`
`termsCount`	`integer (int64)`

GlossaryOrganizationRef

The organization that owns the glossary.

uuidrequired string (uuid)

GlossaryOrgUnitSettingsDto

`adaptiveTermInflectionEnabled`	`boolean`
`glossaryUuid`	`string (uuid)`
`isDefault`	`boolean`
`learntTermsDefault`	`boolean`
`orgUnitName`	`string`
`orgUnitUuid`	`string (uuid)`
`uuid`	`string (uuid)`

GlossaryOrgUnitSettingsParams

`orgUnitUuids`	`string (uuid)[]`
`settings`	OrgUnitSettings

GlossaryThinDTO

`allLangs`	`string[]`
`client`	SimpleClientDto
`createdBy`	UserDto
`dateCreated`	`integer (int64)`
`domain`	`string`
`id`	`integer (int64)`
`isDefault`	`boolean`
`langs`	`string[]`
`languagesInfo`	Language[]
`name`	`string`
`note`	`string`
`subDomain`	`string`
`uuid`	`string (uuid)`

GlossaryUpdateRequest

`customAttributes`	`map<string, object>[]` Replaces the stored list; omitted removes them all. Each item has `name`, `type` (`SINGLE_VALUE`, `SINGLE_SELECT` or `MULTI_SELECT`), `value` and, for the select types, `options`.
`domain`	`string` Domain name. Omitted clears it.
`languages`	`string[]` The full list of languages; omitted keeps the stored ones.
`name`	`string` Omitted or blank keeps the stored name.
`note`	`string` Omitted keeps the stored note.
`subDomain`	`string` Subdomain name. Omitted clears it.
`uuid`required	`string (uuid)` The glossary to update.

IdNameDto

`id`	`string (uuid)`
`name`	`string`

ImportKitRequest

`applyStatusFromFile`	`boolean` XLIFF only: apply each unit's `bwx:locked`, `bwx:confirmed` and notes to its segment (lock and unlock, confirm and unconfirm, notes added as comments). A unit without `bwx:confirmed` follows the confirmation flags. Locks change only with the Lock Segments permission on the work unit.
`confirmAllNotEmpty`	`boolean` Confirm every segment with a non-empty target, changed or not.
`confirmOnlyChangeSegments`	`boolean` Write only the segments whose text changed, and confirm them.
`importType`required	`stringXLIFF` `XLSX` Format of the imported file.
`updateTm`	`boolean` Add the confirmed segments this import writes to the project's translation memories.

ImportStatusRequest

importTyperequired

stringXLIFF XLSX

Format of the import to report on.

InstallmentDto

`amount`	`number (double)`
`creationDate`	`integer (int64)`
`currency`	`string`
`discount`	`number (double)`
`dueDate`	`integer (int64)`
`id`	`integer (int64)`
`installmentPayments`	InstallmentPaymentDto[]
`installmentSeq`	`integer (int64)`
`interest`	`number (double)`
`lastUpdateTimestamp`	`integer (int64)`
`paidAmount`	`number (double)`
`paidBy`	`integer (int64)`
`status`	`stringINVOICED` `INVOICED_NFE` `INVOICED_NFE_ERROR` `PARTIALLY_INVOICED` `PARTIALLY_PAID` `PAID` `VOID` `CANCELLED`
`updatedBy`	`integer (int64)`

InstallmentPaymentDto

`amount`	`number (double)`
`currency`	`string`
`discount`	`number (double)`
`id`	`integer (int64)`
`interest`	`number (double)`
`paidBy`	`integer (int64)`
`paymentDate`	`integer (int64)`

Issue

`message`	`string`
`type`	`string`

IssueTotal

`total`	`integer (int64)`
`type`	`string`

ITotalCost

`grossCost`	`number (double)`
`netCost`	`number (double)`
`projectId`	`integer (int64)`
`totalSavings`	`number (double)`

LangPairCostDto

`chargeBy`	`stringWORD` `HOUR`
`minimumFee`	`number`
`sourceLang`	`string`
`targetLang`	`string`
`totalCost`	`number`
`words`	`number (double)`
`wordsPerHour`	`integer`

Language

`code`required	`string`
`id`	`integer (int64)`
`name`required	`string`

LanguagePair

`pair`	`string`
`source`required	`string`
`target`required	`string`
`userRatesByPair`deprecated	`map<string, object>[]`

LogfileDownloadFile

`downloadUrl`	`string`
`progress`	`number (double)`
`requestUuid`	`string (uuid)`
`skippedTargetLocales`	SkippedTargetLocale[]
`status`	`string`

MatchCostDto

`costPerItem`	`number (double)`
`displayOrder`	`integer`
`isManualCost`	`boolean`
`matchType`	`string`
`totalCost`	`number (double)`
`uuid`	`string (uuid)`
`words`	`number (double)`

MatchRangeDto

`end`	`number (double)`
`matchStartOrZero`	`number (double)`
`start`	`number (double)`
`type`	`stringTM` `MATCH101` `REPETITION` `CONFIDENCE_CONFIRMED`
`uuid`	`string (uuid)`

MtSettingsDto

`accountUuid`	`string`
`active`	`boolean`
`credentials`	`string`
`isCredentialValid`	`boolean`
`name`	`string`
`provider`	`string`
`reason`	`string`
`reasonCode`	`string`
`sourceLanguage`	`string`
`targetLanguage`	`string`
`text`	`string`
`translated`	`string`
`type`	`stringDEFAULT` `ACCOUNT`
`updateAt`deprecated	`integer (int64)` Same as `updatedAt`. The misspelled name stays until the next API version.
`updatedAt`	`integer (int64)` When the settings were last saved (Unix time in milliseconds).
`uuid`	`string`

MultiConfigTmSettingsDto

`atlasTmId`	`integer (int64)`
`fixTags`	`boolean`
`id`	`integer (int64)`
`name`	`string`
`penalty`	`number (double)`
`read`	`boolean`
`threshold`	`number (double)`
`write`	`boolean`

MultiProjectConfigDto

`configOrgUnits`	ConfigOrgUnitsDto[]
`name`	`string`
`orgUnits`	`string[]`
`restrictLangPerOrgUnit`	`boolean`
`sourceLanguage`	`string`
`targetLanguages`	`string[]`
`uuid`	`string (uuid)`

MultiProjectCreationParams

`baseProjectUuid`	`string (uuid)`
`projects`	ConfigOrgUnitsDto[]
`reference`	`string`
`sourceLanguage`	`string`

NetRateSettingsDto

`account`	AccountDto
`default`	`boolean`
`defaultGlobal`	`boolean`
`id`	`integer (int64)`
`isFromPriceList`	`boolean`
`matchRanges`	MatchRangeDto[]
`name`	`string`
`netRateWorkflows`	NetRateWorkflowDto[]
`uuid`	`string (uuid)`

NetRateWorkflowDto

`netRateSettingsUUID`	`string (uuid)`
`netRateWorkflowItems`	NetRateWorkflowItemDto[]
`uuid`	`string (uuid)`
`workflow`	`string`

NetRateWorkflowItemDto

`mtFactor`	`number (double)`
`netRateWorkflowUUID`	`string (uuid)`
`ntFactor`	`number (double)`
`range`	MatchRangeDto
`rangeStartOrZero`	`number (double)`
`tmFactor`	`number (double)`
`uuid`	`string (uuid)`

Option

`label`	`string`
`value`	`string`

OrganizationalUnitDto

`costsLogfileType`	`stringPRE_ANALYSE` `POST_ANALYSE`
`country`	`string`
`id`	`integer (int64)`
`localeRegion`	`map<string, string>`
`name`	`string`
`organization`	OrganizationDto
`projectCountWordsFrom`	`stringSOURCE` `TARGET`
`sourceLanguage`	`string`
`targetLanguages`	`string[]`
`uuid`	`string (uuid)`

OrganizationDto

`accountUuid`	`string (uuid)`
`country`	`string`
`customFields`	`map<string, object>[]`
`id`	`integer (int64)`
`logo`	`string`
`mtSettings`	MtSettingsDto
`name`	`string`
`orgUnitDrafts`	OrgUnitCreate[]
`uuid`	`string (uuid)`

OrgUnitCreate

`addLoggedUserToClient`	`boolean`
`contactPersonUuid`	`string (uuid)`
`country`	`string`
`currency`	`string`
`name`	`string`
`organizationUuid`	`string (uuid)`
`timezone`	`string`

OrgUnitSettings

`adaptiveTermInflectionEnabled`	`boolean`
`isDefault`	`boolean`
`learntTermsDefault`	`boolean`

PageableObject

`offset`	`integer (int64)`
`pageNumber`	`integer`
`pageSize`	`integer`
`paged`	`boolean`
`sort`	SortObject
`unpaged`	`boolean`

PageConceptEntryDtoV3

`content`	ConceptEntryDtoV3[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageCustomFieldDto

`content`	CustomFieldDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PagedResponseGenesisAnalysisDto

`content`	GenesisAnalysisDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`offset`	`integer (int64)`
`pageNumber`	`integer`
`pageSize`	`integer`
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PagedResponseProjectSegmentDto

`content`	ProjectSegmentDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`offset`	`integer (int64)`
`pageNumber`	`integer`
`pageSize`	`integer`
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PagedResponseTranslationUnitMatch

`content`	TranslationUnitMatch[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`offset`	`integer (int64)`
`pageNumber`	`integer`
`pageSize`	`integer`
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageFatClientDto

`content`	FatClientDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageGlossaryDto

`content`	GlossaryDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageMultiProjectConfigDto

`content`	MultiProjectConfigDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageOrganizationDto

`content`	OrganizationDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PagePayableDto

`content`	PayableDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PagePriceListDto

`content`	PriceListDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageProjectDto

`content`	ProjectDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageProjectMessageDto

`content`	ProjectMessageDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageReceivableDto

`content`	ReceivableDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageSegmentCommentDto

`content`	SegmentCommentDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageTaskDto

`content`	TaskDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageTermEntryOnSegment

`content`	TermEntryOnSegment[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageTMDto

`content`	TMDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageTranslationKitJobDownloadLinkDto

`content`	TranslationKitJobDownloadLinkDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageUserDto

`content`	UserDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

PageWorkUnitDto

`content`	WorkUnitDto[]
`empty`	`boolean`
`first`	`boolean`
`last`	`boolean`
`number`	`integer`
`numberOfElements`	`integer`
`pageable`	PageableObject
`size`	`integer`
`sort`	SortObject
`totalElements`	`integer (int64)`
`totalPages`	`integer`

Parameter

`dependsOn`	`string`
`description`	`string`
`modeParam`	`string`
`multiple`	`boolean`
`options`	Option[]
`taggable`	`boolean`
`title`	`string`
`type`	`string`
`value`	`string`

ParserParameters

`extensionsMap`	`map<string, string[]>`
`files`	map<string, FileType>
`terms`	TermsParams

PayableBatchItemDto

`currency`	`string`
`dueDate`	`string`
`invoicedAmount`	`number (double)`
`notes`	`string`
`vendorEmail`	`string`

PayableBatchRequestDto

`payables`	PayableBatchItemDto[]
`serviceProviderAccountUuid`	`string (uuid)`
`timezone`	`string`

PayableBatchResultDto

`created`	CreatedPayable[]
`errorCount`	`integer`
`errors`	`map<string, string[]>`
`successCount`	`integer`
`totalRows`	`integer`

PayableDto

`amount`	`number (double)`
`amountBeforeTaxes`	`number (double)`
`creationDate`	`integer (int64)`
`currency`	`string`
`customFields`	`map<string, object>[]`
`dueDate`	`integer (int64)`
`errorMessage`	`string`
`exchangeRateByCurrency`	`map<string, number (double)>`
`id`	`integer (int64)`
`lastUpdate`	`integer (int64)`
`name`	`string`
`notes`	`string`
`oldTasksInvoiced`	`map<string, object>[]`
`origin`	`string`
`overallProfitability`	`number`
`paidBy`	`integer (int64)`
`payableFiles`	`string[]`
`paymentDate`	`integer (int64)`
`payoutMethod`	`string`
`serviceProviderAccountName`	`string`
`serviceProviderAccountUuid`	`string (uuid)`
`status`	`string`
`tasks`	TaskDto[]
`taxes`	PayableTaxDto[]
`taxesAmount`	`number (double)`
`totalAllocations`	`integer`
`totalTasks`	`integer`
`updatedBy`	`integer (int64)`
`uuid`	`string (uuid)`
`vendor`	UserDto
`vendorMonthlyAverage`	`number (double)`
`xeroId`	`string`

PayableImportResultDto

`errorCount`	`integer`
`errorMessage`	`string`
`errors`	`map<string, string[]>`
`status`	`string`
`successCount`	`integer`
`totalRows`	`integer`

PayableRequest

`accountUuid`	`string (uuid)`
`currencyRates`	CurrencyRateDto[]
`dueDate`	`integer (int64)`
`endDate`	`integer (int64)`
`startDate`	`integer (int64)`
`vendorUuidList`	`string (uuid)[]`

PayablesSummaryDto

`separationByCurrency`	map<string, CurrencySummaryDto>
`separationByPaymentMethod`	`map<string, number>`
`total`	`number`
`totalCurrency`	`string`

PayableTaxDto

`id`	`integer (int64)`
`tax`	TaxDto
`total`	`number (double)`

PaymentItem

`amount`	`number`
`confirmationDate`	`integer (int64)`
`confirmedBy`	`string (uuid)`
`costType`	`stringFIXED` `PERCENTAGE`
`createdOnDelivery`	`boolean`
`creationDate`	`integer (int64)`
`rate`	`number`
`rejectDate`	`integer (int64)`
`rejectReason`	`string`
`rejectReasonBy`	`string (uuid)`
`source`	`stringAPI` `UI`
`taskId`	`string (uuid)`
`total`	`number`
`unit`	`string`
`workUnitFileName`	`string`
`workUnitId`	`string (uuid)`

PaymentItemDto

`amount`	`number`
`createdOnDelivery`	`boolean`
`creationDate`	`integer (int64)`
`rate`	`number`
`source`	`stringAPI` `UI`
`taskId`	`string (uuid)`
`total`	`number`
`unit`	`string`

PermissionGrantDto

`active`	`boolean`
`code`	`string`
`description`	`string`
`grantSources`	PermissionGrantSource[]
`granteeIdentifier`	`string`
`granteeUuid`	`string (uuid)`
`inherited`	`boolean`
`module`	`string`
`name`	`string`
`permissionUuid`	`string (uuid)`
`type`	`stringUSER` `GROUP` `CLIENT` `ORGANIZATION` `ACCOUNT` `GRANTEE`

PermissionGrantSource

`grantType`	`stringUSER` `GROUP` `CLIENT` `ORGANIZATION` `ACCOUNT` `GRANTEE`
`granteeIdentifier`	`string`
`granteeUuid`	`string (uuid)`
`role`	`stringUSER` `ADMIN` `SYSADMIN` `ACCOUNT_ADMIN` `CLIENT` `CLIENT_ADMIN` `CLIENT_AGENCY` `CLIENT_REQUESTER` `CLIENT_PROJECT_MANAGER` `PROJECT_MANAGER` `ACCOUNTING` `REVIEWER` `INTERNAL` `PAYMENTS` `QUALITY_ISO` `QUALITY_AUDITOR` `VENDOR_ADMIN` `SALES` `WIKI_MODERATOR` `WIKI_READONLY` `WIKI_USER` `WIKI_ACTIONS` `WIKI_ADMIN` `REF_ADMIN` `REF_USER` `REF_READONLY` `VENDOR` `TERM_TRANSLATOR` `TERM_REVIEWER` `TERM_ADMIN` `TERM_CONTENT_CREATOR` `TERM_LANGUAGE_MANAGER` `TERM_UPDATE_REQUESTER` `TERM_READ_ONLY` `TERMINOLOGY_STANDALONE_USER` `TERMINOLOGY_STANDALONE_OWNER`
`sourceType`	`stringPERMISSION_GRANT` `USER_ROLE`

PermissionGroup

`accountUuid`	`string (uuid)`
`code`	`string`
`id`	`integer (int64)`
`name`	`string`
`uuid`	`string (uuid)`

PermissionGroupDto

`accountUuid`	`string (uuid)`
`id`	`integer (int64)`
`name`	`string`
`uuid`	`string (uuid)`

PortalTranslateRequest

`contextPrioritization`	`string` Which context wins when glossaries and translation memories disagree. Defaults to the account's setting.
`instructions`	AIInstructions
`orgUnitUuid`	`string` The org unit whose translation settings (glossaries, translation memories) apply. Defaults to your account's.
`originalContent`required	`string` The text to translate.
`sourceLocale`required	`string` Locale of `originalContent`.
`targetLocale`required	`string` Locale to translate into.

PortalTranslationRequestDto

`createdAt`	`integer (int64)`
`error`	`string`
`finishedAt`	`integer (int64)`
`requestUuid`	`string (uuid)`
`status`	`stringSTARTED` `FINISHED` `FAILED`
`translation`	`string`

PriceDto

`id`	`integer (int64)`
`minimumFee`	`number`
`source`	`string`
`target`	`string`
`uuid`	`string (uuid)`
`value`	`number`
`valuePerHour`	`number`

PriceFactorDto

`id`	`integer (int64)`
`isDefault`	`boolean`
`isValidMatch`	`boolean`
`langPairFactor`	`number`
`langPairPrice`	`number`
`languageFactor`	`map<string, map<string, number>>`
`overwriteSettings`	OverwriteSettings
`type`	PriceTypeDto
`uuid`	`string (uuid)`
`value`	`number`

PriceList

`accountUuid`	`string (uuid)`
`chargeBy`	`stringWORD` `HOUR`
`currency`	`string`
`defaultMinimumFeeByLanguagePair`	`number`
`defaultPriceList`	`boolean`
`defaultPricePerHour`	`number`
`defaultPricePerItem`	`number`
`fallbackPriceList`	`boolean`
`hiddenFuzzies`	`boolean`
`id`	`integer (int64)`
`isAccountDefault`	`boolean`
`maxPriceOrDefault`	`number`
`memo`	`string`
`minFeeType`	`stringPROJECT` `LANGUAGE_PAIR` `FIXED`
`minimumFeeByProject`	`number`
`name`required	`string`
`status`	`boolean`
`uuid`	`string (uuid)`
`wordsPerHour`	`integer (int64)`

PriceListDto

`accountUUID`	`string (uuid)`
`chargeBy`	`stringWORD` `HOUR`
`currency`	`string`
`defaultMinimumFeeByLanguagePair`	`number`
`defaultPriceList`	`boolean`
`defaultPricePerHour`	`number`
`defaultPricePerItem`	`number`
`hiddenFuzzies`	`boolean`
`id`	`integer (int64)`
`infoFields`	PriceList
`isAccountDefault`	`boolean`
`memo`	`string`
`minFeeType`	`stringPROJECT` `LANGUAGE_PAIR` `FIXED`
`minimumFeeByProject`	`number`
`name`	`string`
`priceFactors`	PriceFactorDto[]
`prices`	PriceDto[]
`pricesAndPriceFactors`	PriceList
`status`	`boolean`
`uuid`	`string (uuid)`
`wordsPerHour`	`integer (int64)`

PriceTypeDto

`description`	`string`
`id`	`integer (int64)`
`matches`	PriceTypeMatchRange[]
`priceUnit`	`stringWORD` `PAGE` `MINUTE` `HOUR` `DAY` `FEE`
`rateType`	`stringPERCENT` `FIXED_RATE`
`type`	`stringTRANSLATIONS` `FILE_ENGINEERING` `QA` `NONE`
`uuid`	`string (uuid)`

PriceTypeMatchRange

`matchRangeEnd`	`number (double)`
`matchRangeStart`	`number (double)`

ProfitabilityMargin

`pmRatesDetails`	TimesheetPayableDetail[]
`profitability`	`number`
`profitabilityWithPmRates`	`number`
`totalCost`	`number`
`totalCostTasks`	`number`
`totalCostWithPmRates`	`number`

ProjectDeliveryFilters

`configPath`	`string`
`filenames`	`string[]`
`filepaths`	`string[]`
`languages`	`string[]`
`resourceUuids`	`string (uuid)[]`
`status`	`stringNEW` `CREATED` `IN_PROGRESS` `COMPLETED` `APPROVED` `REJECTED` `DELIVERED` `CANCELLED` `FAILED`
`workflow`	`string`

ProjectDto

`accountUuid`	`string (uuid)`
`alternativeTranslationsEnabled`	`boolean`
`approvalDate`	`integer (int64)`
`assignee`	UserDto
`automationEnabled`	`boolean`
`automationStatus`	`stringRUNNING` `SKIPPED` `FINISHED` `FAILED`
`automationStatusMessage`	`string`
`autopilotEnabled`	`boolean`
`ciTag`	`string`
`client`	OrganizationalUnitDto
`confidenceMatchOverRepetitionEnabled`	`boolean`
`confirmedSegments`	`integer`
`contact`	UserDto
`contentMode`	`stringFILES` `KEY_VALUE`
`continuousMode`	`stringSEALED` `LEGACY`
`costCalculationMode`	`stringAUTOMATIC` `MANUAL`
`costs`	CostDto[]
`costsCalculatedAt`	`integer (int64)`
`costsLogfileId`	`string (uuid)`
`costsLogfileName`	`string`
`costsRequestedAt`	`integer (int64)`
`costsStatus`	`stringCREATING` `UPDATING` `COMPLETED` `COMPLETED_WARN` `LOGFILE_ERROR` `INGESTION_ERROR` `ERROR` `NOT_CALCULATED`
`createDate`	`integer (int64)`
`creator`	UserDto
`currency`	`string`
`customFields`	`map<string, object>[]`
`deliveryDate`	`integer (int64)`
`dropFiles`	`string[]`
`dueDate`	`integer (int64)`
`enableTaskFeedback`	`boolean`
`expirationDate`	`integer (int64)`
`genesisId`	`string`
`hasDataTransformation`	`boolean`
`hasNewUploadFile`	`boolean`
`id`	`integer (int64)`
`instructions`	`string`
`invoiceDate`	`integer (int64)`
`invoiceInfo`	`string`
`isContinuous`	`boolean`
`lastLogfileIdPostUpdate`	`string (uuid)`
`logfileForTasksPayment`	`string (uuid)`
`mediaFiles`	ProjectMediaFileDto[]
`name`	`string`
`notes`	`string`
`ntMatchOverRepetitionEnabled`	`boolean`
`organizationUuid`	`string`
`organizationalUnit`	OrganizationalUnitDto
`origin`	`stringWORK_PACKAGE`
`pdfPreviewFiles`	ProjectPdfPreviewFileDto[]
`priceList`	PriceListDto
`progress`	`number (double)`
`projectGroupId`	`string (uuid)`
`reference`	`string`
`referenceFiles`	`string[]`
`reminderThresholdPercentage`	`integer`
`requestedDeliveryDate`	`integer (int64)`
`requirePurchaseOrderEnabled`	`boolean`
`resources`	ProjectResourceDto[]
`reviewFiles`	ProjectReviewFileDto[]
`sourceLocale`	`string`
`spellCheckerIgnoreWordsEnabled`	`boolean`
`status`	`stringDELETED` `CANCELLED` `DRAFT` `PENDING` `APPROVED` `DELIVERED` `INVOICED` `PARTIALLY_INVOICED` `NOT_INVOICED` `CONTINUOUS`
`tags`	`string[]`
`targetLocales`	`string[]`
`taskPaymentType`	`stringWORD` `HOUR`
`taskReminderAutomaticEnabled`	`boolean`
`timezone`	`string`
`tmMatchOverRepetitionEnabled`	`boolean`
`totalCost`	`number`
`totalCostDto`	ITotalCost
`totalSegments`	`integer`
`totalWorkUnits`	`integer (int64)`
`uuid`	`string (uuid)`
`workUnits`	WorkUnitDto[]
`workflows`	WorkflowDto[]

ProjectInfoDto

`accountUuid`	`string (uuid)`
`assigneeUUID`	`string (uuid)`
`automationEnabled`	`boolean`
`autopilotEnabled`	`boolean`
`categoryId`	`integer (int64)`
`ciTag`	`string`
`clientUUID`	`string (uuid)`
`confidenceMatchOverRepetitionEnabled`	`boolean`
`contactUUID`	`string (uuid)`
`contentMode`	`stringFILES` `KEY_VALUE`
`costCalculationMode`	`stringAUTOMATIC` `MANUAL`
`currency`	`string`
`dueDate`	`integer (int64)`
`inferDefaultSettings`	`boolean`
`instructions`	`string`
`invoiceInfo`	`string`
`isContinuous`	`boolean`
`name`	`string`
`notes`	`string`
`ntMatchOverRepetitionEnabled`	`boolean`
`priceListUUID`	`string (uuid)`
`reference`	`string`
`sourceLocale`	`string`
`spellCheckerIgnoreWordsEnabled`	`boolean`
`tags`	`string[]`
`taskPaymentType`	`stringWORD` `HOUR`
`timezone`	`string`
`tmMatchOverRepetitionEnabled`	`boolean`

ProjectMediaFileDto

`audioCodec`	`string`
`createDate`	`integer (int64)`
`createdByEmail`	`string`
`createdByUser`	`string`
`hash`	`string`
`id`	`integer (int64)`
`locale`	`string`
`name`	`string`
`path`	`string`
`previewStatus`	`string`
`previewUrl`	`string`
`projectUuid`	`string (uuid)`
`signedUrl`	`string`
`url`	`string`
`uuid`	`string (uuid)`
`videoCodec`	`string`
`workUnitFilename`	`string`

ProjectMessageCreateDto

`parent`	`string (uuid)`
`privateMessage`	`boolean`
`text`	`string`

ProjectMessageDto

`author`	`string (uuid)`
`authorName`	`string`
`creationTimestamp`	`integer (int64)`
`parent`	`string (uuid)`
`privateMessage`	`boolean`
`text`	`string`
`uuid`	`string (uuid)`

ProjectPdfPreviewFileDto

`createDate`	`integer (int64)`
`createdByEmail`	`string`
`createdByUser`	`string`
`hash`	`string`
`id`	`integer (int64)`
`locale`	`string`
`name`	`string`
`path`	`string`
`projectUuid`	`string (uuid)`
`url`	`string`
`uuid`	`string (uuid)`

ProjectQualitySummaryDto

`confidenceScore`	`number`
`issuesByType`	IssueTotal[]
`scoredSegments`	`integer (int64)`
`smellsByCategory`	SmellCategory[]
`totalSegments`	`integer (int64)`

ProjectRequest

`accountUUID`	`string (uuid)`
`configUUID`	`string (uuid)`
`contactUUID`	`string (uuid)`
`orgUnitUUID`	`string (uuid)`
`productTag`	`string`
`reference`	`string`
`skipHashCheck`	`boolean`
`sourceLanguage`	`string`
`tags`	`string[]`
`targetLanguages`	`string[]`
`type`	`string`
`workflows`	`string[]`
`wpExcludePaths`	`string[]`
`wpIds`	`integer (int64)[]`
`wpPaths`	`string[]`

ProjectResourceDto

`creation`	`integer (int64)`
`defaultFilterSettings`	`boolean`
`hash`	`string`
`isProcessedSuccessfully`	`boolean`
`name`	`string`
`notes`	`string`
`params`	FileParams
`parentName`	`string`
`parentUuid`	`string (uuid)`
`path`	`string`
`preSignedUrl`	`string`
`processingErrorMessage`	`string`
`projectUuid`	`string (uuid)`
`segmentationParams`	`map<string, object>`
`sourceLocale`	`string`
`targetLocales`	`string[]`
`type`	`stringFOLDER` `FILE`
`url`	`string`
`uuid`	`string (uuid)`
`workflows`	`string[]`
`zipProcessingTaskId`	`string`

ProjectReviewFileDto

`annotations`	`string`
`createDate`	`integer (int64)`
`createdByEmail`	`string`
`createdByUser`	`string`
`events`	ReviewEvent[]
`hash`	`string`
`id`	`integer (int64)`
`locale`	`string`
`name`	`string`
`path`	`string`
`url`	`string`
`uuid`	`string (uuid)`

ProjectSegmentDto

`confidenceScore`	`number`
`id`	`string (uuid)`
`index`	`integer`
`issues`	Issue[]
`locked`	`boolean`
`smells`	Smell[]
`source`	`string`
`status`	`stringNOT_TRANSLATED` `TRANSLATED` `CONFIRMED` `REVIEWED` `TRANSLATED` has a translation that is not confirmed yet.
`stepLevel`	`integer`
`target`	`string`
`workUnitUuid`	`string (uuid)`

ProjectStatusChangeDto

`calculateCosts`	`boolean`
`createSeparateOutputFolder`	`boolean`
`detailedReasons`	`string[]`
`enableAutoDueDate`	`boolean`
`force`	`boolean`
`newStatus`	`stringDELETED` `CANCELLED` `DRAFT` `PENDING` `APPROVED` `DELIVERED` `INVOICED` `PARTIALLY_INVOICED` `NOT_INVOICED` `CONTINUOUS`
`previousStatus`	`stringDELETED` `CANCELLED` `DRAFT` `PENDING` `APPROVED` `DELIVERED` `INVOICED` `PARTIALLY_INVOICED` `NOT_INVOICED` `CONTINUOUS`
`projectUuid`	`string (uuid)`
`reason`	`string`
`skipBuildTranslatedFile`	`boolean`
`skipDatabaseUpdate`	`boolean`
`skipGitHub`	`boolean`
`timestamp`	`integer (int64)`
`user`	UserDto
`userUuid`	`string (uuid)`
`uuid`	`string (uuid)`
`writeToDisk`	`boolean`
`writeToS3`	`boolean`

ProjectTranslatedFileUrlDto

`fileName`	`string`
`translatedFileUrl`	`string`
`workUnitUuid`	`string (uuid)`

QuoteNotes

`description`	`string`
`title`	`string`

RateDetailsDto

`createdAt`	`integer (int64)`
`dailyRate`	`number`
`hourlyRate`	`number`
`languagePair`	`string`
`pagesRate`	`number`
`rateType`	`string`
`sourceLanguage`	`string`
`targetLanguage`	`string`
`updatedAt`	`integer (int64)`
`userRateUuid`	`string (uuid)`
`uuid`	`string (uuid)` Send the uuid of one of the rate's details to update it; leave it out to add a detail.
`wordRate`	`number`
`workflowUuid`	`string (uuid)`

ReceivableDto

`cancelledDate`	`integer (int64)`
`contact`	`string`
`contactUser`	UserDto
`creationDate`	`integer (int64)`
`currency`	`string`
`customFields`	`map<string, object>[]`
`customReceivableByUser`	`boolean`
`dueDate`	`integer (int64)`
`equally`	`boolean`
`firstInstallmentValue`	`number (double)`
`id`	`integer (int64)`
`installments`	InstallmentDto[]
`intervalBetweenDues`	`integer`
`invoiceFirstOnly`	`boolean`
`manualInvoice`	`boolean`
`multipleInstallments`	`boolean`
`netAmount`	`number (double)`
`nfId`	`number (double)`
`numInstallments`	`integer`
`oldProjectsInvoiced`	`map<string, object>[]`
`organizationalUnit`	OrganizationalUnitDto
`paidAmount`	`number (double)`
`paymentDate`	`integer (int64)`
`paymentNotesAccount`	`string (uuid)`
`projects`	ProjectDto[]
`purchaseOrder`	`string`
`reference`	`string`
`status`	`stringINVOICED` `INVOICED_NFE` `INVOICED_NFE_ERROR` `PARTIALLY_INVOICED` `PARTIALLY_PAID` `PAID` `VOID` `CANCELLED`
`taxAmount`	`number (double)`
`taxes`	EntityTaxDto[]
`total`	`number (double)`
`uuid`	`string (uuid)`
`xeroId`	`string`

ReceivablePaidDto

`invoiceUuids`	`string (uuid)[]`
`paymentDate`	`integer (int64)`

ReceivableProjectRef

A project of the org unit to invoice, by id.

idrequired

integer (int64)

The project's id.

ReceivableTaxRef

A tax applied on the projects' total.

`calculationType`	`stringINCREASE` `DECREASE`
`name`	`string`
`type`	`stringFIXED` `PERCENTAGE`
`value`	`number`

ReceivableUuidRef

The org unit to bill, or a contact user of that org unit, by uuid.

uuidrequired string (uuid)

RenameLogfileDto

name

string

The new name of the logfile. Surrounding spaces are removed; a blank name is refused.

RepositoryConfig

`baseBranch`required	`string`
`configPath`required	`string`
`configUUID`	`string (uuid)`
`fileSuffix`	`string`
`id`	`integer (int64)` Leave it out to create a repository configuration; send the id of one of this GitHub configuration's repository configurations to update it.
`name`required	`string`
`owner`required	`string`
`projectTag`required	`string`
`uuid`	`string (uuid)`

RequiredTermFields

`customAttributes`	`string[]`
`fields`	`string[]`

ResourceFileParamsDto

`baseResourceUuid`	`string (uuid)`
`extension`	`string`
`fileName`	`string`
`hasUnitDefault`	`boolean`
`params`	FileParams
`segmentationParams`	`map<string, object>`

ReviewEvent

`email`	`string`
`event`	`string`
`timestamp`	`integer (int64)`
`user`	`string`

S3PresignedUrlResponse

`expiryDate`	`string` A date five days ahead (`yyyy-MM-dd`), kept for compatibility. Not when the URL expires: see `urlExpiresAt`.
`headers`	`map<string, string>` Headers to send with the upload. They are part of the URL's signature.
`kmsKey`	`string` Encryption key id: send it in the `x-amz-server-side-encryption-aws-kms-key-id` header of the upload, with `x-amz-server-side-encryption: aws:kms`.
`url`	`string` Pre-signed URL to `PUT` the file to. Valid for 60 minutes, until `urlExpiresAt`.
`urlExpiresAt`	`string` When the URL stops accepting uploads (ISO-8601 instant, UTC).

SegmentCommentAuthor

Who resolved the comment's thread, or null while it is open.

`name`	`string`
`uuid`	`string (uuid)`

SegmentCommentCreateRequest

`parentId`	`string (uuid)` Id of the comment this one answers, in the same segment's thread.
`text`required	`string` Text of the comment. Mention a user with `[@First Last:<user uuid>]` to notify them.

SegmentCommentDto

`author`	SegmentCommentAuthor
`createdAt`	`integer (int64)` When the comment was written (Unix time in milliseconds).
`fileIndex`	`integer` Position of the segment in the file. The same in every workflow step of the file.
`id`	`string (uuid)`
`parentId`	`string (uuid)` The comment this one answers, or null for the first comment of a thread.
`resolvedAt`	`integer (int64)` When the comment's thread was resolved (Unix time in milliseconds), or null while it is open.
`resolvedBy`	SegmentCommentAuthor
`segmentId`	`string (uuid)` The segment of this work unit the comment is on (the `bwx:ts-id` of the bilingual file).
`text`	`string`

SegmentDto

`aligned`	`boolean`
`codedText`	`string`
`contextKey`	`string`
`createdAt`	`integer (int64)`
`createdBy`	UserDto
`createdByExternalUser`	`string`
`displayText`	`string`
`domain`	`string`
`extraProps`	`map<string, string>`
`filename`	`string`
`id`	`integer (int64)`
`isSourceSegment`	`boolean`
`locale`	`string`
`modifiedAt`	`integer (int64)`
`modifiedBy`	UserDto
`modifiedByExternalUser`	`string`
`nextText`	`string`
`previousText`	`string`
`projectName`	`string`
`reviewed`	`boolean`
`rtl`	`boolean`
`spans`	CodeUomSpan[]
`subDomain`	`string`
`text`	`string`
`tmId`	`integer (int64)`
`tmJobId`	`integer (int64)`
`translationUnitId`	`integer (int64)`
`workUnitId`	`string (uuid)`

SegmentsLockRequest

`locked`required	`boolean` `true` locks the segments, `false` unlocks them.
`segmentIds`required	`string (uuid)[]` Ids of segments of the work unit (the `bwx:ts-id` of the bilingual file), at most 1,000.

Settings

Optional TM behaviour settings.

`codeUomAbbreviationEnabled`	`boolean`
`updatePropagatedRepetitions`	`boolean`
`workflows`	WorkflowSetup[]

SimpleClientDto

`autopilotEnabled`	`boolean`
`contactPersonEmailNotifications`	`boolean`
`continuousPlatformTag`	`string`
`daysUntilPaymentDue`	`integer (int64)`
`defaultAtlasCatTool`	`boolean`
`id`	`integer (int64)`
`invoiceInfo`	`string`
`localeRegion`	`map<string, string>`
`name`	`string`
`projectAutomationEnabled`	`boolean`
`projectManagerEmailNotifications`	`boolean`
`showPaymentPolicy`	`boolean`
`tags`	`string[]`
`users`	UserDto[]
`uuid`	`string (uuid)`
`vendorEmailNotifications`	`boolean`

SimpleTmHitDto

`contextKey`	`string`
`createdAt`	`integer (int64)`
`createdBy`	UserDto
`match`	`number (double)`
`modifiedAt`	`integer (int64)`
`modifiedBy`	UserDto
`nextSourceText`	`string`
`previousSourceText`	`string`
`sourceLocale`	`string`
`sourceSegmentId`	`integer (int64)`
`sourceText`	`string`
`targetLocale`	`string`
`targetSegmentId`	`integer (int64)`
`targetText`	`string`
`tmName`	`string`
`tmUuid`	`string (uuid)`
`translationUnitId`	`integer (int64)`

SimpleTUDto

`id`	`integer (int64)`
`tmUuid`	`string (uuid)`

SimpleTUUpdateData

`locale`	`string`
`text`	`string`

SimpleTUUpsertData

`sourceContext`	TMContext
`sourceLocale`required	`string`
`sourceText`required	`string`
`targetLocale`required	`string`
`targetText`required	`string`

SkippedTargetLocale

`locale`	`string`
`reason`	`string`

Smell

`category`	`string`
`message`	`string`
`severity`	`string`
`term`	`string`

SmellCategory

`bySeverity`	`map<string, integer (int64)>`
`category`	`string`
`total`	`integer (int64)`

SortObject

`empty`	`boolean`
`sorted`	`boolean`
`unsorted`	`boolean`

TaskDto

`acceptanceDate`	`integer (int64)`
`assignDate`	`integer (int64)`
`assignedBy`	UserDto
`assignee`	UserDto
`beginIndex`	`integer (int64)`
`categories`	`string[]`
`client`	`string`
`createdBy`	UserDto
`creationDate`	`integer (int64)`
`currency`	`string`
`customFields`	`map<string, object>[]`
`dateStatus`	`string`
`deliveryDate`	`integer (int64)`
`dependencies`	`string (uuid)[]`
`dueDate`	`integer (int64)`
`endIndex`	`integer (int64)`
`fileName`	`string`
`files`	`string[]`
`fromSplit`	`boolean`
`genesisAssignmentId`	`string (uuid)`
`genesisWorkId`	`string (uuid)`
`genesisWorkUnitId`	`string (uuid)`
`hasMismatchTag`deprecated	`boolean`
`hasTagMismatch`	`boolean`
`instructions`	`string`
`minimumScoreRequired`	`number`
`name`	`string`
`payableAmount`	`number`
`payments`	PaymentItem[]
`postAnalysisId`	`string (uuid)`
`previousTaskDueDate`	`integer (int64)`
`profitability`	`number`
`project`	ProjectDto
`receivableAmount`	`number`
`referenceFiles`	`string[]`
`scheduledDate`	`integer (int64)`
`sequence`	`integer`
`splitSequence`	`integer`
`status`	`stringCANCELLED` `PENDING` `PENDING_ACCEPTANCE` `PENDING_CONFIRMATION` `SCHEDULED` `EXPIRED` `ASSIGNED` `DELIVERED` `INVOICED` `PAID` `NOT_INVOICED` `SKIPPED`
`taskReminderEnabled`	`boolean`
`uuid`	`string (uuid)`
`workPackageDestAccountName`	`string`
`workPackageUuid`	`string (uuid)`
`workUnit`	WorkUnitDto

TaskPaymentUpdateResponseDto

`assignee`	UserDto
`currency`	`string`
`payableAmount`	`number`
`payments`	PaymentItemDto[]
`project`	ProjectDto
`status`	`stringCANCELLED` `PENDING` `PENDING_ACCEPTANCE` `PENDING_CONFIRMATION` `SCHEDULED` `EXPIRED` `ASSIGNED` `DELIVERED` `INVOICED` `PAID` `NOT_INVOICED` `SKIPPED`
`uuid`	`string (uuid)`
`workUnit`	WorkUnitDto

TaskStatusUpdateDto

`effectiveHasTagMismatch`	`boolean`
`hasMismatchTag`deprecated	`boolean`
`hasTagMismatch`	`boolean`
`status`	`stringCANCELLED` `PENDING` `PENDING_ACCEPTANCE` `PENDING_CONFIRMATION` `SCHEDULED` `EXPIRED` `ASSIGNED` `DELIVERED` `INVOICED` `PAID` `NOT_INVOICED` `SKIPPED`

TaskStatusUpdateResponseDto

`assignee`	UserDto
`hasTagMismatch`	`boolean`
`project`	ProjectDto
`status`	`stringCANCELLED` `PENDING` `PENDING_ACCEPTANCE` `PENDING_CONFIRMATION` `SCHEDULED` `EXPIRED` `ASSIGNED` `DELIVERED` `INVOICED` `PAID` `NOT_INVOICED` `SKIPPED`
`uuid`	`string (uuid)`
`workUnit`	WorkUnitDto

TaxDto

`base`	`number (double)`
`id`	`integer (int64)`
`name`	`string`

TermCreateRequest

`caseSensitive`	`boolean`
`conceptUuid`	`string (uuid)` The concept the term belongs to.
`definition`	`string` Definition of the concept the term belongs to.
`dnt`	`boolean` Do not translate.
`exactMatch`	`boolean`
`forbidden`	`boolean`
`gender`	`stringMasculine` `Feminine` `Neutral` `Undefined`
`glossaryCustomAttributes`	`map<string, object>[]` Values of the glossary's custom attributes. Each item has `name`, `type` and `value`.
`glossaryUuid`required	`string (uuid)`
`internal`	`boolean`
`language`required	`string` One of the glossary's languages.
`note`	`string`
`part`	`stringNoun` `Pronoun` `Adjective` `Determiner` `Verb` `Adverb` `Preposition` `Conjunction` `Interjection` `Acronym` `Other` `Proper Noun` `Undefined`
`rtl`	`boolean` Right-to-left text.
`status`required	`stringUnder_Review` `Approved` `Published` `Preferred` `Deprecated` Must be `Approved` on create.
`termType`	`stringFull` `Acronym`
`text`required	`string`
`usage`	`string`
`writable`	`boolean`

TermDTO

`caseSensitive`	`boolean`
`commentsAboutReview`	`string`
`concept`	ConceptDTO
`createdAt`	`integer (int64)`
`definition`	`string`
`dnt`	`boolean`
`exactMatch`	`boolean`
`forbidden`	`boolean`
`gender`	`stringMasculine` `Feminine` `Neutral` `Undefined`
`glossary`	GlossaryThinDTO
`id`	`integer (int64)`
`internal`	`boolean`
`isRequestedReview`	`boolean`
`language`	`string`
`lastModifiedAt`	`integer (int64)`
`legal`	`boolean`
`note`	`string`
`part`	`stringNoun` `Pronoun` `Adjective` `Determiner` `Verb` `Adverb` `Preposition` `Conjunction` `Interjection` `Acronym` `Other` `Proper Noun` `Undefined`
`requestReviewAt`	`integer (int64)`
`requestReviewBy`	`string`
`rtl`	`boolean`
`status`	`stringUnder_Review` `Approved` `Published` `Preferred` `Deprecated`
`termArbitrationStatus`	`stringREQUESTED` `IN_PROGRESS` `CLOSED`
`termType`	`stringFull` `Acronym`
`termsLinked`	TermLinkedDTO[]
`text`	`string`
`usage`	`string`
`writable`	`boolean`

TermEntryDto

`caseSensitive`	`boolean`
`conceptDefinition`	`string`
`conceptId`	`integer (int64)`
`conceptUuid`	`string (uuid)`
`createdAt`	`integer (int64)`
`definition`	`string`
`dnt`	`boolean`
`exactMatch`	`boolean`
`forbidden`	`boolean`
`forbiddenMetadata`	`string`
`gender`	`stringMasculine` `Feminine` `Neutral` `Undefined`
`glossaryCustomAttributes`	`map<string, object>[]`
`glossaryUuid`	`string (uuid)`
`id`	`integer (int64)`
`internal`	`boolean`
`language`	`string`
`lastModifiedAt`	`integer (int64)`
`learnt`	`boolean`
`note`	`string`
`part`	`stringNoun` `Pronoun` `Adjective` `Determiner` `Verb` `Adverb` `Preposition` `Conjunction` `Interjection` `Acronym` `Other` `Proper Noun` `Undefined`
`rtl`	`boolean`
`status`	`stringUnder_Review` `Approved` `Published` `Preferred` `Deprecated`
`termType`	`stringFull` `Acronym`
`text`	`string`
`usage`	`string`
`uuid`	`string (uuid)`
`writable`	`boolean`

TermEntryOnSegment

`contextProjectId`	`string (uuid)`
`contextWorkId`	`string (uuid)`
`sourceTerm`	TermTranslationDTO
`targetTerm`	TermTranslationDTO

TermLinkedDTO

`linkId`	`integer (int64)`
`linkType`	`stringSynonym` `Antonym` `Homograph`
`term`	TermDTO

TermsParams

`extractTerms`	`boolean`
`parameters`	map<string, Parameter>

TermTranslationDTO

`caseSensitive`	`boolean`
`concept`	`integer (int64)`
`conceptDefinition`	`string`
`conceptId`	`integer (int64)`
`conceptUuid`	`string (uuid)`
`createdAt`	`integer (int64)`
`definition`	`string`
`dnt`	`boolean`
`exactMatch`	`boolean`
`forbidden`	`boolean`
`gender`	`stringMasculine` `Feminine` `Neutral` `Undefined`
`glossaryCustomAttributes`	`map<string, object>[]`
`glossaryName`	`string`
`glossaryUuid`	`string (uuid)`
`id`	`integer (int64)`
`internal`	`boolean`
`language`	`string`
`lastModifiedAt`	`integer (int64)`
`learnt`	`boolean`
`nameCreatedBy`	`string`
`nameModifiedBy`	`string` Name of the user who last edited the term. `null` when no change to the term recorded who made it, as on a term never edited since it was created.
`note`	`string`
`part`	`stringNoun` `Pronoun` `Adjective` `Determiner` `Verb` `Adverb` `Preposition` `Conjunction` `Interjection` `Acronym` `Other` `Proper Noun` `Undefined`
`rank`	`integer`
`rtl`	`boolean`
`sortValues`	`string[]`
`status`	`stringUnder_Review` `Approved` `Published` `Preferred` `Deprecated`
`termType`	`stringFull` `Acronym`
`text`	`string`
`usage`	`string`
`uuid`	`string (uuid)`
`writable`	`boolean`

TermUpdateRequest

definition updates the concept's definition only when conceptUuid is sent too.

`caseSensitive`	`boolean`
`conceptUuid`	`string (uuid)` The concept the term belongs to.
`definition`	`string` Definition of the concept the term belongs to.
`dnt`	`boolean` Do not translate.
`exactMatch`	`boolean`
`forbidden`	`boolean`
`gender`	`stringMasculine` `Feminine` `Neutral` `Undefined`
`glossaryCustomAttributes`	`map<string, object>[]` Values of the glossary's custom attributes. Each item has `name`, `type` and `value`.
`internal`	`boolean`
`note`	`string`
`part`	`stringNoun` `Pronoun` `Adjective` `Determiner` `Verb` `Adverb` `Preposition` `Conjunction` `Interjection` `Acronym` `Other` `Proper Noun` `Undefined`
`rtl`	`boolean` Right-to-left text.
`status`	`stringUnder_Review` `Approved` `Published` `Preferred` `Deprecated`
`termType`	`stringFull` `Acronym`
`text`	`string` Omitted or blank keeps the stored text.
`usage`	`string`
`writable`	`boolean`

TimesheetPayableDetail

`currency`	`string`
`hourlyRate`	`number`
`payableAmount`	`number`
`payableAmountInUSD`	`number`
`resourceName`	`string`
`resourceUuid`	`string`
`totalHours`	`number (double)`
`type`	`string`
`userName`	`string`
`userUuid`	`string`

TMContext

`contextKey`	`string`
`nextText`	`string`
`previousText`	`string`
`type`	`string`

TMCreateParams

`organization`	OrganizationDto
`tmMetadata`	TMMetadata

TMDto

`client`	IdNameDto
`creationDate`	`integer (int64)`
`creator`	IdNameDto
`customFields`	`map<string, object>[]`
`domain`	`string`
`id`	`integer (int64)`
`name`	`string`
`note`	`string`
`orgUnits`	IdNameDto[]
`organization`	IdNameDto
`sourceLocale`	`string`
`subDomain`	`string`
`targetLocales`	`string[]`
`translationUnitCount`	`integer (int64)`
`uuid`	`string (uuid)`

Leave projectId, workUnitIds and projectStepLevel out to export the whole TM, filtered by languages, tuIds and the creation dates. Send projectId with workUnitIds or projectStepLevel to export, as TMX, only the entries saved by those work units (the work-unit path): tuIds and the dates don't apply there.

`createdAfter`	`integer (int64)` Only entries created after this time, in epoch milliseconds. Not with the work-unit path.
`createdBefore`	`integer (int64)` Only entries created before this time, in epoch milliseconds. Not with the work-unit path.
`format`required	`stringtmx` `xlsx` Case-insensitive. The work-unit path is TMX only.
`languages`	`string[]` Locales to export. Omitted or empty exports all of them.
`projectId`	`string (uuid)` Work-unit path: the project whose work units saved the entries. The TM must be linked to it, and the caller also needs the PROJECT_export_import_file permission.
`projectStepLevel`	`integer` Work-unit path: the workflow step whose saved entries are exported. Sending it, even as 0, selects the work-unit path.
`tuIds`	`integer (int64)[]` Export only these translation units. Not with the work-unit path.
`workUnitIds`	`string (uuid)[]` Work-unit path: the project's work units whose saved entries are exported.

TMJobDto

`creationDate`	`integer (int64)`
`endTime`	`integer (int64)`
`failureReason`	`string`
`fileName`	`string`
`id`	`integer (int64)`
`jobExecutionId`	`integer (int64)`
`jobName`	`string`
`jobType`	`string`
`processingTime`	`string`
`progress`	TMJobProgressDto
`segmentsCount`	`integer (int64)`
`startTime`	`integer (int64)`
`status`	`string`
`tmId`	`integer (int64)`
`tmUuid`	`string (uuid)`
`workUnitScoped`	`boolean`

TMJobProgressDto

`done`	`integer (int64)`
`phase`	`string`
`total`	`integer (int64)`
`translationUnits`	`integer (int64)`
`unit`	`string`

TMMetadata

`client`	ClientDto
`creator`	UserDto
`customFields`	`map<string, object>[]`
`domain`	`string`
`isLarge`	`boolean`
`name`	`string`
`note`	`string`
`organization`	OrganizationDto
`sourceLocale`	`string`
`subDomain`	`string`
`targetLocales`	`string[]`

TmOrgUnitAssociationRequest

`defaultThreshold`	`number (double)` Minimum match score. Default: 0.75.
`fixPreTranslateMismatchTags`	`boolean`
`fixSuggestionMismatchTags`	`boolean`
`fixTags`	`boolean`
`isDefault`	`boolean` The TM is the org units' default TM.
`penalty`	`number (double)` Penalty applied to the TM's matches. Default: 0.
`read`	`boolean` The org units read from the TM. Default: false.
`settings`	Settings
`write`	`boolean` The org units write to the TM. Default: false.

TMSettingsDTO

`atlasTmId`	`integer (int64)`
`fixTags`	`boolean`
`id`	`string (uuid)`
`maxHits`	`integer`
`name`	`string`
`penalty`	`number (double)`
`projectUuid`	`string (uuid)`
`read`	`boolean`
`settings`	Settings
`threshold`	`number (double)`
`tm`	TMDto
`tmUuid`	`string (uuid)`
`write`	`boolean`

TotalCostDto

`confidenceSavings`	`number`
`costInfoDtoList`	CostInfoDto[]
`grossCost`	`number`
`minimumFeeApplied`	`boolean`
`netCost`	`number`
`totalCalculatedCost`	`number (double)`
`totalSavings`	`number`

TranslationKitJobDownloadLinkDto

`downloadUrl`	`string`
`expiresAt`	`integer (int64)`
`generatedAt`	`integer (int64)`
`id`	`integer (int64)`
`sharedLinkExpiresInDays`	`integer (int64)`

TranslationKitJobDto

`completedFiles`	`integer`
`creationDate`	`integer (int64)`
`downloadFileUrl`	`string` Temporary URL of the file the job built, once it has completed. Left out when the job has a `sharedLink`.
`downloadFileUrlExpiresAt`	`integer (int64)`
`endTime`	`integer (int64)`
`id`	`string (uuid)`
`isTransient`	`boolean`
`projectId`	`string (uuid)`
`sharedLink`	`string` Link that downloads the file without authentication (see Resolve Shared Link), when the job was started with `sharedLinkExpiresInDays`.
`sharedLinkExpiresInDays`	`integer (int64)`
`startTime`	`integer (int64)`
`status`	`stringSTARTING` `COMPLETED` `FAILED` `STARTING` while the job runs, then `COMPLETED` or `FAILED`.
`totalFiles`	`integer`
`type`	`stringEXPORT_XLIFF` `IMPORT_XLIFF` `EXPORT_XLSX` `IMPORT_XLSX` `LOC_KIT` `TRANSLATED_FILES` `SOURCE_FILES` What the job does. Jobs report `LOC_KIT` (export kit), `TRANSLATED_FILES`, `SOURCE_FILES`, `IMPORT_XLIFF` or `IMPORT_XLSX` (bulk import); `EXPORT_XLIFF` and `EXPORT_XLSX` are not used.

TranslationKitParams

`addSourceAndTargetSuffix`	`boolean`
`downloadDeliverables`	`boolean`
`fontMappings`	BwxFontMappings[]
`hideOriginColumn`	`boolean` Export kits with `locKitTypeJob: XLSX` only: hide the Origin column of the XLSX. The column stays in the sheet, so the file can still be imported.
`includeComments`	`boolean` Export kits with `locKitTypeJob` `XLSX` or `ALL` only: add the `Segment Comments` column, with every public comment of each segment. Defaults to `false`.
`intermediateFile`	`boolean`
`locKitTypeJob`	`stringALL` `XLIFF` `TMX` `TBX` `XLSX` Export kits only: what the kit holds. `ALL` (the default) builds XLIFF, XLSX, TMX and TBX files; `XLIFF` builds only the bilingual XLIFF files.
`projectId`	`string (uuid)` Ignored: the project comes from the path.
`sharedLinkExpiresInDays`	`integer (int64)1` `7` `30` Also create a link that downloads the result without authentication, valid for this many days. The job then returns `sharedLink` instead of `downloadFileUrl`.
`updateDataTransformation`	`boolean`
`workUnitUuids`	`string (uuid)[]` The work units to include, all at the same workflow step. Export kits and translated files need it unless `workflowLevel` is set; source files take the whole project when it is empty. A vendor always gets their own assigned work units.
`workflowLevel`	`integer` Every work unit at this workflow step. Export kits and translated files need it or `workUnitUuids`. Ignored for vendors and for source files.
`workflowUuid`	`string (uuid)` Every work unit of this workflow. Takes precedence over `workflowLevel` and `workUnitUuids`, but export kits and translated files still need one of those. Ignored for vendors.

TranslationUnitMatch

`locale`	`string`
`match`	`number (double)`
`segments`	SegmentDto[]
`translationUnitId`	`integer (int64)`

Type

`name`	`string`
`order`	`integer`

UpdateTaskRequest

`currency`	`string` Left out, it stays as it is.
`dueDate`	`integer (int64)` Due date, epoch milliseconds. Left out, it stays as it is.
`instructions`	`string` The task's instructions (HTML). Left out, they stay as they are.
`name`	`string` Left out, it stays as it is.
`uuid`	`string (uuid)` Optional. When sent, it must be the task in the path, otherwise the call answers 400.

UserAssociationRef

An organization or org unit of your account, by uuid. Read when the user is created.

uuidrequired string (uuid)

UserDto

`accessKey`	`string`
`accessKeyTimestamp`	`integer (int64)`
`accountOwner`	`boolean`
`accountType`	`stringCLI` `PERSONAL` `BUSINESS` `ENTERPRISE` `OTHER`
`accountUuid`	`string (uuid)`
`address`	`string`
`address2`	`string`
`admin`	`boolean`
`assignedJobs`	`integer (int64)`
`avatar`	`string`
`captcha`	`string`
`cellPhone`	`string`
`city`	`string`
`companyName`	`string`
`completedJobs`	`integer (int64)`
`country`	`string`
`currency`	`string`
`customFields`	`map<string, object>[]`
`dailyRate`	`number`
`defaultWorkflowRates`	`map<string, object>[]`
`deleteAllLanguagePair`	`boolean`
`email`	`string`
`emailMagicCode`	`string`
`entryPoint`	`stringWORKS_HOME` `PORTAL_HOME`
`externalId`	`string`
`forwardUrl`	`string`
`hourlyRate`	`number`
`id`	`integer (int64)`
`invoicingDayOfMonth`	`stringDAY_15` `DAY_30`
`invoicingPeriodicity`	`integer`
`lastAccessAt`	`integer (int64)`
`messageError`	`string`
`messageWarning`	`string`
`mfa`	`integer (int64)`
`mfaEnabled`	`boolean`
`minimumFee`	`number`
`name`	`string`
`nameEmail`	`string`
`newPassword`	`string`
`notes`	`string`
`notifyUser`	`boolean`
`orgUnits`	OrganizationalUnitDto[]
`organizations`	OrganizationDto[]
`pagesRate`	`number`
`parentUserUuid`	`string (uuid)`
`paymentMethod`	`stringPAYONEER` `PAYPAL` `BANK` `QUICKBOOKS`
`payoneerId`	`string`
`paypalAccount`	`string`
`permissionGroups`	PermissionGroupDto[]
`phone`	`string`
`postalCode`	`string`
`productName`	`string`
`punctuality`	`number (double)`
`quickBooksVendorId`	`string`
`roles`	`string[]`
`skypeId`	`string`
`slackHandle`	`string`
`state`	`string`
`status`	`stringActive` `Inactive` `Disabled` The user's status. Read ignoring case.
`subUser`	`boolean`
`subscriptions`	UserSubscriptionDto[]
`supportedLanguagePairs`	LanguagePair[]
`tags`	`string[]`
`targetAccountUuid`	`string (uuid)`
`tasksCompletedCount`	`integer (int64)`
`taxId`	`string`
`taxpayerId`	`string`
`timezone`	`string`
`totalJobs`	`integer (int64)`
`useProjectCurrency`	`boolean`
`userQualityMetrics`	UserQualityMetricsDto
`userRates`	UserRateDetailsDto[]
`uuid`	`string (uuid)`
`wordRate`	`number`

UserLanguagePairRef

A language pair of the user. Read when the user is created.

`source`	`string`
`target`	`string`

UserQualityMetricsDto

`avgQualityIndex`	`number`
`id`	`integer (int64)`
`maxQualityIndex`	`number`
`minQualityIndex`	`number`
`uuid`	`string (uuid)`
`vendor`	UserDto

UserRateDetailsDto

`createdAt`	`integer (int64)`
`currency`	`string`
`isDefault`	`boolean`
`minimumFee`	`number`
`orgUnitUuid`	`string (uuid)`
`rateDetails`	RateDetailsDto[]
`updatedAt`	`integer (int64)`
`userUuid`	`string (uuid)`
`uuid`	`string (uuid)`

UserRef

A user referenced by another resource.

`avatar`	`string`
`currency`	`string`
`email`	`string`
`id`	`integer (int64)`
`name`	`string`
`status`	`string`
`uuid`	`string (uuid)`

UserSubscriptionDto

`eventType`	`string`
`userId`	`integer (int64)`

WebhookDto

`active`	`boolean` Ignored. A webhook starts inactive and becomes active once its URL answers the validation request.
`secret`	`string` Optional, and recommended: the key wxrks signs every request with, an HMAC-SHA256 sent in `X-BWX-Signature`. It is stored encrypted, never returned, and cannot be changed; to rotate it, create a new webhook.
`type`	`stringNEW_PROJECT` `NEW_EMPTY_PROJECT` `PROJECT_STATUS_CHANGE` `PROJECT_UPDATE` `PROJECT_INGESTION_COMPLETED` `PROJECT_TRANSLATION_FINISHED` `TASK_ASSIGNED` `TASK_STATUS_CHANGE` `TASK_UPDATE` `WORK_UNIT_STATUS_CHANGE` `WORK_UNIT_TRANSLATION_FILE_READY` `WORK_UNIT_IMPORT_FINISHED` `TRANSLATION_KIT_JOB_FINISHED` `NEW_ORG_UNIT` `ORG_UNIT_UPDATE` `NEW_ORG` `ORG_UPDATE` `NEW_USER` `USER_UPDATE` The one event type this webhook receives. Create one webhook per event type; several can share a URL.
`url`	`string` Where wxrks sends the events, each as a `POST` with a JSON body. It must use `https://`.

WebhookResponseDto

`account`	`string (uuid)`
`active`	`boolean`
`createdAt`	`integer (int64)`
`events`	`string[]`
`url`	`string`
`uuid`	`string (uuid)`

WordPressConfig

`accountUuid`	`string (uuid)` The account of the org unit, set by wxrks.
`baseUrl`required	`string`
`cloudflareClientId`	`string`
`cloudflareClientSecret`	`string`
`defaultWorkflows`	`string[]`
`name`required	`string`
`orgUnit`	ClientIdNameDto
`orgUnitUuid`required	`string (uuid)`
`params`	`map<string, object>`
`sourceSite`	`string`
`strategy`	`stringDEFAULT` `ZENDESK`
`uuid`	`string (uuid)`
`wpCookiePassword`	`string`
`wpCookieUser`	`string`
`wpPassword`required	`string`
`wpUser`required	`string`

Workflow

`accountUuid`	`string (uuid)`
`active`	`boolean`
`code`	`string`
`createdAt`	`integer (int64)`
`description`	`string`
`editorEnabled`	`boolean`
`id`	`integer (int64)`
`projectSequence`	`integer`
`sequence`	`integer`
`settings`	Settings
`title`	`string`
`unitType`	`string`
`units`	`integer (int64)`
`updatedAt`	`integer (int64)`
`uuid`	`string (uuid)`
`value`	`number (double)`

WorkflowDto

`active`	`boolean`
`code`	`string`
`description`	`string`
`editorEnabled`	`boolean`
`projectSequence`	`integer`
`sequence`	`integer`
`settings`	Settings
`title`	`string`
`uuid`	`string (uuid)`

WorkflowSetup

`read`	`boolean`
`workflowUuid`	`string (uuid)`
`write`	`boolean`

WorkUnitDownloadFile

`deliverableFileUrl`	`string`
`fileName`	`string`
`operationId`	`string`
`originalFileUrl`	`string`
`progressElapsedMs`	`integer (int64)`
`progressLastHeartbeatAt`	`integer (int64)`
`progressMessage`	`string`
`progressStage`	`string`
`progressStartedAt`	`integer (int64)`
`sharedLink`	`string`
`sharedLinkExpiresInDays`	`integer (int64)`
`translatedFileCreationDate`	`integer (int64)`
`translatedFileUrl`	`string`
`translationStatus`	`string`

WorkUnitDto

`assignee`	UserRef
`baseUnitCost`	`number (double)`
`characters`	`integer`
`confirmedNonTranslatable`	`integer`
`confirmedSegments`	`integer`
`connectorStatus`	`string`
`connectorStatusReason`	`string`
`contentIsEmpty`	`boolean`
`cost`	`number`
`createdOnGenesis`	`boolean`
`creationTimestamp`	`integer (int64)`
`deliveryDate`	`integer (int64)`
`downloadTranslatedFileEnabled`	`boolean`
`dueDate`	`integer (int64)`
`filename`	`string`
`genesisCreationDescription`	`string`
`genesisCreationStatus`	`stringCREATING` `FAILED` `CREATED` Whether the work unit's content is ready in the editor.
`hasDeliverable`	`boolean`
`hasMismatchTag`	`boolean`
`hasXsltPreview`	`boolean`
`hours`	`integer`
`isSplit`	`boolean`
`lastUpdate`	`integer (int64)`
`minutes`	`integer`
`name`	`string`
`netWords`	`integer (int64)`
`orgUnitId`	`string (uuid)`
`pages`	`integer`
`partiallyDelivered`	`boolean`
`projectResource`	ProjectResourceDto
`projectUUID`	`string (uuid)`
`readOnly`	`boolean`
`relatedObjectId`	`string`
`savings`	`number (double)`
`segments`	`integer`
`sequence`	`integer`
`slices`	WorkUnitSlice[]
`sourceLanguage`	`string`
`targetLanguage`	`string`
`taskStatus`	`stringCANCELLED` `PENDING` `PENDING_ACCEPTANCE` `PENDING_CONFIRMATION` `SCHEDULED` `EXPIRED` `ASSIGNED` `DELIVERED` `INVOICED` `PAID` `NOT_INVOICED` `SKIPPED`
`totalNonTranslatable`	`integer`
`totalSegments`	`integer`
`uuid`	`string (uuid)`
`words`	`integer (int64)`
`workId`	`string (uuid)`
`workPackageStatus`	`stringDELIVERED` `FAILED` For a work unit delivered through a work package: shown only once it is delivered or failed.
`workPackageStatusReason`	`string`
`workStatus`	`stringNEW` `CREATED` `IN_PROGRESS` `COMPLETED` `APPROVED` `REJECTED` `DELIVERED` `CANCELLED` `FAILED`
`workflow`	`string`
`workflowSequence`	`integer`
`workflowUuid`	`string (uuid)`

WorkUnitImportDto

`creationDate`	`integer (int64)` When the import was requested (Unix time in milliseconds).
`endingDate`	`integer (int64)` When the import ended (Unix time in milliseconds). Null while it runs.
`error`	`stringWORK_UNIT_READ_ONLY` `WRONG_WORK_UNIT` `FILE_UNREADABLE` `NO_SEGMENTS` `TARGET_LANGUAGE_MISMATCH` `NO_SEGMENT_IDS` `NOTHING_UPDATED` `FAILED` Why the import ended in `ERROR`: `WORK_UNIT_READ_ONLY` (the work unit is cancelled, expired, or its previous step is still open), `WRONG_WORK_UNIT` (the file was exported from another work unit), `FILE_UNREADABLE`, `NO_SEGMENTS` (the file has no segments), `TARGET_LANGUAGE_MISMATCH` (the file's target language is not the work unit's), `NO_SEGMENT_IDS` (no segment has a `bwx:ts-id`), `NOTHING_UPDATED` (no longer reported: a file that writes no segment, for example an unchanged one, now ends `IMPORTED` with `segmentsUpdated` 0), or `FAILED` (an unexpected error). Null otherwise.
`id`	`string (uuid)` Id of the import: poll it with Get Work Unit Import.
`importType`	`stringXLIFF` `XLSX` Format of the imported file.
`segmentsConfirmed`	`integer` Of the segments written, how many are confirmed. Null while the import runs.
`segmentsInFile`	`integer` Segments in the file, locked ones included. Null while the import runs.
`segmentsLocked`	`integer` File segments skipped because they are locked: marked locked in the file (`translate="no"`, `bwx:locked="yes"`) or locked in the work unit since the file was exported. Null while the import runs.
`segmentsUpdated`	`integer` Segments written to the work unit. Null while the import runs.
`segmentsWithoutId`	`integer` File segments without a `bwx:ts-id`, which were skipped. Null while the import runs.
`status`	`stringSTARTED` `IMPORTED` `ERROR` `STARTED` while the import runs, then `IMPORTED` or `ERROR`.
`workUnitId`	`string (uuid)`

WorkUnitImportStatusDto

`importingCreationDate`	`integer (int64)` Not filled: always `null`.
`importingEndingDate`	`integer (int64)` When `importingStatus` last changed (Unix time in milliseconds), including when the import started.
`importingStatus`	`stringNOT_STARTED` `STARTED` `IMPORTED` `ERROR` State of the latest import of this format into the work unit.
`workUnitUuid`	`string (uuid)`

WorkUnitSlice

`assignedUuid`	`string (uuid)`
`batchId`	`string (uuid)`
`confirmedSegments`	`integer (int64)`
`deliverable`	`boolean`
`fromIndex`	`integer`
`hasTagMismatch`	`boolean`
`previousWorkflowAssignedUuid`	`string (uuid)`
`readOnly`	`boolean`
`taskUuid`	`string (uuid)`
`toIndex`	`integer`
`uuid`	`string (uuid)`

WorkUnitTmUpdate

The export of one translation memory for the work unit.

`jobId`	`integer (int64)` The export job. Poll it with Get Work Unit TM Update.
`status`	`string` The job's status when it was created: `SCHEDULED` while it waits for pending translation memory writes.
`tmName`	`string` The translation memory's name.
`tmUuid`	`string (uuid)` The translation memory.

WorkUnitTmUpdateJob

A TM update export job of a work unit.

`downloadUrl`	`string` Only when `status` is `COMPLETED`: a signed link to the TMX file, valid for one hour after the job completed.
`failureReason`	`string` Only when `status` is `FAILED`: why the export failed.
`jobId`	`integer (int64)`
`status`	`string` `STARTING`, `STARTED` or `SCHEDULED` while the job runs, then `COMPLETED` or `FAILED`.
`tmUuid`	`string (uuid)` The translation memory.
`translationUnits`	`integer (int64)` Only when `status` is `COMPLETED`: how many translation units the TMX holds. `0` means the work unit wrote nothing to this TM.

ZipProcessingStatusDto

`bytesProcessed`	`integer (int64)`
`failedEntries`	`integer`
`message`	`string`
`processedEntries`	`integer`
`processedProjectResources`	ProjectResourceDto[]
`status`	`string`
`taskId`	`string`
`totalEntries`	`integer`