reference

Net Rate

3 endpoints

GET/api/v3/net-rate-settings/{uuid}

Get Net Rate Settings

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

path parameters

uuidrequired string (uuid)

Responses

200 OK

NetRateSettingsDto

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

Request

curl -X GET 'https://app.wxrks.com/api/v3/net-rate-settings/{uuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "account": {
    "active": false,
    "aiReviewEnabled": false,
    "allowInviteUsers": false,
    "certificates": [],
    "costsLogfileType": "PRE_ANALYSE",
    "createDate": 0,
    "customProjectCancellationOptionsEnabled": false,
    "customReviewCategorizationEnabled": false,
    "customSubdomain": "string",
    "disabledQualityFilter": false,
    "disabledRateFilter": false,
    "disabledTagFilter": false,
    "emailDomain": "string",
    "logoUrl": "string",
    "name": "string",
    "notifyZendeskEnabled": false,
    "payoneerApiUrl": "string",
    "payoneerAuthUrl": "string",
    "payoneerClientId": "string",
    "payoneerClientSecret": "string",
    "payoneerProgramId": "string",
    "projectAutomationEnabled": false,
    "sendLearntToKanban": false,
    "settings": {},
    "ssoClientId": "string",
    "ssoClientSecret": "string",
    "ssoDomains": {},
    "ssoUrl": "string",
    "status": "ACTIVE",
    "stripeId": "string",
    "subdomain": "string",
    "subscriptionId": "string",
    "type": "CLI",
    "useCustomReviewCategoriesOnly": false,
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "default": false,
  "defaultGlobal": false,
  "id": 0,
  "isFromPriceList": false,
  "matchRanges": [
    {}
  ],
  "name": "string",
  "netRateWorkflows": [
    {}
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

GET/api/v3/net-rate-settings/list-account

List Account Net Rate Settings

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

Responses

200 OK

NetRateSettingsDto[]

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

Request

curl -X GET 'https://app.wxrks.com/api/v3/net-rate-settings/list-account' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "account": {},
    "default": false,
    "defaultGlobal": false,
    "id": 0,
    "isFromPriceList": false,
    "matchRanges": [],
    "name": "string",
    "netRateWorkflows": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]

GET/api/v3/net-rate-settings/list-org-unit-account/{orgUnitUuid}

List Org Unit Net Rate Settings

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

path parameters

orgUnitUuidrequired string (uuid)

Responses

200 OK

NetRateSettingsDto[]

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

Request

curl -X GET 'https://app.wxrks.com/api/v3/net-rate-settings/list-org-unit-account/{orgUnitUuid}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

[
  {
    "account": {},
    "default": false,
    "defaultGlobal": false,
    "id": 0,
    "isFromPriceList": false,
    "matchRanges": [],
    "name": "string",
    "netRateWorkflows": [],
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
]