reference

Org Units

3 endpoints

GET/api/v3/client

List Org Units

Requires: ORG_UNIT_list

query parameters

`country`	`string`
`currency`	`string`
`name`	`string`
`exactMatch`	`boolean`
`withoutOrganization`	`boolean`
`queryType`	`stringNOTIFICATION` `AUTOMATION` `LLM` `DEFAULT`
`targetUserUUID`	`string (uuid)`
`organizationUUID`	`string (uuid)`
`organizationUuids`	`string (uuid)[]`
`uuids`	`string (uuid)[]`
`restrictOwnAccount`	`boolean`
`autopilotEnabled`	`boolean`
`excludeOrgUnitIds`	`integer (int64)[]`
`excludeOrgUnitUuids`	`string (uuid)[]`
`organizationIds`	`integer (int64)[]`
`customFields`	`map<string, object>[]`
`customFieldsJson`	`string`
`sort`	`string`
`page`	`integer` Page to return, starting at 0.
`size`	`integer` Items per page.
`includeCustomFields`	`boolean`

Responses

200 OK

PageFatClientDto

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

Request

curl -X GET 'https://app.wxrks.com/api/v3/client' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": false,
    "sort": {},
    "unpaged": false
  },
  "size": 0,
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "totalElements": 0,
  "totalPages": 0
}

POST/api/v3/client

Create Org Unit

Requires: ORG_UNIT_create

Request body

ClientCreateDtoV3

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

Responses

200 OK

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`

Request

curl -X POST 'https://app.wxrks.com/api/v3/client' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "addLoggedUserToClient": false,
  "contactPersonUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "country": "string",
  "currency": "string",
  "name": "string",
  "organizationUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timezone": "string"
}'

Response 200

{
  "autopilotEnabled": false,
  "contactPersonEmailNotifications": false,
  "continuousPlatformTag": "string",
  "daysUntilPaymentDue": 0,
  "defaultAtlasCatTool": false,
  "id": 0,
  "invoiceInfo": "string",
  "localeRegion": {},
  "name": "string",
  "projectAutomationEnabled": false,
  "projectManagerEmailNotifications": false,
  "showPaymentPolicy": false,
  "tags": [
    "string"
  ],
  "users": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendorEmailNotifications": false
}

GET/api/v3/client/{clientUuid}

Get Org Unit

Requires: ORG_UNIT_get_by_id

path parameters

clientUuidrequired string (uuid)

Responses

200 OK

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`

Request

curl -X GET 'https://app.wxrks.com/api/v3/client/{clientUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "accountCode": "string",
  "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "address": {
    "additionalInfo": "string",
    "city": "string",
    "neighborhood": "string",
    "number": "string",
    "state": "string",
    "street": "string",
    "zip": "string"
  },
  "aiReviewEnabled": false,
  "autoBilling": false,
  "autopilotEnabled": false,
  "billingEmail": "string",
  "categorizationDisabled": false,
  "clientLanguages": "string",
  "confidenceMatchOverRepetitionEnabled": false,
  "consolidateProjects": false,
  "contactNotes": "string",
  "contactPerson": {
    "avatar": "string",
    "currency": "string",
    "email": "string",
    "id": 0,
    "name": "string",
    "status": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "contactPersonEmailNotifications": false,
  "continuousPlatformTag": "string",
  "continuousProjectConfig": "string",
  "continuousSealed": false,
  "contract": false,
  "contractEndDate": 0,
  "contractStartDate": 0,
  "costsLogfileType": "PRE_ANALYSE",
  "country": "string",
  "currency": "string",
  "customFields": [
    {}
  ],
  "customReceivableByUser": false,
  "daysUntilPaymentDue": 0,
  "defaultProjectManager": {
    "avatar": "string",
    "currency": "string",
    "email": "string",
    "id": 0,
    "name": "string",
    "status": "string",
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "defaultSourceLanguage": "string",
  "disableMachineTranslate": false,
  "disabledQualityFilter": false,
  "disabledRateFilter": false,
  "disabledTagFilter": false,
  "emails": [
    "string"
  ],
  "externalId": "string",
  "id": 0,
  "ignoreTranslationMemories": false,
  "instructions": "string",
  "invoiceGroupingKey": "string",
  "invoiceInfo": "string",
  "invoicingType": "string",
  "isClientTerminology": false,
  "isolatedTags": false,
  "localeRegion": {},
  "logo": "string",
  "memo": "string",
  "mobile": "string",
  "mtSettings": {
    "accountUuid": "string",
    "active": false,
    "credentials": "string",
    "isCredentialValid": false,
    "name": "string",
    "provider": "string",
    "reason": "string",
    "reasonCode": "string",
    "sourceLanguage": "string",
    "targetLanguage": "string",
    "text": "string",
    "translated": "string",
    "type": "DEFAULT",
    "updateAt": 0,
    "updatedAt": 0,
    "uuid": "string"
  },
  "name": "string",
  "netRateSettings": {
    "account": {},
    "default": false,
    "defaultGlobal": false,
    "id": 0,
    "isFromPriceList": false,
    "matchRanges": [],
    "name": "string",
    "netRateWorkflows": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "notes": "string",
  "notifyProjectComments": false,
  "notifyZendeskEnabled": false,
  "ntMatchOverRepetitionEnabled": false,
  "organization": {
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "country": "string",
    "customFields": [],
    "id": 0,
    "logo": "string",
    "mtSettings": {},
    "name": "string",
    "orgUnitDrafts": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "overrideDefaultRegex": false,
  "paymentMethod": "CHECK",
  "phone": "string",
  "projectAutomationEnabled": false,
  "projectCountWordsFrom": "SOURCE",
  "projectManagerEmailNotifications": false,
  "quickBooksId": "string",
  "quickBooksProductServiceId": "string",
  "quoteNotes": [
    {}
  ],
  "regex": "string",
  "sendAvailableTasksEmail": false,
  "sendInvoiceToRequester": false,
  "sendLearntToKanban": false,
  "sendQuoteAuto": false,
  "sendReceivableEmailNotification": false,
  "settings": {
    "codeUomAbbreviationEnabled": false,
    "updatePropagatedRepetitions": false,
    "workflows": []
  },
  "showPaymentPolicy": false,
  "showRequester": false,
  "splitLargeJobs": false,
  "status": "string",
  "tags": [
    "string"
  ],
  "taskCountWordsFrom": "SOURCE",
  "taskPaymentType": "WORD",
  "taxInfo": {
    "issueNfe": false,
    "municipalRegistration": "string",
    "requirePurchaseOrder": false,
    "retainIr": false,
    "retainIss": false,
    "simplesNacional": false
  },
  "taxpayerId": "string",
  "timezone": "string",
  "tmMatchOverRepetitionEnabled": false,
  "trackingCategory": "string",
  "trackingCategoryType": "string",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendorEmailNotifications": false,
  "webhookEnabled": false,
  "website": "string",
  "xeroId": "string",
  "zendeskUrl": "string",
  "zendeskUser": "string"
}