{"info":{"_postman_id":"2c8fbd2d-49b6-469c-89a9-80c74dee5c11","name":"OOONA Manager Api🌐","description":"

\n\n

Subtitling workflow between OOONA Manager/Integrated and External systems
API needs to be served over https with at least basic auth

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7118824","collectionId":"2c8fbd2d-49b6-469c-89a9-80c74dee5c11","publishedId":"2s9YkkehRE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-12-14T11:05:27.000Z"},"item":[{"name":"📤Outgoing","item":[{"name":"✍️Post","item":[{"name":"🛠️Outgoing Task","item":[{"name":"📁FileDelivery","id":"feecafc8-6630-437e-b1ec-20a142eefeed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderNumber\": \"\",\r\n \"product\": \"\",\r\n \"productId\": \"\",\r\n \"language\": \"\",\r\n \"task\": \"\",\r\n \"version\": \"\",\r\n \"originalFileCode\": \"\", //The file name as it uas uploaded to the storage server and the name it should be downloaded with | will be availble in version 369\r\n \"fileCode\": \"\",\r\n \"fileUrl\": \"\", //A pre-singed url with an experation time for download \r\n \"filePath\": \"\", //The file path on storage server | will be availble in version 369\r\n \"fileName\": \"\", //The file name as it is stored on the storage server | will be availble in version 369\r\n \"fileOriginalName\": \"\", // The file name as it should be downloaded | will be availble in version 369\r\n \"fileExtention\": \"\", // The file Extention e.g (txt,png,890) | will be availble in version 369\r\n \"storageServer\": \"\", // The file Storage Server Name as configured in OM storage serves configuration page | will be availble in version 369 \r\n \"fullPath\": \"\" //a conctuated storageServer + filePath + fileName + fileExtention | will be availble in version 369 \r\n}","options":{"raw":{"language":"json"}}},"url":"/FileDelivery","description":"

Triggered when a file is loaded to notify customer system of the new file availbility.

\n","urlObject":{"path":["FileDelivery"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7faa9f69-f4da-427f-9bad-33925174f9ce","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"language\": \"\",\n \"task\": \"\",\n \"version\": \"\",\n \"originalFileCode\": \"\", //The file name as it uas uploaded to the storage server and the name it should be downloaded with | will be availble in version 369\n \"fileCode\": \"\",\n \"fileUrl\": \"\", //A pre-singed url with an experation time for download \n \"filePath\": \"\", //The file path on storage server | will be availble in version 369\n \"fileName\": \"\", //The file name as it is stored on the storage server | will be availble in version 369\n \"fileOriginalName\": \"\", // The file name as it should be downloaded | will be availble in version 369\n \"fileExtention\": \"\", // The file Extention e.g (txt,png,890) | will be availble in version 369\n \"storageServer\": \"\", // The file Storage Server Name as configured in OM storage serves configuration page | will be availble in version 369 \n \"fullPath\": \"\" //a conctuated storageServer + filePath + fileName + fileExtention | will be availble in version 369 \n}"},"url":"/FileDelivery"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a6a56d5e-94c2-4f83-ad88-7c49ba551a04","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"language\": \"\",\n \"task\": \"\",\n \"version\": \"\",\n \"originalFileCode\": \"\", //The file name as it uas uploaded to the storage server and the name it should be downloaded with | will be availble in version 369\n \"fileCode\": \"\",\n \"fileUrl\": \"\", //A pre-singed url with an experation time for download \n \"filePath\": \"\", //The file path on storage server | will be availble in version 369\n \"fileName\": \"\", //The file name as it is stored on the storage server | will be availble in version 369\n \"fileOriginalName\": \"\", // The file name as it should be downloaded | will be availble in version 369\n \"fileExtention\": \"\", // The file Extention e.g (txt,png,890) | will be availble in version 369\n \"storageServer\": \"\", // The file Storage Server Name as configured in OM storage serves configuration page | will be availble in version 369 \n \"fullPath\": \"\" //a conctuated storageServer + filePath + fileName + fileExtention | will be availble in version 369 \n}"},"url":"/FileDelivery"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"feecafc8-6630-437e-b1ec-20a142eefeed"},{"name":"📝ChangeNotification","id":"8c3ba32f-2330-445e-8799-e871bb2016a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"productStatus\": \"\",\n \"productProgress\": \"\",\n \"language\": \"\",\n \"languageStatus\": \"\",\n \"languageProgress\": \"\",\n \"task\": \"\",\n \"taskStatus\": \"\",\n \"orderStatus\": \"\",\n \"orderProgress\": \"\",\n \"projectId\": \"\",\n \"projectCode\": \"\",\n \"taskNumber\": \"\",\n \"taskUniqueOrderId\": \"\",\n \"taskCompletedDate\": \"\",\n \"fileName\": \"\",\n \"filePath\": \"\",\n \"duration\": \"\",\n \"supplierDuration\": \"\",\n \"resourceCode\": \"\",\n \"resourceName\": \"\",\n \"cost\": \"\",\n \"sourceTypeId\": \"\",\n \"packageId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/ChangeNotification","description":"

Triggered when in two cases:

A task is completed to notify customer system a task was completed.
\n
An order was created (will be available in 369)
\n

How it works:

The payload is built dynamically from configurable parameters. The fields below are the default set (25 fields total). Per-API overrides may customize field names.

Important:

Field names are configurable per external API integration
\n
Not all fields may be populated for every notification — depends on context (task-level vs order-level)
\n

\n","urlObject":{"path":["ChangeNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8c2cf4c0-6aba-4f7c-bfe5-f9572c41c2d4","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"orderNumber\": \"\",\r\n \"product\": \"\",\r\n \"productId\": \"\",\r\n \"productStatus\": \"\",\r\n \"productProgress\": \"\",\r\n \"language\": \"\",\r\n \"languageStatus\": \"\",\r\n \"languageProgress\": \"\",\r\n \"task\": \"\",\r\n \"taskStatus\": \"\",\r\n \"orderStatus\": \"\",\r\n \"orderProgress\": \"\"\r\n}"},"url":"/ChangeNotification"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"636e100a-663b-4fbf-92dc-26c4cc083744","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"productStatus\": \"\",\n \"productProgress\": \"\",\n \"language\": \"\",\n \"languageStatus\": \"\",\n \"languageProgress\": \"\",\n \"task\": \"\",\n \"taskStatus\": \"\",\n \"orderStatus\": \"\",\n \"orderProgress\": \"\"\n}"},"url":"/ChangeNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"8c3ba32f-2330-445e-8799-e871bb2016a8"},{"name":"📝FieldChangeNotification","id":"6dd6ec98-d44e-4877-aef5-a34f1b78830f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"extApiId\": \"\",\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"language\": \"\",\n \"languageId\": \"\",\n \"task\": \"\",\n \"taskNumber\": \" will be deprecated in future versions for naming consistency\",\n \"taskUniqueOrderId\": \"\",\n \"projectCode\": \"\",\n \"projectId\": \"\",\n \"fileCode\": \"\",\n \"languageCode\": \"\",\n \"mediaNumber\": \"\",\n \"fieldName\": \"\",\n \"originalValue\": \"\",\n \"newValue\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/FieldChangeNotification","description":"

Triggered when a field is changed and matches Custom system notifications

This will be availble in version 369

\n","urlObject":{"path":["FieldChangeNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4ca14347-9035-428e-9dc9-c2e9445b951c","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"{\r\n \"orderNumber\": \"\",\r\n \"product\": \"\",\r\n \"productId\": \"\",\r\n \"language\": \"\",\r\n \"languageId\": \"\",\r\n \"task\": \"\",\r\n \"taskNumber\": \" will be deprecated in future versions for naming consistency\",\r\n \"taskUniqueOrderId\": \"\",\r\n \"fieldName\": \"\",\r\n \"originalValue\": \"\",\r\n \"newValue\": \"\"\r\n \r\n}"},"url":"/FieldChangeNotification"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"55dfff73-2616-460d-8e53-d5c8c0647a58","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"language\": \"\",\n \"languageId\": \"\",\n \"task\": \"\",\n \"taskNumber\": \" will be deprecated in future versions for naming consistency\",\n \"taskUniqueOrderId\": \"\",\n \"fieldName\": \"\",\n \"originalValue\": \"\",\n \"newValue\": \"\"\n}"},"url":"/FieldChangeNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"6dd6ec98-d44e-4877-aef5-a34f1b78830f"},{"name":"🤖SemiautomaticNotification","id":"01535074-2793-4aca-a872-c5876cc696da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderNumber\": \"\",\r\n \"tempOrderNumber\": \"\",\r\n \"id\": \"\",\r\n \"error\": \"\",\r\n \"message\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/SemiautomaticNotification","description":"

In semiautomatic mode this end point is used to notify of new order created and permanent changes made by specific requests

\n","urlObject":{"path":["SemiautomaticNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0ed0d1d3-f313-43a4-8d33-9acbcb5383a3","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"orderNumber\": \"\",\r\n \"tempOrderNumber\": \"\",\r\n \"id\": \"\",\r\n \"error\": \"\",\r\n \"message\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/SemiautomaticNotification"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7bfca395-48c9-4666-901d-525bd077c122","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"tempOrderNumber\": \"\",\n \"id\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/SemiautomaticNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"},{"id":"cfd67e95-1c22-4bfd-a10d-2c2e7706af58","name":"⛔409","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"tempOrderNumber\": \"\",\n \"id\": \"\",\n \"error\": \"\",\n \"message\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/SemiautomaticNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"01535074-2793-4aca-a872-c5876cc696da"}],"id":"3627e684-363e-428c-b17a-18a37267c229","_postman_id":"3627e684-363e-428c-b17a-18a37267c229","description":""},{"name":"⛭ApiActivity","item":[{"name":"🟢ApiEnable","id":"8e3add22-667b-43cc-b1d4-356a7d18efd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"/ApiEnable","urlObject":{"path":["ApiEnable"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"93db988e-9ebc-4788-9908-9b258e240b4c","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n}"},"url":"/ApiEnable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"716d75aa-bf12-4116-bb1a-dc0e06d9666b","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"error\": \"\",\n}"},"url":"/ApiEnable"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"8e3add22-667b-43cc-b1d4-356a7d18efd8"},{"name":"🔴ApiDisable","id":"02e587e4-ab38-4240-b21d-ed06cbe093cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"/ApiDisable","urlObject":{"path":["ApiDisable"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b75ace07-d938-4c1f-8ad5-52cbc37387db","name":"✅200","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"message\": \"\",\n}"},"url":"/ApiDisable"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a0656ec2-32e7-4dc9-ab10-b7c9d0fadd14","name":"⛔400","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"*/*"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"error\": \"\",\n}"},"url":"/ApiDisable"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"02e587e4-ab38-4240-b21d-ed06cbe093cb"}],"id":"e294a089-063a-42ba-878a-c7bf64201f62","description":"

Provides the ability to enable or disable the external API.

When the API is disabled, all endpoints except for the Authentication endpoint will return a \"disabled\" error response.

Will be availble in version 3681 and above

\n","_postman_id":"e294a089-063a-42ba-878a-c7bf64201f62"}],"id":"a0ee9729-a9b4-4d67-999d-206786384743","_postman_id":"a0ee9729-a9b4-4d67-999d-206786384743","description":""}],"id":"924c8ba8-1400-400e-89b7-e8ce330f9c39","description":"

This folder contains all the endpoints OOONA Manager is able to conect in external systms to respond to.

The actuall URL , Endpoint names and Parameter names can be adjusted in the TM API configuration.

","_postman_id":"924c8ba8-1400-400e-89b7-e8ce330f9c39"},{"name":"📥Incoming","item":[{"name":"🫴 Get","item":[{"name":"🔣UnitsTypes","id":"736d5cdb-7cfd-4fcf-ba46-7e844c2c8464","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/UnitsTypes","description":"

used to retrieve the Units types list and codes

\n","urlObject":{"path":["UnitsTypes"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[],"variable":[]}},"response":[{"id":"309f47fd-68e8-43ef-8110-af0c3c92e6e0","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/UnitsTypes"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"description\": \"\"\n}"},{"id":"e9937b2c-4ea1-41c9-a5ed-03e9b93e4a33","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/api/ExternalTmApi/UnitsTypes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"736d5cdb-7cfd-4fcf-ba46-7e844c2c8464"},{"name":"📋Tasks ✏️","id":"3c6c2c6d-b208-4526-993c-92b8925ee891","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/Tasks?taskGroup=","description":"

used to retrieve the tasks list and codes

\n","urlObject":{"path":["Tasks"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[{"description":{"content":"

(Optional)

\n","type":"text/plain"},"key":"taskGroup","value":""}],"variable":[]}},"response":[{"id":"7c02e396-eb50-41b2-83bb-8b5f18a2d2a2","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/Tasks"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"\",\n \"description\": \"\",\n \"taskGroupCode\": \" Will be availble in Version 369\",\n \"taskGroupDescription\": \" Will be availble in Version 369\"\n }\n]"},{"id":"66f3a4fe-6ce8-4492-94f7-81648281b20f","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/Tasks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"3c6c2c6d-b208-4526-993c-92b8925ee891"},{"name":"📋TaskGroup","id":"f20a3ad1-23bb-4336-a4ae-38829a7cf952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/TaskGroup","description":"

used to retrieve the task group list and codes

Will be availble in Version 369

\n","urlObject":{"path":["TaskGroup"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[],"variable":[]}},"response":[{"id":"61455023-53f7-4d73-b322-a7e4a7f36599","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/TaskGroup"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n]"},{"id":"18b2c330-9b06-45a3-a706-bbe72bf81088","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/TaskGroup"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"f20a3ad1-23bb-4336-a4ae-38829a7cf952"},{"name":"📄Templates","id":"68e0778a-200a-47ba-9066-313767fe96de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/Templates?type=&consolidatedAccount=&customer=&series=","description":"

used to retrieve the template list and codes

\n","urlObject":{"path":["Templates"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[{"key":"type","value":""},{"key":"consolidatedAccount","value":""},{"key":"customer","value":""},{"key":"series","value":""}],"variable":[]}},"response":[{"id":"c32fdd6c-f73f-49b0-9518-5ff95830aab4","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Templates?type=&consolidatedAccount=&customer=&series=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Templates"],"query":[{"key":"type","value":""},{"key":"consolidatedAccount","value":""},{"key":"customer","value":""},{"key":"series","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"description\": \"\",\n \"type\": \"\",\n \"consolidatedAccount\": \"\",\n \"customer\": \"\",\n \"series\": \"\"\n}"},{"id":"832edf34-9070-493a-8253-335e64001863","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Templates?type=&consolidatedAccount=&customer=&series=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Templates"],"query":[{"key":"type","value":""},{"key":"consolidatedAccount","value":""},{"key":"customer","value":""},{"key":"series","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"68e0778a-200a-47ba-9066-313767fe96de"},{"name":"🟡Status","id":"f63aefa4-428e-440f-a3a3-1ff6a2a58f34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{baseUrl}}{{apiRoot}}/Status","description":"

used to retrieve the Status list and codes that the API can change an order into.

\n","urlObject":{"path":["Status"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[],"variable":[]}},"response":[{"id":"a3373077-000d-4150-be99-6c4daa54f614","name":"✅200","originalRequest":{"method":"GET","header":[],"url":"[object Object]"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"description\": \"\"\n}"},{"id":"0a4f717a-36a1-410e-a942-20dc8b363439","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"},{"key":"AuthToken","value":"","description":"(Required) "}],"url":"{{baseUrl}}/api/ExternalTmApi/Status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"f63aefa4-428e-440f-a3a3-1ff6a2a58f34"},{"name":"🧑‍💼SalesPersons","id":"efa8df66-92d7-450f-b9f1-480de4bee54e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/SalesPersons","description":"

used to retrieve the resource list that are sales persons (will be available in 3681)

\n","urlObject":{"path":["SalesPersons"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[],"variable":[]}},"response":[{"id":"61921aae-8343-4da9-b36a-0927690e879a","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/SalesPersons"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"description\": \"\"\n}"},{"id":"8a0882fa-dc74-406f-b28b-9f4bdd1d2415","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/SalesPersons"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"efa8df66-92d7-450f-b9f1-480de4bee54e"},{"name":"🧑Resource","id":"7c33b475-f816-4b48-828b-9eff01d52678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"AuthToken","value":"{{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{baseUrl}}/api/ExternalTmApi/Resource?resourceCode=&resourceName=","description":"

Retrieves the abilities of a resource (Languages From/To, Tasks, Order Types) by resourceCode or resourceName.

resourceName is a string
\n
resourceCode is an integer.
\n

Will be availble in Version 369

\n","urlObject":{"path":["api","ExternalTmApi","Resource"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Integer USER_CODE of the resource

\n","type":"text/plain"},"key":"resourceCode","value":""},{"description":{"content":"

string USER_NAME of the resource

\n","type":"text/plain"},"key":"resourceName","value":""}],"variable":[]}},"response":[{"id":"6a8d370b-fb95-4382-aea2-038cc6bd8eff","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{basicAuthToken}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Resource?resourceCode=&resourceName=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Resource"],"query":[{"key":"resourceCode","value":""},{"key":"resourceName","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"name\": \"\",\n \"firstName\": \"\", // Will be availble in Version 369\n \"lastName\": \"\", // Will be availble in Version 369\n \"email\": \"\", // Will be availble in Version 369\n \"activeLogins\": [\n {\n \"loginName\": \"\",\n \"loginEmail\": \"\",\n \"twoFactorAuth\": \"\", //\"Inherited - Yes\" / \"Inherited - No\" / \"Yes\" / \"No\"\n \"isLockedOut\": \"\",\n \"isApproved\": \"\"\n }\n ],\n \"languagesPair\": [{ \"sourceCode\": \"\", \"sourceDescription\": \"\", \"targetCode\": \"\", \"targetDescription\": \"\" }],\n \"languagesFrom\": [\n { \"code\": \"\", \"description\": \"\" },\n { \"code\": \"\", \"description\": \"\" }\n ],\n \"languagesTo\": [\n { \"code\": \"\", \"description\": \"\" }\n ],\n \"tasks\": [\n { \"code\": \"\", \"description\": \"\" },\n { \"code\": \"\", \"description\": \"\" }\n ],\n \"orderTypes\": [\n { \"code\": \"\", \"description\": \"\" }\n ]\n}"},{"id":"8115672c-4335-40a4-81c1-ee355abab07b","name":"⛔400","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Resource?resourceCode=&resourceName=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Resource"],"query":[{"key":"resourceCode","value":"","type":"text"},{"key":"resourceName","value":"","type":"text"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"7c33b475-f816-4b48-828b-9eff01d52678"},{"name":"🧑Resources","id":"70a5da02-8918-40fe-b7e9-cac9b8102713","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/Resources?orderType=&sourceLanguage=&targetLanguage=&task=&pageSize=&page=&sortBy= &contains=","description":"

Used to retrieve the resource list and codes matching the criteria.

How it works:

Send a GET request with optional filter parameters. Without filters, returns all active resources (paginated).

Important:

All filter parameters (orderType, sourceLanguage, targetLanguage, task) are optional
\n
When a filter is set to 0 or omitted, it is ignored
\n
Use pageSize and page for pagination
\n
Use sortBy and contains for sorting and searching
\n

\n","urlObject":{"path":["Resources"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[{"description":{"content":"

(Optional) Filter by order type. 0 or omitted = no filter.

\n","type":"text/plain"},"key":"orderType","value":""},{"description":{"content":"

(Optional) Filter by source language. 0 or omitted = no filter.

\n","type":"text/plain"},"key":"sourceLanguage","value":""},{"description":{"content":"

(Optional) Filter by target language. 0 or omitted = no filter.

\n","type":"text/plain"},"key":"targetLanguage","value":""},{"description":{"content":"

(Optional) Filter by task. 0 or omitted = no filter.

\n","type":"text/plain"},"key":"task","value":""},{"description":{"content":"

Number of results per page

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Sort results by code or description

\n","type":"text/plain"},"key":"sortBy","value":""},{"description":{"content":"

Filter results containing this string

\n","type":"text/plain"},"key":"contains","value":""}],"variable":[]}},"response":[{"id":"263113e4-ff27-4b13-bcd9-09a5098999cb","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Resources?orderType=&sourceLanguage=&targetLanguage=&task=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Resources"],"query":[{"key":"orderType","value":"","description":"(Required) "},{"key":"sourceLanguage","value":"","description":"(Required) "},{"key":"targetLanguage","value":"","description":"(Required) "},{"key":"task","value":"","description":"(Required) "}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"Data\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"Total\": \"\"\n}\n"},{"id":"c73e5e08-cf37-4d60-9a7a-f48e0ee1f3f0","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*","type":"text"},{"key":"AuthToken","value":"","type":"text"}],"url":{"raw":"{{baseUrl}}/api/ExternalTmApi/Resources?orderType=&sourceLanguage=&targetLanguage=&task=","host":["{{baseUrl}}"],"path":["api","ExternalTmApi","Resources"],"query":[{"key":"orderType","value":"","description":"(Required) "},{"key":"sourceLanguage","value":"","description":"(Required) "},{"key":"targetLanguage","value":"","description":"(Required) "},{"key":"task","value":"","description":"(Required) "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"errorMessage\": \"\"\n}"}],"_postman_id":"70a5da02-8918-40fe-b7e9-cac9b8102713"},{"name":"🧑ResourceList","id":"fa495a2a-049d-43b3-bb76-b992b5096473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/ResourceList?pageSize=&page=&sortBy= &contains=","description":"

Retrieves the resource list and matching codes based on the specified criteria, with paging capabilities. This feature will be available starting in version 369.

\n","urlObject":{"path":["ResourceList"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[{"description":{"content":"

(Required 5-100)

\n","type":"text/plain"},"key":"pageSize","value":""},{"description":{"content":"

(Required)

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

(optional description as default)

\n","type":"text/plain"},"key":"sortBy","value":" "},{"description":{"content":"

(optional filters description)

\n","type":"text/plain"},"key":"contains","value":""}],"variable":[]}},"response":[{"id":"94e0375e-cf88-47a8-bdcb-f457296662e8","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":{"raw":"{{baseUrl}}{{apiRoot}}/ResourceList?pageSize=&page=&sortBy= &contains=","host":["{{baseUrl}}{{apiRoot}}"],"path":["ResourceList"],"query":[{"key":"pageSize","value":"","description":"(Required 5-100) "},{"key":"page","value":"","description":"(Required) "},{"key":"sortBy","value":" ","description":"(optional description as default) "},{"key":"contains","value":"","description":"(optional filters description) "}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n \"Data\":[\r\n {\r\n \"code\": \"\",\r\n \"description\": \"\",\r\n }\r\n ],\r\n \"Total\": \"\"\r\n]"},{"id":"9da9ebf4-c27f-483f-9259-cdb2a8e25c1c","name":"⛔400","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":{"raw":"{{baseUrl}}{{apiRoot}}/ResourceList?pageSize=&page=&sortBy= &contains=","host":["{{baseUrl}}{{apiRoot}}"],"path":["ResourceList"],"query":[{"key":"pageSize","value":"","description":"(Required 5-100) "},{"key":"page","value":"","description":"(Required) "},{"key":"sortBy","value":" ","description":"(optional description as default) "},{"key":"contains","value":"","description":"(optional filters description) "}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"errorMessage\": \"\"\r\n}"}],"_postman_id":"fa495a2a-049d-43b3-bb76-b992b5096473"},{"name":"🧑ResourceReport","id":"261ba2cf-0517-4fcc-a8ef-fbbf726a1f69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"AuthToken","value":"{{access_token}}","type":"text"}],"url":"{{baseUrl}}{{apiRoot}}/ResourceReport","description":"

Used to retrieve resource report information.

How it works:

Send a GET request with either resourceReportNumbers OR both accountingDateFrom and accountingDateTo.

Important:

Requires EITHER resourceReportNumbers OR BOTH accountingDateFrom and accountingDateTo
\n
If neither is provided, the API returns 400
\n
All three parameters are optional individually, but at least one of the two conditions must be met
\n

\n","urlObject":{"path":["ResourceReport"],"host":["{{baseUrl}}{{apiRoot}}"],"query":[{"description":{"content":"

(Optional) Comma-separated list of resource report numbers. Required if accountingDateFrom/To not provided.

\n","type":"text/plain"},"key":"resourceReportNumbers","value":""},{"description":{"content":"

(Optional) Start date for accounting date range filter. Required together with accountingDateTo if resourceReportNumbers not provided.

\n","type":"text/plain"},"key":"accountingDateFrom","value":""},{"description":{"content":"

(Optional) End date for accounting date range filter. Required together with accountingDateFrom if resourceReportNumbers not provided.

\n","type":"text/plain"},"key":"accountingDateTo","value":""}],"variable":[]}},"response":[{"id":"55b54708-18ed-442b-8d4d-1f75f4977439","name":"✅200","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"AuthToken","value":"{{access_token}}"}],"url":{"raw":"{{baseUrl}}{{apiRoot}}/ResourceReport?resourceReportNumbers=&accountingDateFrom=&accountingDateTo=","host":["{{baseUrl}}{{apiRoot}}"],"path":["ResourceReport"],"query":[{"key":"resourceReportNumbers","value":"","description":"Comma-separated list of resource report numbers"},{"key":"accountingDateFrom","value":"","description":"Start date for accounting date range filter"},{"key":"accountingDateTo","value":"","description":"End date for accounting date range filter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"resourceReportNumber\": \"\",\n \"accountingDate\": \"\",\n \"currencyCodeISO\": \"\",\n \"invoiceNumber\": \"\",\n \"submittedOnDate\": \"\",\n \"paymentDueOnDate\": \"\",\n \"resourceReportReferenceNumber\": \"\",\n \"createdOnDate\": \"\",\n \"paymentID\": \"\",\n \"description\": \"\",\n \"cost\": \"\",\n \"currencyDescription\": \"\",\n \"exchangeRate\": \"\",\n \"exchangeRateDate\": \"\",\n \"createdOn\": \"\",\n \"createdBy\": \"\",\n \"createdByName\": \"\",\n \"paymentDueOn\": \"\",\n \"paidOn\": \"\",\n \"approvedUpdatedBy\": \"\",\n \"invoiceUpdatedByName\": \"\",\n \"remarks\": \"\",\n \"orderPaymentsItemsCount\": \"\",\n \"editable\": \"\",\n \"costBillingOffice\": \"\",\n \"costBillingOfficeDescription\": \"\",\n \"hasFinanceNote\": \"\",\n \"hasClientNote\": \"\",\n \"financeNote\": \"\",\n \"clientNote\": \"\",\n \"isReadyForInvoicing\": \"\",\n \"readyForInvoicingBy\": \"\",\n \"readyForInvoicingByName\": \"\",\n \"readyForInvoicingOn\": \"\",\n \"memberOfRevenue\": \"\",\n \"memberOfCost\": \"\",\n \"approvedAccounting\": \"\",\n \"approvedAccountingBy\": \"\",\n \"approvedAccountingByName\": \"\",\n \"approvedAccountingOn\": \"\",\n \"approvedResource\": \"\",\n \"approvedResourceBy\": \"\",\n \"approvedResourceByName\": \"\",\n \"approvedResourceOn\": \"\",\n \"rejectedAccounting\": \"\",\n \"rejectedAccountingBy\": \"\",\n \"rejectedAccountingByName\": \"\",\n \"rejectedAccountingOn\": \"\",\n \"costOffice\": \"\",\n \"isResourcePOExists\": \"\",\n \"orderSupplyDate\": \"\",\n \"createdFor\": \"\",\n \"createdForName\": \"\",\n \"resourceType\": \"\",\n \"canExportInvoices\": \"\",\n \"isInvoiceRemainderMailSent\": \"\",\n \"approvedAccounting1By\": \"\",\n \"approvedAccounting1On\": \"\",\n \"approvedAccounting1ByName\": \"\",\n \"approvedAccounting2By\": \"\",\n \"approvedAccounting2On\": \"\",\n \"approvedAccounting2ByName\": \"

Field	Meaning
code	Product code
description	Product description
orderType / orderTypeDescription	Order type (price list type) the product belongs to
productType / productTypeDescription	Product type
productSubType / productSubTypeDescription	Product sub type
active	Whether the product is active (always true, since only active products are returned)

Field	Type	Description
paymentItemId	uniqueidentifier	Unique ID of the billing statement item
paymentId	uniqueidentifier	Parent billing statement ID
orderPricingId	uniqueidentifier	Order pricing record ID
orderNumber	number	Order number
customerName	string	Original customer name
description	string	Price billing description
cost	number (nullable)	Billed amount
isoCodeCurrency	string	ISO currency code
exchangeRate	number (nullable)	Exchange rate
createdOn	dateTime (nullable)	Creation date
exchangeRateDate	dateTime (nullable)	Exchange rate date
createdBy	integer (nullable)	Created by user code
remarks	string	Remarks
lastUpdatedOn	dateTime (nullable)	Last updated date
isCanceled	boolean	Whether the item is canceled
exchangeRateDateForInvoice	dateTime (nullable)	Exchange rate date for customer invoice currency
exchangeRateForInvoice	number (nullable)	Exchange rate for customer invoice currency
costForInvoice	number (nullable)	Billed amount in customer invoice currency
isoCodeCurrencyForInvoice	string	ISO currency code for customer invoicing
budgetsDescription	string	Budget description
unit	string	Unit type description (e.g. Minutes, Words)
pricePerUnit	number	Computed price per unit
priceMin	number (nullable)	Minimum price
fixedPrice	number (nullable)	Fixed price
unitsMin	number (nullable)	Minimum units
additionPct	number (nullable)	Addition percentage
addition	number (nullable)	Addition amount
discountPct	number (nullable)	Discount percentage
discount	number (nullable)	Discount amount
total	number (nullable)	Total (cost + addition - discount)
totalBilledInCustomerCurrency	number (nullable)	Total billed converted to customer currency
customerBillingCurrency	string	Customer billing currency description
unitsReported	number	Reported units (with rounding applied)
unitsForBilling	number	Units used for billing (with supplier rounding applied)
purchaseOrder	string	Purchase order from pricing

Parameter	Required	Notes
orderNumber	✅	Order must exist
language	✅	Must exist and be part of the order
description	✅
iso_code_currency	➖	ISO code or currency description; resolved to the ISO code. Defaults to the system currency
exchangeRate	➖	Resolved from the currency when omitted; always 1 for the system currency
fixed	➖	Mutually exclusive with the per-unit prices — sending it clears them
perunit_withscript	➖	Defaults to 0
perunit_withoutscript	➖	Defaults to 0
perunit_notrelevant	➖	Defaults to 0
unitcode	➖	Unit type the per-unit prices are quoted in
requiredfilename	➖
metadataproduct1 / 2 / 3	➖
quotedrevenue	➖
quotedrevenuecurrency	➖
expectedcost	➖
iso_code_expectedcostcurrency	➖

Parameter	Required	Notes
orderNumber	✅	Order must exist
id	✅	Price line to patch; must exist on the order and must not be a surcharge
updateField	✅	Name of the field to change (see below)
update value	✅	The typed property matching the field (see below)
language	➖	Cross-check; when sent it must exist and be part of the order
product	➖	Cross-check; when sent the product must be active and own the price line

updateField	Send the value in
Description	updateString
Iso_Code_Currency	updateString
RequiredFilename	updateString
MetaDataProduct1 / MetaDataProduct2 / MetaDataProduct3	updateString
QuotedRevenueCurrency	updateString
Iso_Code_ExpectedCostCurrency	updateString
Fixed	updateNumber
PerUnit_WithScript / PerUnit_WithoutScript / PerUnit_NotRelevant	updateNumber
QuotedRevenue	updateNumber
ExpectedCost	updateNumber
UnitCode	updateInt

Field	Description
StatusCode	Result for this item (200, 400, 500)
Content	Success message, or the validation/error text
Request	Echo of the submitted item, with the currency resolved to its ISO code

Parameter	Required	Notes
orderNumber	✅	Order must exist
id	✅	Price line to delete; must exist on the order and must not be a surcharge

Parameter	Required	Notes
orderNumber	✅	Order must exist
id	✅	Surcharge to patch; must exist on the order
parentId	✅	Parent price line; must be the surcharge's actual parent and differ from `id`
updateField	✅	Name of the field to change (see below)
update value	✅	The typed property matching the field (see below)
language	➖	Cross-check; when sent it must exist and be part of the order

Parameter	Required	Notes
orderNumber	✅	Order must exist
id	✅	Surcharge to delete; must exist on the order
parentId	✅	Parent price line; must be the surcharge's actual parent and differ from `id`

Parameter	Required	Notes
orderNumber	✅	Order must exist
taskUniqueOrderId	✅	Task active number; the task must exist, be assigned to a resource and not be billed
iso_code_currency	✅	ISO code or currency description; resolved to the ISO code
unitcode	✅	Must exist in the system
fixed	➖	Total amount due for the task; defaults to 0
perunit_withscript	➖	Defaults to 0
perunit_withoutscript	➖	Defaults to 0
perunit_notrelevant	➖	Defaults to 0
language	➖	Cross-check; when sent it must match the task's language
product	➖	Cross-check; when sent the product must be active and own the task

Situation	Status
Order / task / currency / unit code not found	400 Bad Request
Task not assigned to a resource	304 Not Modified
Task already billed	304 Not Modified
Language or product does not match the task	304 / 400
Task could not be switched to a manual rate	304 Not Modified

Field	Meaning
`additionDiscount`	An amount, in the rate's currency
`additionDiscountPct`	A percentage of the task total

Situation	Status
Order / task not found	400 Bad Request
Task has no rate	304 Not Modified
Task not assigned to a resource	304 Not Modified
Task already billed	304 Not Modified
Both or neither of `additionDiscount` / `additionDiscountPct` supplied	304 Not Modified

updateField	Send the value in	Meaning
Description	updateString	The surcharge label
AdditionDiscount	updateNumber	An amount, in the rate's currency
AdditionDiscountPct	updateNumber	A percentage of the task total

You send	What happens
`AdditionDiscount`	The amount is set, and the percentage is cleared to 0
`AdditionDiscountPct`	The percentage is set, and the amount due is recalculated from it against the task total

Situation	How to unblock
The task has been added to a resource report	Remove it from the resource report
The task was approved in a monthly resource report	Reopen the monthly report
The task is approved for billing — only when Lock tasks for editing after approval is enabled in the system configuration	Unapprove the task, or disable that setting

Situation	Status
Order / task / surcharge not found, or `updateField` not allowed	400 Bad Request
Task billed — in a resource report, in an approved monthly report, or approved for billing while locking is on	304 Not Modified

Situation	Status
Order / task not found, or `id` missing	400 Bad Request
Task billed — in a resource report, in an approved monthly report, or approved for billing while locking is on	304 Not Modified

Endpoint	What it does
💰AddPrice	Creates a manual price line on an order language
💰UpdatePrice	Patches one field on a price line
💰DeletePrice	Deletes a price line
💰AddPriceSurcharge	Creates a surcharge under a price line
💰UpdatePriceSurcharge	Patches one field on a price surcharge
💰DeletePriceSurcharge	Deletes a price surcharge
📊UpdateRate	Switches a task to a manual rate and sets its amounts
📊AddRateSurcharge	Adds a surcharge to a task rate
📊UpdateRateSurcharge	Patches one field on a task rate surcharge
📊DeleteRateSurcharge	Deletes a task rate surcharge

Field	Description
StatusCode	Result for this item: 200, 400, 304 or 500
Content	Success message, or the validation/error text
Request	Echo of the item you submitted, with resolved values filled in

	Price surcharge	Rate surcharge
Amount	`fixed`	`additionDiscount`
Percentage	`additionPCT`	`additionDiscountPct`
Amount vs percentage	percentage wins, amounts cleared	exactly one, or the item is rejected
Per-unit prices	supported	not supported — amount or percentage only
Unit type	no `unitcode`; inherited from the parent price line	not applicable, there are no per-unit prices
Currency	optional; defaults to the system currency	not accepted; always the rate's currency

How it works:

Important:

How it works:

Important:

How it works:

Important:

How it works:

Important:

OrderStatus Endpoint

TaskStatus Endpoint

Under consideration - not developed yet

How it works:

Important:

Query parameters:

Response — Statement Item fields:

Parameters

Currency and exchange rate

Batch behaviour

Access

Parameters

updateField values and the property that carries the value

Field behaviour

Billed products are locked

Examples

Batch behaviour

Access

Parameters

Billed products are locked

Batch behaviour

Access

Parameters

How the amount is decided

Validation

Examples

Batch behaviour

Access

Parameters

updateField values and the property that carries the value

Field behaviour

Examples

Batch behaviour

Access

Parameters

Billed products are locked

Batch behaviour

Access

Parameters

Currency

Validation outcomes

Batch behaviour

Access

Parameters

The amount

No currency, no per-unit prices

The task must have a rate

Response

Validation outcomes

Examples

Batch behaviour

Access

Parameters

updateField values and the property that carries the value

Amount and percentage are alternatives

Surcharges of billed tasks cannot be edited

What is not patchable, and why

Validation outcomes

Examples

Batch behaviour

Access

Parameters

Surcharges of billed tasks cannot be deleted

Validation outcomes

Example

Batch behaviour

Access

The endpoints

Everything is a batch

Patching a single field

Currencies

Billed and partially billed records are locked