reference

Accounting

13 endpoints

Payables

GET/api/v3/payable

List Payables

Requires: PAYABLES_get_payables

query parameters

`vendorName`	`string`
`name`	`string`
`creationDate.start`	`string`
`creationDate.end`	`string`
`dueDate.start`	`string`
`dueDate.end`	`string`
`statuses`	`string[]`
`vendor`	`integer (int64)`
`missingAccountingInfo`	`boolean`
`paymentMethods`	`string[]`
`serviceProviderAccountUuids`	`string (uuid)[]` Payables approved and paid by these service provider accounts
`withoutServiceProvider`	`boolean` Payables approved and paid by the account itself; combined with serviceProviderAccountUuids, either one matches
`sort`	`string`
`page`	`integer` Page to return, starting at 0.
`size`	`integer` Items per page.

Responses

200 OK

PagePayableDto

`content`	PayableDto[]
`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/payable' \
  -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
}

DELETE/api/v3/payable/{payableId}/invoice-file

Get Payable

Requires: PAYABLES_get_payables

path parameters

payableUuidrequired string (uuid)

Responses

200 OK

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`

Request

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

Response 200

{
  "amount": 0,
  "amountBeforeTaxes": 0,
  "creationDate": 0,
  "currency": "string",
  "customFields": [
    {}
  ],
  "dueDate": 0,
  "errorMessage": "string",
  "exchangeRateByCurrency": {},
  "id": 0,
  "lastUpdate": 0,
  "name": "string",
  "notes": "string",
  "oldTasksInvoiced": [
    {}
  ],
  "origin": "string",
  "overallProfitability": 0,
  "paidBy": 0,
  "payableFiles": [
    "string"
  ],
  "paymentDate": 0,
  "payoutMethod": "string",
  "serviceProviderAccountName": "string",
  "serviceProviderAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "tasks": [
    {}
  ],
  "taxes": [
    {}
  ],
  "taxesAmount": 0,
  "totalAllocations": 0,
  "totalTasks": 0,
  "updatedBy": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendor": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "vendorMonthlyAverage": 0,
  "xeroId": "string"
}

PUT/api/v3/payable/{payableUuid}/approve

Approve Payable

Requires: PAYABLES_approve

path parameters

payableUuidrequired string (uuid)

Responses

200 OK

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`

Request

curl -X PUT 'https://app.wxrks.com/api/v3/payable/{payableUuid}/approve' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "amount": 0,
  "amountBeforeTaxes": 0,
  "creationDate": 0,
  "currency": "string",
  "customFields": [
    {}
  ],
  "dueDate": 0,
  "errorMessage": "string",
  "exchangeRateByCurrency": {},
  "id": 0,
  "lastUpdate": 0,
  "name": "string",
  "notes": "string",
  "oldTasksInvoiced": [
    {}
  ],
  "origin": "string",
  "overallProfitability": 0,
  "paidBy": 0,
  "payableFiles": [
    "string"
  ],
  "paymentDate": 0,
  "payoutMethod": "string",
  "serviceProviderAccountName": "string",
  "serviceProviderAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "string",
  "tasks": [
    {}
  ],
  "taxes": [
    {}
  ],
  "taxesAmount": 0,
  "totalAllocations": 0,
  "totalTasks": 0,
  "updatedBy": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "vendor": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "vendorMonthlyAverage": 0,
  "xeroId": "string"
}

PUT/api/v3/payable/{payableUuid}/cancel-payable

Create Payable for an Account

Requires: PAYABLES_create

Request body

PayableRequest

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

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v3/payable/create' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "currencyRates": [],
  "dueDate": 0,
  "endDate": 0,
  "startDate": 0,
  "vendorUuidList": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

POST/api/v3/payable/import/{accountUuid}

Import Payables from Spreadsheet

Requires: PAYABLES_import

path parameters

accountUuidrequired string (uuid)

query parameters

`timezone`	`string`
`serviceProviderAccountUuid`	`string (uuid)`

Request body

objectmultipart/form-data

Responses

200 OK

string (uuid)

Request

curl -X POST 'https://app.wxrks.com/api/v3/payable/import/{accountUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -F 'file=@./file'

Response 200

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

POST/api/v3/payable/import/{accountUuid}/json

Import Payables from JSON

Requires: PAYABLES_import

path parameters

accountUuidrequired string (uuid)

Request body

PayableBatchRequestDto

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

Responses

200 OK

PayableBatchResultDto

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

Request

curl -X POST 'https://app.wxrks.com/api/v3/payable/import/{accountUuid}/json' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "payables": [],
  "serviceProviderAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "timezone": "string"
}'

Response 200

{
  "created": [
    {}
  ],
  "errorCount": 0,
  "errors": {},
  "successCount": 0,
  "totalRows": 0
}

GET/api/v3/payable/import/status/{requestUuid}

Payable Summary

Requires: PAYABLES_get_summary

query parameters

`vendorName`	`string`
`name`	`string`
`creationDate.start`	`string`
`creationDate.end`	`string`
`dueDate.start`	`string`
`dueDate.end`	`string`
`statuses`	`string[]`
`vendor`	`integer (int64)`
`missingAccountingInfo`	`boolean`
`paymentMethods`	`string[]`
`serviceProviderAccountUuids`	`string (uuid)[]` Payables approved and paid by these service provider accounts
`withoutServiceProvider`	`boolean` Payables approved and paid by the account itself; combined with serviceProviderAccountUuids, either one matches
`sort`	`string`
`page`	`integer` Page to return, starting at 0.
`size`	`integer` Items per page.

Responses

200 OK

PayablesSummaryDto

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

Request

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

Response 200

{
  "separationByCurrency": {},
  "separationByPaymentMethod": {},
  "total": 0,
  "totalCurrency": "string"
}

Receivables

GET/api/v3/receivables

Bills projects of one org unit to one of its contacts: contactUser is a user of that org unit or of its organization, and any other user answers 422. The org unit, the contact and every project must be yours, and the projects that org unit's; projects are referenced by id. Totals, taxes and installments are computed by wxrks.

Request body

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[]

Responses

200 OK

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`

Request

curl -X POST 'https://app.wxrks.com/api/v3/receivables' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "organizationalUnit": {
    "uuid": "6b1f0c2e-8d4a-4f3b-9c5e-2a7d9e1b4c60"
  },
  "contactUser": {
    "uuid": "3b6e9d2a-4c8f-4e15-a7b3-9f2d6c0a5e81"
  },
  "projects": [
    {
      "id": 12345
    }
  ],
  "currency": "USD",
  "dueDate": 1767225600000,
  "purchaseOrder": "PO-1001"
}'

Response 200

{
  "cancelledDate": 0,
  "contact": "string",
  "contactUser": {
    "accessKey": "string",
    "accessKeyTimestamp": 0,
    "accountOwner": false,
    "accountType": "CLI",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "address2": "string",
    "admin": false,
    "assignedJobs": 0,
    "avatar": "string",
    "captcha": "string",
    "cellPhone": "string",
    "city": "string",
    "companyName": "string",
    "completedJobs": 0,
    "country": "string",
    "currency": "string",
    "customFields": [],
    "dailyRate": 0,
    "defaultWorkflowRates": [],
    "deleteAllLanguagePair": false,
    "email": "string",
    "emailMagicCode": "string",
    "entryPoint": "WORKS_HOME",
    "externalId": "string",
    "forwardUrl": "string",
    "hourlyRate": 0,
    "id": 0,
    "invoicingDayOfMonth": "DAY_15",
    "invoicingPeriodicity": 0,
    "lastAccessAt": 0,
    "messageError": "string",
    "messageWarning": "string",
    "mfa": 0,
    "mfaEnabled": false,
    "minimumFee": 0,
    "name": "string",
    "nameEmail": "string",
    "newPassword": "string",
    "notes": "string",
    "notifyUser": false,
    "orgUnits": [],
    "organizations": [],
    "pagesRate": 0,
    "parentUserUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "paymentMethod": "PAYONEER",
    "payoneerId": "string",
    "paypalAccount": "string",
    "permissionGroups": [],
    "phone": "string",
    "postalCode": "string",
    "productName": "string",
    "punctuality": 0,
    "quickBooksVendorId": "string",
    "roles": [],
    "skypeId": "string",
    "slackHandle": "string",
    "state": "string",
    "status": "Active",
    "subUser": false,
    "subscriptions": [],
    "supportedLanguagePairs": [],
    "tags": [],
    "targetAccountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tasksCompletedCount": 0,
    "taxId": "string",
    "taxpayerId": "string",
    "timezone": "string",
    "totalJobs": 0,
    "useProjectCurrency": false,
    "userQualityMetrics": {},
    "userRates": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "wordRate": 0
  },
  "creationDate": 0,
  "currency": "string",
  "customFields": [
    {}
  ],
  "customReceivableByUser": false,
  "dueDate": 0,
  "equally": false,
  "firstInstallmentValue": 0,
  "id": 0,
  "installments": [
    {}
  ],
  "intervalBetweenDues": 0,
  "invoiceFirstOnly": false,
  "manualInvoice": false,
  "multipleInstallments": false,
  "netAmount": 0,
  "nfId": 0,
  "numInstallments": 0,
  "oldProjectsInvoiced": [
    {}
  ],
  "organizationalUnit": {
    "costsLogfileType": "PRE_ANALYSE",
    "country": "string",
    "id": 0,
    "localeRegion": {},
    "name": "string",
    "organization": {},
    "projectCountWordsFrom": "SOURCE",
    "sourceLanguage": "string",
    "targetLanguages": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "paidAmount": 0,
  "paymentDate": 0,
  "paymentNotesAccount": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "projects": [
    {}
  ],
  "purchaseOrder": "string",
  "reference": "string",
  "status": "INVOICED",
  "taxAmount": 0,
  "taxes": [
    {}
  ],
  "total": 0,
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "xeroId": "string"
}

POST/api/v3/receivables/cancel-receivable

Cancel Receivable

Requires: RECEIVABLES_update

Request body

ReceivablePaidDto

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

Responses

200 OK

object

Request

curl -X POST 'https://app.wxrks.com/api/v3/receivables/cancel-receivable' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "invoiceUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "paymentDate": 0
}'

`orgUnitUuid`	`string (uuid)`
`orgUnitName`	`string`
`projectName`	`string`
`id`	`integer (int64)`
`creationDate.start`	`string`
`creationDate.end`	`string`
`dueDate.start`	`string`
`dueDate.end`	`string`
`statuses`	`string[]`
`purchaseOrder`	`string`
`sort`	`string`
`page`	`integer` Page to return, starting at 0.
`size`	`integer` Items per page.

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