{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/api-test.devel.ogsoftdev.com" } ], "info": { "name": "Laravel API Documentation", "_postman_id": "5898c1ee-5e9b-4de4-8bb7-278ef3a78b55", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Accounting Groups", "description": "", "item": [ { "name": "List Accounting Groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/accounting-groups", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C5%2C8", "description": "Filter by comma-separated accounting group IDs.", "disabled": false }, { "key": "cts", "value": "27%2C28", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "active", "value": "1", "description": "Filter by active status. When omitted, only active groups are returned (default). Set to false for inactive only.", "disabled": false }, { "key": "search", "value": "Internet", "description": "Search in accounting group name (partial match).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/accounting-groups?per_page=15&page=1&ids=1%2C5%2C8&cts=27%2C28&active=1&search=Internet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of accounting groups.\n By default only active groups are returned; use `active=false` for inactive.\n Each group includes its account-number mappings (one per accounting type)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":2292,\"AG_NAME\":\"aut adipisci\",\"AG_NOTE\":\"Qui commodi incidunt iure odit.\",\"AG_VAS\":0,\"AG_CT\":35,\"AG_CREATED\":null,\"AG_L_ID_CREATED\":null,\"AG_CHANGED\":null,\"AG_L_ID_CHANGED\":null,\"AG_ACTIVE\":1,\"AG_ID_CT\":null,\"account_mappings\":[{\"AGN_ID\":37767,\"AGN_AG_ID\":2292,\"AGN_TYPE\":\"LIABILITIES_OTHERS\",\"AGN_ACCOUNT\":\"326\",\"AGN_ACCOUNT_V\":null,\"AGN_TITLE\":\"\",\"AGN_CREATED\":null,\"AGN_L_ID_CREATED\":null,\"AGN_CHANGED\":null,\"AGN_L_ID_CHANGED\":null}]},{\"ID\":2293,\"AG_NAME\":\"ipsum nostrum\",\"AG_NOTE\":null,\"AG_VAS\":0,\"AG_CT\":7,\"AG_CREATED\":null,\"AG_L_ID_CREATED\":null,\"AG_CHANGED\":null,\"AG_L_ID_CHANGED\":null,\"AG_ACTIVE\":1,\"AG_ID_CT\":null,\"account_mappings\":[{\"AGN_ID\":37768,\"AGN_AG_ID\":2293,\"AGN_TYPE\":\"OTHER\",\"AGN_ACCOUNT\":\"525\",\"AGN_ACCOUNT_V\":null,\"AGN_TITLE\":\"\",\"AGN_CREATED\":null,\"AGN_L_ID_CREATED\":null,\"AGN_CHANGED\":null,\"AGN_L_ID_CHANGED\":null}]}]}", "name": "" } ] }, { "name": "Get Accounting Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/accounting-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/accounting-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "0", "description": "The ID of the accounting group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single accounting group by ID, including its account-number mappings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":2294,\"AG_NAME\":\"aut adipisci\",\"AG_NOTE\":\"Qui commodi incidunt iure odit.\",\"AG_VAS\":0,\"AG_CT\":35,\"AG_CREATED\":null,\"AG_L_ID_CREATED\":null,\"AG_CHANGED\":null,\"AG_L_ID_CHANGED\":null,\"AG_ACTIVE\":1,\"AG_ID_CT\":null,\"account_mappings\":[{\"AGN_ID\":37769,\"AGN_AG_ID\":2294,\"AGN_TYPE\":\"LIABILITIES_OTHERS\",\"AGN_ACCOUNT\":\"326\",\"AGN_ACCOUNT_V\":null,\"AGN_TITLE\":\"\",\"AGN_CREATED\":null,\"AGN_L_ID_CREATED\":null,\"AGN_CHANGED\":null,\"AGN_L_ID_CHANGED\":null}]}}", "name": "" } ] } ] }, { "name": "Agreement Types", "description": "", "item": [ { "name": "List Agreement Types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/agreement-types", "query": [ { "key": "per_page", "value": "10", "description": "Number of agreement types to return per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return.", "disabled": false }, { "key": "ids", "value": "50%2C51", "description": "Filter by comma-separated agreement type IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/agreement-types?per_page=10&page=1&ids=50%2C51&cts=1%2C2%2C3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of agreement type definitions.\nIncludes global types (AT_CT = NULL) available to all locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"AT_ID\":509,\"AT_CP\":null,\"AT_CT\":145,\"AT_TYPE\":\"aut_2839\",\"AT_NUMBERING\":\"auto\",\"AT_NUMBER_FORMAT\":\"{A_NUMBER}\",\"AT_TEMPLATE\":\"quidem\",\"AT_NOTE\":\"Qui commodi incidunt iure odit.\",\"AT_FLAGS\":\"\",\"AT_PRINT\":\"ALL\",\"AT_VALID_FROM\":null,\"AT_VALID_TO\":null,\"AT_CONFIRM\":null,\"AT_REMIND_DAYS\":null,\"AT_BLOCK_DAYS\":null},{\"AT_ID\":510,\"AT_CP\":null,\"AT_CT\":40,\"AT_TYPE\":\"et_1839\",\"AT_NUMBERING\":\"auto\",\"AT_NUMBER_FORMAT\":\"{A_NUMBER}\",\"AT_TEMPLATE\":\"modi\",\"AT_NOTE\":\"Nostrum omnis autem et consequatur aut.\",\"AT_FLAGS\":\"\",\"AT_PRINT\":\"ALL\",\"AT_VALID_FROM\":null,\"AT_VALID_TO\":null,\"AT_CONFIRM\":null,\"AT_REMIND_DAYS\":null,\"AT_BLOCK_DAYS\":null}]}", "name": "" } ] } ] }, { "name": "Agreements", "description": "", "item": [ { "name": "List Agreements", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/agreements", "query": [ { "key": "per_page", "value": "10", "description": "Number of agreements to return per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return.", "disabled": false }, { "key": "ids", "value": "41%2C42%2C45", "description": "Filter by comma-separated agreement IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "30367%2C28934", "description": "Filter by comma-separated customer (user) IDs.", "disabled": false }, { "key": "type", "value": "50%2C51", "description": "Filter by comma-separated agreement type IDs.", "disabled": false }, { "key": "valid", "value": "true", "description": "Filter by validity. true = valid only (default), false = invalid only, all = both.", "disabled": false }, { "key": "customer_service", "value": "266773", "description": "Filter agreements linked to a specific customer service (services_active) ID.", "disabled": false }, { "key": "date_from", "value": "2020-01-01", "description": "Filter agreements with conclusion date on or after this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter agreements with conclusion date on or before this date (YYYY-MM-DD).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/agreements?per_page=10&page=1&ids=41%2C42%2C45&cts=1%2C2%2C3&customer=30367%2C28934&type=50%2C51&valid=true&customer_service=266773&date_from=2020-01-01&date_to=2024-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of agreements.\nBy default, only valid agreements (A_VALID = 1) are returned.\nUse `valid=0` to see only invalid, or `valid=all` to see both." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"A_ID\":362133,\"A_AT_ID\":506,\"A_USER_ID\":25567,\"A_CT\":44,\"A_NUMBER\":\"857680\",\"A_NOTE\":\"Quidem nostrum qui commodi incidunt iure odit.\",\"A_CONCLUSION_DATE\":\"1977-08-15\",\"A_CREATED\":\"2026-07-01 19:54:26\",\"A_L_ID\":2718,\"A_ML_ID\":null,\"A_NUM\":null,\"A_VALID\":1,\"A_INVALID_NOTE\":null,\"A_CONFIRMED\":null,\"A_CONFIRM_L_ID\":null,\"A_REMINDER_DATE\":null,\"A_REMEMBER_L_ID\":null,\"A_BLOCK_DATE\":null,\"A_BLOCKED_L_ID\":null,\"A_UNBLOCK_DATE\":null,\"A_UNBLOCKED_L_ID\":null,\"customer_service_links\":[{\"AS_ID\":598188,\"AS_A_ID\":362133,\"AS_SA_ID\":3386694}],\"type\":{\"AT_ID\":506,\"AT_CP\":null,\"AT_CT\":199,\"AT_TYPE\":\"modi_967\",\"AT_NUMBERING\":\"auto\",\"AT_NUMBER_FORMAT\":\"{A_NUMBER}\",\"AT_TEMPLATE\":\"nostrum\",\"AT_NOTE\":\"Autem et consequatur aut dolores enim non facere tempora.\",\"AT_FLAGS\":\"\",\"AT_PRINT\":\"ALL\",\"AT_VALID_FROM\":null,\"AT_VALID_TO\":null,\"AT_CONFIRM\":null,\"AT_REMIND_DAYS\":null,\"AT_BLOCK_DAYS\":null}},{\"A_ID\":362134,\"A_AT_ID\":507,\"A_USER_ID\":1974,\"A_CT\":15,\"A_NUMBER\":\"187043\",\"A_NOTE\":\"Laboriosam praesentium quis adipisci molestias fugit deleniti distinctio.\",\"A_CONCLUSION_DATE\":\"2013-02-14\",\"A_CREATED\":\"2026-04-30 13:57:36\",\"A_L_ID\":562,\"A_ML_ID\":null,\"A_NUM\":null,\"A_VALID\":1,\"A_INVALID_NOTE\":null,\"A_CONFIRMED\":null,\"A_CONFIRM_L_ID\":null,\"A_REMINDER_DATE\":null,\"A_REMEMBER_L_ID\":null,\"A_BLOCK_DATE\":null,\"A_BLOCKED_L_ID\":null,\"A_UNBLOCK_DATE\":null,\"A_UNBLOCKED_L_ID\":null,\"customer_service_links\":[{\"AS_ID\":598189,\"AS_A_ID\":362134,\"AS_SA_ID\":4624325}],\"type\":{\"AT_ID\":507,\"AT_CP\":null,\"AT_CT\":1,\"AT_TYPE\":\"id_4781\",\"AT_NUMBERING\":\"auto\",\"AT_NUMBER_FORMAT\":\"{A_NUMBER}\",\"AT_TEMPLATE\":\"libero\",\"AT_NOTE\":\"Veniam corporis dolorem mollitia.\",\"AT_FLAGS\":\"\",\"AT_PRINT\":\"ALL\",\"AT_VALID_FROM\":null,\"AT_VALID_TO\":null,\"AT_CONFIRM\":null,\"AT_REMIND_DAYS\":null,\"AT_BLOCK_DAYS\":null}}]}", "name": "" } ] }, { "name": "Get Agreement", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/agreements\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/agreements\/:id", "variable": [ { "id": "id", "key": "id", "value": "41", "description": "The ID of the agreement." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single agreement by ID, including its customer service links and type." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"A_ID\":362135,\"A_AT_ID\":508,\"A_USER_ID\":252562,\"A_CT\":211,\"A_NUMBER\":\"333724\",\"A_NOTE\":\"Nostrum qui commodi incidunt iure.\",\"A_CONCLUSION_DATE\":\"1989-10-07\",\"A_CREATED\":\"2026-04-10 12:46:38\",\"A_L_ID\":728,\"A_ML_ID\":null,\"A_NUM\":null,\"A_VALID\":1,\"A_INVALID_NOTE\":null,\"A_CONFIRMED\":null,\"A_CONFIRM_L_ID\":null,\"A_REMINDER_DATE\":null,\"A_REMEMBER_L_ID\":null,\"A_BLOCK_DATE\":null,\"A_BLOCKED_L_ID\":null,\"A_UNBLOCK_DATE\":null,\"A_UNBLOCKED_L_ID\":null,\"customer_service_links\":[{\"AS_ID\":598190,\"AS_A_ID\":362135,\"AS_SA_ID\":697064}],\"type\":{\"AT_ID\":508,\"AT_CP\":null,\"AT_CT\":23,\"AT_TYPE\":\"et_1769\",\"AT_NUMBERING\":\"auto\",\"AT_NUMBER_FORMAT\":\"{A_NUMBER}\",\"AT_TEMPLATE\":\"ipsum\",\"AT_NOTE\":\"Omnis autem et consequatur.\",\"AT_FLAGS\":\"\",\"AT_PRINT\":\"ALL\",\"AT_VALID_FROM\":null,\"AT_VALID_TO\":null,\"AT_CONFIRM\":null,\"AT_REMIND_DAYS\":null,\"AT_BLOCK_DAYS\":null}}}", "name": "" } ] }, { "name": "Download Agreement PDF", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/agreements\/:agreement\/download", "query": [], "raw": "{{baseUrl}}\/api\/v3\/agreements\/:agreement\/download", "variable": [ { "id": "agreement", "key": "agreement", "value": "41", "description": "The agreement." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Downloads the agreement document as a PDF file." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Authentication", "description": "", "item": [ { "name": "User Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/login", "query": [], "raw": "{{baseUrl}}\/api\/v3\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"login\":\"architecto\",\"password\":\"|]|{+-\"}" }, "description": " Authenticates a user with login credentials and returns a bearer token.\n The token should be included in the Authorization header for subsequent API requests.", "auth": { "type": "noauth" } }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":5853,\"LOGIN\":\"idickens\",\"IS_SUPER_ADMIN\":true,\"MODULE_RIGHTS\":[],\"CT\":null,\"CT_NAME\":null}}", "name": "Successful authentication" } ] }, { "name": "SSO Login", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sso\/login", "query": [], "raw": "{{baseUrl}}\/api\/v3\/sso\/login" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"mango_session\":\"architecto\",\"return_url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"}" }, "description": " Authenticates a user from Mango session passed in MANGO_SESSION header.\n On success issues Sanctum token cookie and redirects to configured frontend URL.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\n \"message\": \"\"\n}", "name": "" } ] }, { "name": "User Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v3\/logout" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Logs out the current user and clears the authentication cookie." }, "response": [] }, { "name": "Current User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/me", "query": [], "raw": "{{baseUrl}}\/api\/v3\/me" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns the currently authenticated user." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":5854,\"LOGIN\":\"dare.emelie\",\"IS_SUPER_ADMIN\":true,\"MODULE_RIGHTS\":[],\"CT\":null,\"CT_NAME\":null}}", "name": "Current authenticated user" } ] } ] }, { "name": "Billing Plans", "description": "", "item": [ { "name": "List Billing Plans", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/billing-plans", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated billing plan IDs.", "disabled": false }, { "key": "cts", "value": "5%2C27", "description": "Filter by comma-separated CT (installation) IDs. Returns global (BP_CT IS NULL) plans plus plans matching the specified CTs.", "disabled": false }, { "key": "disabled", "value": "all", "description": "Filter by disabled status. Default (omitted): exclude disabled plans. Pass \"true\" for disabled only, \"all\" to include both.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/billing-plans?ids=1%2C2%2C3&cts=5%2C27&disabled=all" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of billing plans (billing and payment configuration templates).\nBy default, disabled plans are excluded. Use `disabled=all` to include them.\nCT scoping returns global plans (BP_CT IS NULL) plus plans specific to the user's locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"BP_ID\":1093,\"BP_NAME\":\"autem et consequatur\",\"BP_EU_NAME\":null,\"BP_NOTE\":null,\"BP_SC_ID\":null,\"BP_CT\":null,\"BP_CP_ID\":null,\"BP_DISABLED\":0,\"BP_PAID\":\"NONE\",\"BP_PAID_SN_ID\":null,\"BP_PAID_TIME\":\"NONE\",\"BP_PAID_LEGEND\":null,\"BP_BLOCK\":\"NONE\",\"BP_DEFAULT\":1,\"BP_TAXDOC_ROUNDING\":\"DEFAULT\",\"BP_SEPARATE\":0,\"BP_VAR_PRICE_ACCORD\":null,\"BP_VAR_PRICE_SEPARATE\":0,\"BP_TAX_DAY\":0,\"BP_TAX_DATE_SHIFT\":0,\"BP_TAXDOC_DELIVERY_TYPE\":\"NONE\",\"BP_COLLECTION_TYPE\":\"NONE\",\"BP_COLLECTION_DATE\":null,\"BP_COLLECTION_DAY\":null,\"BP_COLLECTION_DEBTS\":\"NONE\",\"BP_COLLECTION_DEBTS_AGE\":0,\"BP_APPLICATION_TYPE\":\"NONE\",\"BP_APPLICATION_DELIVERY_TYPE\":null,\"BP_APPLICATION_DAY\":null,\"BP_PROFORMA_TYPE\":\"NONE\",\"BP_PROFORMA_DELIVERY_TYPE\":null,\"BP_PROFORMA_DATE\":null,\"BP_PROFORMA_DAY\":null,\"BP_ADVANCE\":0,\"BP_ADVANCE_DELIVERY_TYPE\":\"NONE\",\"BP_CREDIT_NOTE_TYPE\":\"NONE\",\"BP_CREDIT_NOTE_DELIVERY_TYPE\":null,\"BP_CREDIT_NOTE_DAY\":null,\"BP_PAYMENT_TYPE\":\"ACCOUNT\",\"BP_PA_ID\":null,\"BP_PA_AUTO\":null,\"BP_MATURITY_TYPE\":\"ACTUAL\",\"BP_MATURITY_DAY\":0,\"BP_RETURN_TYPE\":\"NONE\",\"BP_RETURN_PA_ID\":null,\"BP_VAR_TAX_DAY\":0,\"BP_VAR_TAX_DATE_SHIFT\":0,\"BP_VAR_TAXDOC_DELIVERY_TYPE\":\"NONE\",\"BP_VAR_COLLECTION_TYPE\":\"NONE\",\"BP_VAR_COLLECTION_DATE\":null,\"BP_VAR_COLLECTION_DAY\":null,\"BP_VAR_COLLECTION_DEBTS\":\"NONE\",\"BP_VAR_COLLECTION_DEBTS_AGE\":0,\"BP_VAR_APPLICATION_TYPE\":\"NONE\",\"BP_VAR_APPLICATION_DELIVERY_TYPE\":\"NONE\",\"BP_VAR_APPLICATION_DAY\":null,\"BP_VAR_PROFORMA_TYPE\":\"NONE\",\"BP_VAR_PROFORMA_DELIVERY_TYPE\":null,\"BP_VAR_PROFORMA_DATE\":null,\"BP_VAR_PROFORMA_DAY\":null,\"BP_VAR_PAYMENT_TYPE\":\"ACCOUNT\",\"BP_VAR_PA_ID\":null,\"BP_VAR_MATURITY_TYPE\":\"ACTUAL\",\"BP_VAR_MATURITY_DAY\":0,\"BP_VAR_RETURN_TYPE\":\"NONE\",\"BP_VAR_RETURN_PA_ID\":null,\"BP_VARIABILITY\":\"\",\"BP_AGR_NAME\":null},{\"BP_ID\":1094,\"BP_NAME\":\"enim non facere\",\"BP_EU_NAME\":\"Voluptatem laboriosam praesentium.\",\"BP_NOTE\":null,\"BP_SC_ID\":null,\"BP_CT\":null,\"BP_CP_ID\":null,\"BP_DISABLED\":0,\"BP_PAID\":\"POSTPAID\",\"BP_PAID_SN_ID\":null,\"BP_PAID_TIME\":\"NONE\",\"BP_PAID_LEGEND\":null,\"BP_BLOCK\":\"NONE\",\"BP_DEFAULT\":1,\"BP_TAXDOC_ROUNDING\":\"DEFAULT\",\"BP_SEPARATE\":0,\"BP_VAR_PRICE_ACCORD\":null,\"BP_VAR_PRICE_SEPARATE\":0,\"BP_TAX_DAY\":0,\"BP_TAX_DATE_SHIFT\":0,\"BP_TAXDOC_DELIVERY_TYPE\":\"NONE\",\"BP_COLLECTION_TYPE\":\"NONE\",\"BP_COLLECTION_DATE\":null,\"BP_COLLECTION_DAY\":null,\"BP_COLLECTION_DEBTS\":\"NONE\",\"BP_COLLECTION_DEBTS_AGE\":0,\"BP_APPLICATION_TYPE\":\"NONE\",\"BP_APPLICATION_DELIVERY_TYPE\":null,\"BP_APPLICATION_DAY\":null,\"BP_PROFORMA_TYPE\":\"NONE\",\"BP_PROFORMA_DELIVERY_TYPE\":null,\"BP_PROFORMA_DATE\":null,\"BP_PROFORMA_DAY\":null,\"BP_ADVANCE\":0,\"BP_ADVANCE_DELIVERY_TYPE\":\"NONE\",\"BP_CREDIT_NOTE_TYPE\":\"NONE\",\"BP_CREDIT_NOTE_DELIVERY_TYPE\":null,\"BP_CREDIT_NOTE_DAY\":null,\"BP_PAYMENT_TYPE\":\"ACCOUNT\",\"BP_PA_ID\":null,\"BP_PA_AUTO\":null,\"BP_MATURITY_TYPE\":\"ACTUAL\",\"BP_MATURITY_DAY\":0,\"BP_RETURN_TYPE\":\"NONE\",\"BP_RETURN_PA_ID\":null,\"BP_VAR_TAX_DAY\":0,\"BP_VAR_TAX_DATE_SHIFT\":0,\"BP_VAR_TAXDOC_DELIVERY_TYPE\":\"NONE\",\"BP_VAR_COLLECTION_TYPE\":\"NONE\",\"BP_VAR_COLLECTION_DATE\":null,\"BP_VAR_COLLECTION_DAY\":null,\"BP_VAR_COLLECTION_DEBTS\":\"NONE\",\"BP_VAR_COLLECTION_DEBTS_AGE\":0,\"BP_VAR_APPLICATION_TYPE\":\"NONE\",\"BP_VAR_APPLICATION_DELIVERY_TYPE\":\"NONE\",\"BP_VAR_APPLICATION_DAY\":null,\"BP_VAR_PROFORMA_TYPE\":\"NONE\",\"BP_VAR_PROFORMA_DELIVERY_TYPE\":null,\"BP_VAR_PROFORMA_DATE\":null,\"BP_VAR_PROFORMA_DAY\":null,\"BP_VAR_PAYMENT_TYPE\":\"ACCOUNT\",\"BP_VAR_PA_ID\":null,\"BP_VAR_MATURITY_TYPE\":\"ACTUAL\",\"BP_VAR_MATURITY_DAY\":0,\"BP_VAR_RETURN_TYPE\":\"NONE\",\"BP_VAR_RETURN_PA_ID\":null,\"BP_VARIABILITY\":\"\",\"BP_AGR_NAME\":null}]}", "name": "" } ] } ] }, { "name": "CIBS Partners", "description": "", "item": [ { "name": "List CIBS partners", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/cibs-partners", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated partner IDs (CP_ID).", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active flag (CP_ACTIVE). true|false. When omitted, only active partners (CP_ACTIVE = 1) are returned.", "disabled": false }, { "key": "search", "value": "Acme", "description": "Substring search on partner name (CP_NAME).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/cibs-partners?per_page=15&page=1&ids=1%2C2%2C3&active=true&search=Acme" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of CIBS partners (no CT scoping). Results are\nscoped to the caller's CIBS partner: partner-bound users see only their\nown partner, internal users see all.\nUsed to populate a partner picker \u2014 e.g. choosing the CP scope of a webhook configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"CP_ID\":2878,\"CP_NAME\":\"Hirthe Inc\",\"CP_PRODUCT\":\"mango\",\"CP_WEB\":\"dare.org\",\"CP_ACTIVE\":1},{\"CP_ID\":3940,\"CP_NAME\":\"Keebler LLC\",\"CP_PRODUCT\":\"mango\",\"CP_WEB\":\"leuschke.info\",\"CP_ACTIVE\":1}]}", "name": "" } ] } ] }, { "name": "Code List Category", "description": "", "item": [ { "name": "List code list categories", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/categories", "query": [ { "key": "order", "value": "CLC_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: CLC_ID, CLC_CATEGORY, CLC_CT, CLC_CP_ID, CLC_VISIBLE, CLC_EDITABLE, CLC_CREATED.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated code list category IDs (CLC_ID).", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (CT) IDs. Narrows within the user's allowed CTs.", "disabled": false }, { "key": "cp_id", "value": "3", "description": "Filter by CIBS partner ID (CLC_CP_ID) \u2014 exact match.", "disabled": false }, { "key": "category", "value": "ACTIVITY_STATUS", "description": "Filter by exact category name (CLC_CATEGORY).", "disabled": false }, { "key": "editable", "value": "true", "description": "Filter by editable flag (CLC_EDITABLE). When omitted, both editable and non-editable rows are returned.", "disabled": false }, { "key": "visible", "value": "true", "description": "Filter by visible flag (CLC_VISIBLE). When omitted, both visible and hidden rows are returned.", "disabled": false }, { "key": "search", "value": "STATUS", "description": "Substring search on category name (CLC_CATEGORY) or description (CLC_DESCRIPTION).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/code-list\/categories?order=CLC_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&cts=11%2C12&cp_id=3&category=ACTIVITY_STATUS&editable=true&visible=true&search=STATUS" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of code list categories visible to the current operator." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"CLC_ID\":687,\"CLC_CATEGORY\":\"TEST_ADIPISCI-QUIDEM-NOSTRUM-QUI-COMMODI-INCIDUNT-IURE\",\"CLC_DESCRIPTION\":\"Et et modi ipsum nostrum.\",\"CLC_HELP\":null,\"CLC_VISIBLE\":1,\"CLC_EDITABLE\":1,\"CLC_CT\":null,\"CLC_CP_ID\":null,\"CLC_CREATE_ID\":null,\"CLC_CREATED\":null},{\"CLC_ID\":688,\"CLC_CATEGORY\":\"TEST_AUTEM-ET-CONSEQUATUR-AUT-DOLORES-ENIM-NON-FACERE-TEMPORA\",\"CLC_DESCRIPTION\":\"Voluptatem laboriosam praesentium quis adipisci.\",\"CLC_HELP\":null,\"CLC_VISIBLE\":1,\"CLC_EDITABLE\":1,\"CLC_CT\":null,\"CLC_CP_ID\":null,\"CLC_CREATE_ID\":null,\"CLC_CREATED\":null}]}", "name": "" } ] }, { "name": "Get code list category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the category." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a single code list category by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CLC_ID\":689,\"CLC_CATEGORY\":\"TEST_ET-ET-MODI-IPSUM-NOSTRUM\",\"CLC_DESCRIPTION\":\"Autem et consequatur aut dolores enim non facere tempora.\",\"CLC_HELP\":null,\"CLC_VISIBLE\":1,\"CLC_EDITABLE\":1,\"CLC_CT\":null,\"CLC_CP_ID\":null,\"CLC_CREATE_ID\":null,\"CLC_CREATED\":null}}", "name": "" } ] }, { "name": "Create code list category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/categories", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/categories" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"category\":\"ACTIVITY_STATUS\",\"description\":\"Activity status codes\",\"help\":\"Contains codes for various activity states\",\"type\":\"GLOBAL\",\"editable\":1,\"visible\":1}" }, "description": "Create a new code list category." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CLC_ID\":690,\"CLC_CATEGORY\":\"TEST_BLANDITIIS-ODIO-VERITATIS-EXCEPTURI-DOLORIBUS-DELECTUS-FUGIT\",\"CLC_DESCRIPTION\":\"Repudiandae laboriosam est alias tenetur ratione.\",\"CLC_HELP\":null,\"CLC_VISIBLE\":1,\"CLC_EDITABLE\":1,\"CLC_CT\":null,\"CLC_CP_ID\":null,\"CLC_CREATE_ID\":null,\"CLC_CREATED\":null}}", "name": "" } ] }, { "name": "Update code list category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the category." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Updated description\",\"help\":\"Updated help text\",\"editable\":1,\"visible\":1}" }, "description": "Update an existing code list category. Partial input accepted; unspecified fields are left unchanged." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CLC_ID\":691,\"CLC_CATEGORY\":\"TEST_REPUDIANDAE-LABORIOSAM-EST-ALIAS-TENETUR-RATIONE\",\"CLC_DESCRIPTION\":\"Voluptate accusamus ut et recusandae.\",\"CLC_HELP\":null,\"CLC_VISIBLE\":1,\"CLC_EDITABLE\":1,\"CLC_CT\":null,\"CLC_CP_ID\":null,\"CLC_CREATE_ID\":null,\"CLC_CREATED\":null}}", "name": "" } ] }, { "name": "Delete code list category", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/categories\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/categories\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the category." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Hard-delete a code list category. Fails if child code_list rows reference it." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Code List Entries", "description": "", "item": [ { "name": "List code list entries", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries", "query": [ { "key": "order", "value": "CL_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: CL_ID, CL_CATEGORY, CL_KEY, CL_VALUE, CL_CT, CL_CP, CL_INDEX, CL_ACTIVE, CL_CREATED.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated code list entry IDs (CL_ID).", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (CT) IDs. Narrows within the user's allowed CTs.", "disabled": false }, { "key": "cp", "value": "3", "description": "Filter by CIBS partner ID (CL_CP) \u2014 exact match.", "disabled": false }, { "key": "category", "value": "ACTIVITY_STATUS", "description": "Filter by exact category name (CL_CATEGORY). Most common filter \u2014 lists all entries in a category.", "disabled": false }, { "key": "key", "value": "OPEN", "description": "Filter by exact entry key (CL_KEY). Combine with category to look up a specific entry.", "disabled": false }, { "key": "value", "value": "Open", "description": "Filter by exact entry value (CL_VALUE). Combine with category to look up by value.", "disabled": false }, { "key": "parent_id", "value": "42", "description": "Filter by parent entry ID (CL_CL_ID). Returns direct children of the given parent.", "disabled": false }, { "key": "parent_is_null", "value": "true", "description": "Boolean. true \u2192 root entries only (CL_CL_ID IS NULL). false \u2192 non-root entries only.", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by CL_ACTIVE flag. true|false|all. Default: true (only active entries).", "disabled": false }, { "key": "search", "value": "OPEN", "description": "Substring search on CL_KEY, CL_VALUE, or CL_CATEGORY.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries?order=CL_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&cts=11%2C12&cp=3&category=ACTIVITY_STATUS&key=OPEN&value=Open&parent_id=42&parent_is_null=true&active=true&search=OPEN" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of code list entries visible to the current operator. Each entry includes its params (eager-loaded)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"CL_ID\":19843,\"CL_CATEGORY\":\"TEST_VOLUPTATEM-LABORIOSAM-PRAESENTIUM-QUIS-ADIPISCI\",\"CL_KEY\":\"fugit-deleniti-distinctio-eum-doloremque-id-aut-libero\",\"CL_VALUE\":\"Veniam corporis dolorem mollitia.\",\"CL_CT\":null,\"CL_CP\":null,\"CL_CL_ID\":null,\"CL_ACTIVE\":1,\"CL_INDEX\":null,\"CL_CREATE_ID\":null,\"CL_CREATED\":null,\"params\":[{\"CLP_ID\":15190,\"CLP_CL_ID\":19843,\"CLP_PAR_NAME\":\"DELENITI\",\"CLP_VALUE\":\"Odit quia officia est dignissimos neque blanditiis odio.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}]},{\"CL_ID\":19844,\"CL_CATEGORY\":\"TEST_EXCEPTURI-DOLORIBUS-DELECTUS-FUGIT-QUI-REPUDIANDAE-LABORIOSAM\",\"CL_KEY\":\"alias-tenetur-ratione-nemo-voluptate-accusamus-ut-et\",\"CL_VALUE\":\"Modi rerum ex repellendus assumenda et tenetur.\",\"CL_CT\":null,\"CL_CP\":null,\"CL_CL_ID\":null,\"CL_ACTIVE\":1,\"CL_INDEX\":null,\"CL_CREATE_ID\":null,\"CL_CREATED\":null,\"params\":[{\"CLP_ID\":15191,\"CLP_CL_ID\":19844,\"CLP_PAR_NAME\":\"AB\",\"CLP_VALUE\":\"Quia perspiciatis deserunt ducimus corrupti et.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}]}]}", "name": "" } ] }, { "name": "Get code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the entry." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a single code list entry by ID. Includes the entry's params (eager-loaded)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CL_ID\":19845,\"CL_CATEGORY\":\"TEST_VENIAM-CORPORIS-DOLOREM-MOLLITIA\",\"CL_KEY\":\"nemo-odit-quia-officia-est-dignissimos\",\"CL_VALUE\":\"Blanditiis odio veritatis excepturi doloribus delectus fugit.\",\"CL_CT\":null,\"CL_CP\":null,\"CL_CL_ID\":null,\"CL_ACTIVE\":1,\"CL_INDEX\":null,\"CL_CREATE_ID\":null,\"CL_CREATED\":null,\"params\":[{\"CLP_ID\":15192,\"CLP_CL_ID\":19845,\"CLP_PAR_NAME\":\"QUI\",\"CLP_VALUE\":\"Laboriosam est alias tenetur ratione.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}]}}", "name": "" } ] }, { "name": "Create code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"category\":\"ACTIVITY_STATUS\",\"key\":\"active\",\"value\":\"Active\",\"parent_id\":16,\"type\":\"GLOBAL\",\"index\":0}" }, "description": "Create a new code list entry within a category. Position is determined by the `parent_id` and `index` fields; both are immutable after creation (use POST \/move to reposition)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CL_ID\":19846,\"CL_CATEGORY\":\"TEST_ET-ANIMI-QUOS-VELIT-ET-FUGIAT\",\"CL_KEY\":\"nihil-accusantium-harum-mollitia-modi-deserunt\",\"CL_VALUE\":\"Ab provident perspiciatis quo omnis nostrum aut adipisci.\",\"CL_CT\":null,\"CL_CP\":null,\"CL_CL_ID\":null,\"CL_ACTIVE\":1,\"CL_INDEX\":null,\"CL_CREATE_ID\":null,\"CL_CREATED\":null,\"params\":[{\"CLP_ID\":15193,\"CLP_CL_ID\":19846,\"CLP_PAR_NAME\":\"CONSEQUATUR\",\"CLP_VALUE\":\"Dolores enim non facere tempora.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}]}}", "name": "" } ] }, { "name": "Update code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the entry." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"value\":\"Updated value\"}" }, "description": "Update an existing code list entry. ONLY the `value` field is mutable; all other fields are immutable post-creation. Omit `value` for a no-op; send explicit null to clear the field." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CL_ID\":19847,\"CL_CATEGORY\":\"TEST_VOLUPTATE-ACCUSAMUS-UT-ET-RECUSANDAE\",\"CL_KEY\":\"rerum-ex-repellendus-assumenda-et\",\"CL_VALUE\":\"Ab reiciendis quia perspiciatis deserunt ducimus corrupti.\",\"CL_CT\":null,\"CL_CP\":null,\"CL_CL_ID\":null,\"CL_ACTIVE\":1,\"CL_INDEX\":null,\"CL_CREATE_ID\":null,\"CL_CREATED\":null,\"params\":[{\"CLP_ID\":15194,\"CLP_CL_ID\":19847,\"CLP_PAR_NAME\":\"QUIA\",\"CLP_VALUE\":\"Assumenda odit doloribus repellat officiis corporis nesciunt ut.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}]}}", "name": "" } ] }, { "name": "Deactivate code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the entry." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Soft-delete the entry by setting CL_ACTIVE=0. Restorable via POST \/code-list\/entries\/{id}\/activate. Refuses if any descendant entry is still active." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Activate code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:id\/activate", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:id\/activate", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the entry." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Reactivate a previously-deactivated entry (CL_ACTIVE \u2192 1). Idempotent. Requires APPBUS.CODE_LIST.ACTIVATE right." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Move code list entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:id\/move", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:id\/move", "variable": [ { "id": "id", "key": "id", "value": "564", "description": "The ID of the entry." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"after_id\":12345,\"to_begin\":false}" }, "description": "Reorder the entry within its category, placing it after `after_id` (or before, when `to_begin=true`). The two rows must share CL_CATEGORY; the moved row inherits the after-row's parent (CL_CL_ID) when they differ. Requires APPBUS.CODE_LIST.MOVE right." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Code List Entry Params", "description": "", "item": [ { "name": "Create code list entry param", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:entry_id\/params", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:entry_id\/params", "variable": [ { "id": "entry_id", "key": "entry_id", "value": "architecto", "description": "The ID of the entry." }, { "id": "entry", "key": "entry", "value": "12345", "description": "The parent entry ID (CL_ID)." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"cs\",\"value\":\"Aktivn\u00ed\"}" }, "description": "Add a new param attribute to a code list entry. Param names are unique per entry." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CLP_ID\":15195,\"CLP_CL_ID\":19848,\"CLP_PAR_NAME\":\"QUIS\",\"CLP_VALUE\":\"Ut aperiam sed velit fugit.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}}", "name": "" } ] }, { "name": "Update code list entry param", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:entry_id\/params\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:entry_id\/params\/:id", "variable": [ { "id": "entry_id", "key": "entry_id", "value": "architecto", "description": "The ID of the entry." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the param." }, { "id": "entry", "key": "entry", "value": "12345", "description": "The parent entry ID (CL_ID)." }, { "id": "param", "key": "param", "value": "678", "description": "The param ID (CLP_ID)." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"en\",\"value\":\"Active\"}" }, "description": "Update an existing param. Partial-update semantics \u2014 fields not present in the body are left unchanged. Note: explicit null in the body also leaves the field unchanged (IFNULL\/partial-update SP)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"CLP_ID\":15196,\"CLP_CL_ID\":19849,\"CLP_PAR_NAME\":\"ENIM\",\"CLP_VALUE\":\"Facere tempora ex voluptatem laboriosam.\",\"CLP_CREATE_ID\":null,\"CLP_CREATED\":null}}", "name": "" } ] }, { "name": "Delete code list entry param", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/code-list\/entries\/:entry_id\/params\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/code-list\/entries\/:entry_id\/params\/:id", "variable": [ { "id": "entry_id", "key": "entry_id", "value": "architecto", "description": "The ID of the entry." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the param." }, { "id": "entry", "key": "entry", "value": "12345", "description": "The parent entry ID (CL_ID)." }, { "id": "param", "key": "param", "value": "678", "description": "The param ID (CLP_ID)." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Hard-delete a param. The parent entry is unaffected." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Customer Contacts", "description": "", "item": [ { "name": "List Customer Contacts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-contacts", "query": [ { "key": "per_page", "value": "10", "description": "Number of contacts to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated contact IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "100", "description": "Filter by customer ID (UC_USER_ID)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-contacts?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=100" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of customer contacts (contact persons).\nContacts are scoped by CT through the parent customer." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"UC_ID\":21015,\"UC_USER_ID\":681,\"UC_P_ID\":null,\"UC_LOGIN\":null,\"UC_LAST_NAME\":\"Price\",\"UC_FIRST_NAME\":\"Amber\",\"UC_EMAIL\":\"emelie.baumbach@example.net\",\"UC_PHONE\":420760725744,\"UC_PHONE2\":null,\"UC_GSM\":420659135052,\"UC_FAX\":null,\"UC_FINANCE\":0,\"UC_TECHNIC\":0,\"UC_LEADER\":0,\"UC_MANAGEMENT\":0,\"UC_MARKETING\":0,\"UC_SHOP\":0,\"UC_POSITION\":null},{\"UC_ID\":21016,\"UC_USER_ID\":59,\"UC_P_ID\":null,\"UC_LOGIN\":\"schultz.audrey\",\"UC_LAST_NAME\":\"Koch\",\"UC_FIRST_NAME\":\"Christian\",\"UC_EMAIL\":\"sleffler@example.org\",\"UC_PHONE\":420784087043,\"UC_PHONE2\":null,\"UC_GSM\":null,\"UC_FAX\":null,\"UC_FINANCE\":0,\"UC_TECHNIC\":0,\"UC_LEADER\":0,\"UC_MANAGEMENT\":0,\"UC_MARKETING\":0,\"UC_SHOP\":0,\"UC_POSITION\":null}]}", "name": "" } ] }, { "name": "Create Customer Contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-contacts", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-contacts" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":41994,\"p_id\":12345,\"login\":\"jan.novak\",\"password\":\"Abcdef12\",\"last_name\":\"Nov\u00e1k\",\"first_name\":\"Jan\",\"email\":\"jan.novak@example.com\",\"phone\":\"+420 603 150 722\",\"phone2\":\"+420 603 150 723\",\"gsm\":\"+420 777 123 456\",\"fax\":\"+420 465 525 252\",\"finance\":false,\"technic\":false,\"leader\":false,\"management\":false,\"marketing\":false,\"shop\":false,\"position\":\"ADMIN\"}" }, "description": "Create a new customer contact (contact person) on an existing customer.\n\n**Authorization**: requires `MODULE=USERS` module right. Fine-grained write access\n(`USERS_CONTACTS.INSERT` session option) is enforced by the Mango SP. The SP returns\n`UserContact.Create.NoRights` (403) when the option is absent.\n\n**Phone fields** (`phone`, `phone2`, `gsm`, `fax`): accept `+420\u2026`, `00420\u2026`, or national\nformat. The SP normalizes them to a digits-only international integer (e.g. `+420 603 150 722`\n\u2192 `420603150722`).\n\n**Position**: a free-form code. Values are typically keys from the `USERS_CONTACTS_POSITION`\ncode list but are not validated against it server-side. If the resolved code-list entry has\n`selfcare_login=FORCE`, the SP additionally requires both `login` and `password`.\n\n**Password policy**: min 8 chars with at least one digit, one lowercase, and one uppercase\nletter; OR min 12 chars. No character may repeat 3+ times consecutively. Stored as an MD5\nhash; never returned in the API response.\n\n**Role flags** (`finance`, `technic`, `leader`, `management`, `marketing`, `shop`): default\nto `0` when omitted." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"UC_ID\":21017,\"UC_USER_ID\":681,\"UC_P_ID\":null,\"UC_LOGIN\":null,\"UC_LAST_NAME\":\"Price\",\"UC_FIRST_NAME\":\"Amber\",\"UC_EMAIL\":\"emelie.baumbach@example.net\",\"UC_PHONE\":420760725744,\"UC_PHONE2\":null,\"UC_GSM\":420659135052,\"UC_FAX\":null,\"UC_FINANCE\":0,\"UC_TECHNIC\":0,\"UC_LEADER\":0,\"UC_MANAGEMENT\":0,\"UC_MARKETING\":0,\"UC_SHOP\":0,\"UC_POSITION\":null}}", "name": "" } ] }, { "name": "Get Customer Contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "The ID of the customer contact." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a specific customer contact by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"UC_ID\":21018,\"UC_USER_ID\":681,\"UC_P_ID\":null,\"UC_LOGIN\":null,\"UC_LAST_NAME\":\"Price\",\"UC_FIRST_NAME\":\"Amber\",\"UC_EMAIL\":\"emelie.baumbach@example.net\",\"UC_PHONE\":420760725744,\"UC_PHONE2\":null,\"UC_GSM\":420659135052,\"UC_FAX\":null,\"UC_FINANCE\":0,\"UC_TECHNIC\":0,\"UC_LEADER\":0,\"UC_MANAGEMENT\":0,\"UC_MARKETING\":0,\"UC_SHOP\":0,\"UC_POSITION\":null}}", "name": "" } ] }, { "name": "Update Customer Contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "The ID of the customer contact." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":41994,\"p_id\":12345,\"login\":\"jan.novak\",\"password\":\"Abcdef12\",\"last_name\":\"Nov\u00e1k\",\"first_name\":\"Jan\",\"email\":\"jan.novak@example.com\",\"phone\":\"+420 603 150 722\",\"phone2\":\"+420 603 150 723\",\"gsm\":\"+420 777 123 456\",\"fax\":\"+420 465 525 252\",\"finance\":false,\"technic\":false,\"leader\":false,\"management\":false,\"marketing\":false,\"shop\":false,\"position\":\"ADMIN\"}" }, "description": "Partially update an existing customer contact.\n\n**Partial-update semantics (IFNULL merge in SP)**:\n- Omit a field to keep its current value (the SP sees SQL NULL and merges over the existing row).\n- Send an explicit JSON `null` to clear a nullable field (`login`, `first_name`, `email`,\n `phone`, `phone2`, `gsm`, `fax`, `position`). The API maps null \u2192 `''`; the SP stores `''`\n for text columns and converts to NULL for phone columns.\n- Explicitly null on `user_id`, `p_id`, `last_name`, `password`, or any role flag is rejected\n with HTTP 422 (validation).\n\n**Limitations**:\n- `p_id` cannot be cleared once set (SP merge limitation; send the current value or a new\n valid premise to change it).\n- Changing `user_id` while a `p_id` is set will fail with `UserContact.Edit.UpUserMissmatch`\n unless you also change\/clear the premise. Since `p_id` cannot be cleared, move both in the\n same request.\n- **F4 quirk**: editing a contact whose position resolves to `selfcare_login=FORCE` always\n requires re-sending `password`, even if only unrelated fields change. The SP does not check\n whether a password already exists \u2014 it requires one in the incoming payload.\n\n**Authorization**: requires `MODULE=USERS`. Fine-grained edit access (`USERS_CONTACTS.EDIT`)\nis enforced by the SP. Returns 404 for nonexistent or out-of-scope contacts.\n\nPhone normalization and position semantics are the same as the create endpoint." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"UC_ID\":21019,\"UC_USER_ID\":681,\"UC_P_ID\":null,\"UC_LOGIN\":null,\"UC_LAST_NAME\":\"Price\",\"UC_FIRST_NAME\":\"Amber\",\"UC_EMAIL\":\"emelie.baumbach@example.net\",\"UC_PHONE\":420760725744,\"UC_PHONE2\":null,\"UC_GSM\":420659135052,\"UC_FAX\":null,\"UC_FINANCE\":0,\"UC_TECHNIC\":0,\"UC_LEADER\":0,\"UC_MANAGEMENT\":0,\"UC_MARKETING\":0,\"UC_SHOP\":0,\"UC_POSITION\":null}}", "name": "" } ] }, { "name": "Delete Customer Contact", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-contacts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-contacts\/:id", "variable": [ { "id": "id", "key": "id", "value": "21", "description": "The ID of the customer contact." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Permanently delete a customer contact.\n\n**Hard delete**: the row is removed from `users_contacts` with no soft-delete or audit trail\nin this table. The deletion is irreversible.\n\n**Authorization**: requires `MODULE=USERS`. Fine-grained delete access (`USERS_CONTACTS.DELETE`)\nis enforced by the SP. Returns 404 for nonexistent or out-of-scope contacts." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Customer Groups", "description": "", "item": [ { "name": "List Customer Groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-groups", "query": [ { "key": "per_page", "value": "10", "description": "Number of groups to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status. 'true' = active only (default), 'false' = inactive only, 'all' = both.", "disabled": false }, { "key": "type", "value": "OTHER", "description": "Filter by group type.", "disabled": false }, { "key": "search", "value": "VIP", "description": "Search by group name (partial match).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-groups?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&active=true&type=OTHER&search=VIP" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of customer groups.\nBy default, only active groups (G_ACTIVE=1) are returned.\nPass `active=all` to include inactive groups." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":2774,\"G_TARGET\":\"user\",\"GROUP_NAME\":\"adipisci quidem nostrum\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":6,\"G_TYPE\":\"SELFCARE\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null},{\"ID\":2775,\"G_TARGET\":\"user\",\"GROUP_NAME\":\"odit et et\",\"NOTE\":\"Nostrum omnis autem et consequatur aut.\",\"G_NOTE_BS\":null,\"CT\":7,\"G_TYPE\":\"SELFCARE\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null}]}", "name": "" } ] }, { "name": "Get Customer Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "141", "description": "The ID of the customer group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a specific customer group by ID, including its user group memberships." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":2776,\"G_TARGET\":\"user\",\"GROUP_NAME\":\"adipisci quidem nostrum\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":6,\"G_TYPE\":\"SELFCARE\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"members\":[{\"ID\":1428841,\"GROUP_ID\":2776,\"USER_ID\":1038}]}}", "name": "" } ] } ] }, { "name": "Customer Param Definitions", "description": "", "item": [ { "name": "List Customer Param Definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-param-definitions", "query": [ { "key": "per_page", "value": "10", "description": "Number of definitions to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "101%2C133%2C135", "description": "Filter by comma-separated definition IDs", "disabled": false }, { "key": "cts", "value": "31%2C101", "description": "Filter by comma-separated location (installation) IDs. Returns global definitions (UPD_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.", "disabled": false }, { "key": "disabled", "value": "all", "description": "Filter by disabled status. Default (omitted): only enabled (UPD_DISABLED=0). 'true' = disabled only, 'all' = both enabled and disabled.", "disabled": false }, { "key": "target", "value": "user", "description": "Filter by target entity type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-param-definitions?per_page=10&page=1&ids=101%2C133%2C135&cts=31%2C101&disabled=all&target=user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of customer parameter definitions.\nBy default, only enabled definitions (UPD_DISABLED=0) are returned.\nPass `disabled=all` to include disabled definitions.\nGlobal definitions (UPD_CT IS NULL) are always included alongside\nlocation-specific ones." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"UPD_ID\":1142,\"UPD_CT\":181,\"UPD_TARGET\":\"user\",\"UPD_NAME\":\"COMMODI\",\"UPD_DISPLAY\":\"incidunt iure\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"DATE\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":765,\"UPD_CREATED\":\"2026-07-01 20:09:14\",\"UPD_DOC_VARNAME\":\"\",\"UPD_SHOW\":1,\"UPD_PAY_SHOW\":0,\"UPD_PROVISIONING\":0,\"UPD_SYSTEM\":\"N\",\"UPD_SC_VISIBLE\":null,\"UPD_SC_EDITABLE\":null},{\"UPD_ID\":1143,\"UPD_CT\":128,\"UPD_TARGET\":\"user\",\"UPD_NAME\":\"OMNIS\",\"UPD_DISPLAY\":\"autem et\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"DATE\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":94,\"UPD_CREATED\":\"2026-01-20 16:32:35\",\"UPD_DOC_VARNAME\":\"\",\"UPD_SHOW\":1,\"UPD_PAY_SHOW\":0,\"UPD_PROVISIONING\":0,\"UPD_SYSTEM\":\"N\",\"UPD_SC_VISIBLE\":null,\"UPD_SC_EDITABLE\":null}]}", "name": "" } ] } ] }, { "name": "Customer Params", "description": "", "item": [ { "name": "List customer params", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:customer_id\/params", "query": [ { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "name", "value": "INFO_EMAIL", "description": "Filter by parameter name. Returns all rows for that name (full history + planned). Overrides default valid_at=today.", "disabled": false }, { "key": "valid_at", "value": "2026-01-15", "description": "Filter to parameters valid on this date (YYYY-MM-DD). Default: today when `name` is not set. Ignored when `name` is set.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customers\/:customer_id\/params?per_page=15&page=1&name=INFO_EMAIL&valid_at=2026-01-15", "variable": [ { "id": "customer_id", "key": "customer_id", "value": "68", "description": "The ID of the customer." }, { "id": "customer", "key": "customer", "value": "12345", "description": "The customer ID (USER_ID)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns parameter rows for a customer. By default returns only currently-valid rows\n(those with `UP_VALID_FROM <= today <= UP_VALID_TO`, NULL valid_to = open-ended).\nFilter by `name` to see the full history of a single param (planned + past values),\nor `valid_at=YYYY-MM-DD` to see what is\/was\/will be valid on a specific date." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"UP_ID\":998823,\"UP_USER_ID\":2188782,\"UP_NAME\":\"ASPERNATUR\",\"UP_VALID_FROM\":\"2026-03-30T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Incidunt iure odit et.\",\"UP_CONTENT\":\"Doloribus delectus fugit qui repudiandae laboriosam. Alias tenetur ratione nemo voluptate accusamus ut et. Modi rerum ex repellendus assumenda et tenetur. Reiciendis quia perspiciatis deserunt ducimus corrupti et.\",\"UP_CREATED\":\"2026-02-27T20:15:01.000000Z\",\"UP_L_ID\":85,\"param_def\":{\"UPD_ID\":1139,\"UPD_CT\":149,\"UPD_TARGET\":\"premise\",\"UPD_NAME\":\"ASPERNATUR\",\"UPD_DISPLAY\":\"consectetur id\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"DATE\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":342,\"UPD_CREATED\":\"2026-04-04 05:24:24\",\"UPD_DOC_VARNAME\":\"\",\"UPD_SHOW\":1,\"UPD_PAY_SHOW\":0,\"UPD_PROVISIONING\":0,\"UPD_SYSTEM\":\"N\",\"UPD_SC_VISIBLE\":null,\"UPD_SC_EDITABLE\":null}},{\"UP_ID\":998824,\"UP_USER_ID\":2188783,\"UP_NAME\":\"DOLORUM\",\"UP_VALID_FROM\":\"2026-03-08T23:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Odit ut perspiciatis rem.\",\"UP_CONTENT\":null,\"UP_CREATED\":\"2026-06-05T17:28:18.000000Z\",\"UP_L_ID\":567,\"param_def\":{\"UPD_ID\":1140,\"UPD_CT\":286,\"UPD_TARGET\":\"premise\",\"UPD_NAME\":\"DOLORUM\",\"UPD_DISPLAY\":\"voluptates exercitationem\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"BOOL\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":612,\"UPD_CREATED\":\"2026-07-14 04:03:28\",\"UPD_DOC_VARNAME\":\"\",\"UPD_SHOW\":1,\"UPD_PAY_SHOW\":0,\"UPD_PROVISIONING\":0,\"UPD_SYSTEM\":\"N\",\"UPD_SC_VISIBLE\":null,\"UPD_SC_EDITABLE\":null}}]}", "name": "" } ] }, { "name": "Set customer param (upsert)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:customer_id\/params\/:name", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers\/:customer_id\/params\/:name", "variable": [ { "id": "customer_id", "key": "customer_id", "value": "68", "description": "The ID of the customer." }, { "id": "name", "key": "name", "value": "INFO_EMAIL", "description": "The parameter name (UP_NAME). Must match a row in `users_params_def` for the customer's CT. Common shapes: `INFO_EMAIL`, `OTVIRACIDOBA.PO`." }, { "id": "customer", "key": "customer", "value": "12345", "description": "The customer ID (USER_ID)." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"value\":\"office@example.com\",\"valid_from\":\"2026-06-01\",\"valid_to\":\"2026-12-31\"}" }, "description": "Upsert a parameter value for a customer. The Mango procedure `user_param_edit` handles\nboth insert and update internally based on the param definition's `UPD_TIME_RESOLUTION`:\n\n- **Time-resolved** (`UPD_TIME_RESOLUTION=1`): `valid_from` is required; `valid_to` must\n be omitted. Calling with a `valid_from` that doesn't match any existing row inserts a\n new validity slot and closes neighboring rows' `valid_to` automatically.\n- **Non-time-resolved**: `valid_from` is ignored (SP uses customer's `ACTIVATION` date\n for inserts). `valid_to` is honored.\n\nThe response is the resulting `users_params` row \u2014 may be a newly inserted slot or an\nupdated existing one." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"UP_ID\":998825,\"UP_USER_ID\":2188784,\"UP_NAME\":\"CONSECTETUR\",\"UP_VALID_FROM\":\"2026-03-30T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Incidunt iure odit et.\",\"UP_CONTENT\":\"Doloribus delectus fugit qui repudiandae laboriosam. Alias tenetur ratione nemo voluptate accusamus ut et. Modi rerum ex repellendus assumenda et tenetur. Reiciendis quia perspiciatis deserunt ducimus corrupti et.\",\"UP_CREATED\":\"2026-02-27T20:15:01.000000Z\",\"UP_L_ID\":85,\"param_def\":{\"UPD_ID\":1141,\"UPD_CT\":149,\"UPD_TARGET\":\"premise\",\"UPD_NAME\":\"CONSECTETUR\",\"UPD_DISPLAY\":\"id a\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"STRING\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":6,\"UPD_CREATED\":\"2026-07-07 00:48:38\",\"UPD_DOC_VARNAME\":\"\",\"UPD_SHOW\":1,\"UPD_PAY_SHOW\":0,\"UPD_PROVISIONING\":0,\"UPD_SYSTEM\":\"N\",\"UPD_SC_VISIBLE\":null,\"UPD_SC_EDITABLE\":null}}}", "name": "" } ] }, { "name": "Delete customer param", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:customer_id\/params\/:name", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers\/:customer_id\/params\/:name", "variable": [ { "id": "customer_id", "key": "customer_id", "value": "68", "description": "The ID of the customer." }, { "id": "name", "key": "name", "value": "INFO_EMAIL", "description": "The parameter name (UP_NAME)." }, { "id": "customer", "key": "customer", "value": "12345", "description": "The customer ID (USER_ID)." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Hard-delete all rows for the given `(customer, name)` pair. **Refuses time-resolved\nparams** with `error_name=Users.Param.Delete.Unimplemented` \u2014 there is no SP support\nfor deleting individual validity slots. Idempotent: a second call against an\nalready-empty pair returns 204 with no error." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Customer Service Discounts", "description": "", "item": [ { "name": "List Customer Service Discounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-service-discounts", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated customer service discount IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Resolves indirectly via customer.", "disabled": false }, { "key": "customer", "value": "100", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "customer_service", "value": "500", "description": "Filter by customer service (services_active) ID.", "disabled": false }, { "key": "discount_definition", "value": "10", "description": "Filter by discount definition (campaign) ID.", "disabled": false }, { "key": "status", "value": "ACTIVE%2CWAITING", "description": "Filter by status. Comma-separated for multiple values.", "disabled": false }, { "key": "active", "value": "1", "description": "Shorthand: when true, returns only ACTIVE discounts. Ignored when `status` is provided.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-service-discounts?per_page=15&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=100&customer_service=500&discount_definition=10&status=ACTIVE%2CWAITING&active=1" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of discounts applied to customer services.\nFilterable by customer, service, discount definition, status, and more.\nCT scoping is indirect \u2014 resolved via the customer's location." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SAD_ID\":316280,\"SAD_U_ID\":2878,\"SAD_SA_ID\":2839,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"definite\",\"SAD_VALUE\":\"66.2031\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-03-29 10:20:31\",\"SAD_CREATOR_L_ID\":3940,\"SAD_STATUS\":\"ACTIVE\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null},{\"SAD_ID\":316281,\"SAD_U_ID\":336,\"SAD_SA_ID\":4086,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"percentage\",\"SAD_VALUE\":\"88.5325\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-07-26 04:03:01\",\"SAD_CREATOR_L_ID\":7018,\"SAD_STATUS\":\"ACTIVE\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}]}", "name": "" } ] }, { "name": "Get Customer Service Discount", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-service-discounts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-service-discounts\/:id", "variable": [ { "id": "id", "key": "id", "value": "474", "description": "The ID of the customer service discount." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single customer service discount by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SAD_ID\":316282,\"SAD_U_ID\":2878,\"SAD_SA_ID\":2839,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"definite\",\"SAD_VALUE\":\"66.2031\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-03-29 10:20:31\",\"SAD_CREATOR_L_ID\":3940,\"SAD_STATUS\":\"ACTIVE\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}}", "name": "" } ] } ] }, { "name": "Customer Service Event Types", "description": "", "item": [ { "name": "List Service Event Types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-service-event-types", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-service-event-types?per_page=10&page=1&ids=1%2C2%2C3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of service event types.\nThis is a global codelist \u2014 no CT scoping is applied." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":56,\"NAME\":\"Zm\\u011bna procesn\\u00ed skupiny (technologie)\",\"SET_PRICE_AFFECT\":0,\"SET_ATTACHMENT\":0,\"SET_MT_NAME\":null,\"SET_CAN_DELETE\":0,\"SET_CAN_EDIT\":0,\"SET_EU_SHOW\":0,\"SET_PDC_ERASE\":1},{\"ID\":8,\"NAME\":\"Odblokov\\u00e1n\\u00ed slu\\u017eby\",\"SET_PRICE_AFFECT\":1,\"SET_ATTACHMENT\":0,\"SET_MT_NAME\":\"UNBLOCK_SERVICE\",\"SET_CAN_DELETE\":1,\"SET_CAN_EDIT\":0,\"SET_EU_SHOW\":1,\"SET_PDC_ERASE\":0}]}", "name": "" } ] } ] }, { "name": "Customer Service History", "description": "", "item": [ { "name": "List Service History", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-service-history", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated service history IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "100", "description": "Filter by customer ID (USER_ID)", "disabled": false }, { "key": "service_id", "value": "50", "description": "Filter by service definition ID (SERVICE_ID)", "disabled": false }, { "key": "customer_service", "value": "200", "description": "Filter by active service instance ID (USER_SERVICE_ID)", "disabled": false }, { "key": "event_type", "value": "4", "description": "Filter by event type ID (EVENT_TYPE)", "disabled": false }, { "key": "created_from", "value": "2024-01-01", "description": "Filter events created on or after this date\/datetime (TIME column)", "disabled": false }, { "key": "created_to", "value": "2024-12-31", "description": "Filter events created on or before this date\/datetime (TIME column)", "disabled": false }, { "key": "search", "value": "Aktivace", "description": "Search by event note title (partial match on NOTE_TITLE)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-service-history?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=100&service_id=50&customer_service=200&event_type=4&created_from=2024-01-01&created_to=2024-12-31&search=Aktivace" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of service history events.\nAt least one identifying filter (customer, service_id, customer_service, or event_type) is required." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":783608232,\"USER_ID\":2878,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-02-15 00:04:24\",\"CHANGE_TIME\":\"2006-05-29\",\"EVENT_TYPE\":3,\"PRICE\":null,\"PAYMENT_DEPRECATED\":null,\"SH_PERIOD\":\"none\",\"NOTE_TITLE\":null,\"NOTE_BODY\":null,\"ADD_PARAM\":null,\"AUTHOR\":0,\"SH_TRANSFER\":0,\"SH_CRM_CHANNEL\":null,\"SH_DR_ID\":null,\"SH_SELFCARE\":0,\"params\":[{\"SHP_ID\":21288628,\"SHP_SH_ID\":783608232,\"SHP_NAME\":\"qui\",\"SHP_VALUE\":\"Incidunt iure odit et et modi ipsum.\"}]},{\"ID\":783608233,\"USER_ID\":6877,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-06-21 01:30:42\",\"CHANGE_TIME\":\"2009-07-27\",\"EVENT_TYPE\":7,\"PRICE\":null,\"PAYMENT_DEPRECATED\":null,\"SH_PERIOD\":\"none\",\"NOTE_TITLE\":null,\"NOTE_BODY\":null,\"ADD_PARAM\":null,\"AUTHOR\":0,\"SH_TRANSFER\":0,\"SH_CRM_CHANNEL\":null,\"SH_DR_ID\":null,\"SH_SELFCARE\":0,\"params\":[{\"SHP_ID\":21288629,\"SHP_SH_ID\":783608233,\"SHP_NAME\":\"consequatur\",\"SHP_VALUE\":\"Dolores enim non facere tempora.\"}]}]}", "name": "" } ] }, { "name": "Get Service History Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-service-history\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-service-history\/:id", "variable": [ { "id": "id", "key": "id", "value": "123", "description": "The ID of the customer service history." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a specific service history event by ID, including its parameter snapshots." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":783608234,\"USER_ID\":2878,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-02-15 00:02:36\",\"CHANGE_TIME\":\"2006-05-29\",\"EVENT_TYPE\":3,\"PRICE\":null,\"PAYMENT_DEPRECATED\":null,\"SH_PERIOD\":\"none\",\"NOTE_TITLE\":null,\"NOTE_BODY\":null,\"ADD_PARAM\":null,\"AUTHOR\":0,\"SH_TRANSFER\":0,\"SH_CRM_CHANNEL\":null,\"SH_DR_ID\":null,\"SH_SELFCARE\":0,\"params\":[{\"SHP_ID\":21288630,\"SHP_SH_ID\":783608234,\"SHP_NAME\":\"qui\",\"SHP_VALUE\":\"Incidunt iure odit et et modi ipsum.\"}]}}", "name": "" } ] } ] }, { "name": "Customer Service Params", "description": "", "item": [ { "name": "List customer service params", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:customerService\/params", "query": [ { "key": "order", "value": "SP_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: SP_ID, SP_NAME, SP_VALID_FROM, SP_VALID_TO, SP_CREATED.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "name", "value": "msisdn", "description": "Filter by parameter name (SP_NAME). Returns all rows for that name (full history + planned). Overrides the default valid_at=today.", "disabled": false }, { "key": "valid_at", "value": "2026-01-15", "description": "Filter to parameters valid on this date (YYYY-MM-DD). Default: today when `name` is not set. Ignored when `name` is set.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:customerService\/params?order=SP_ID%3Adesc&per_page=15&page=1&name=msisdn&valid_at=2026-01-15", "variable": [ { "id": "customerService", "key": "customerService", "value": "12345", "description": "The active-service ID (services_active.ID)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns parameter rows for a customer's active service. By default returns only\ncurrently-valid rows (`SP_VALID_FROM <= today <= SP_VALID_TO`, NULL valid_to = open-ended).\nFilter by `name` to see the full history of a single param (planned + expired values),\nor `valid_at=YYYY-MM-DD` to see what is\/was\/will be valid on a specific date." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SP_ID\":3745555,\"SP_SRV_ID\":2878,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"2006-05-28T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"nostrum\",\"SP_CREATED\":\"2026-03-31T19:09:05.000000Z\",\"SP_L_ID\":5485},{\"SP_ID\":3745556,\"SP_SRV_ID\":3940,\"SP_NAME\":\"agr_max_down_speed\",\"SP_VALID_FROM\":\"1989-10-06T23:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"et\",\"SP_CREATED\":\"2026-07-01T18:05:32.000000Z\",\"SP_L_ID\":1769}]}", "name": "" } ] }, { "name": "Set customer service param (upsert)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:customerService\/params\/:name", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:customerService\/params\/:name", "variable": [ { "id": "customerService", "key": "customerService", "value": "12345", "description": "The active-service ID (services_active.ID)." }, { "id": "name", "key": "name", "value": "msisdn", "description": "The parameter name (SP_NAME). Must resolve to a services_class_params definition for the service class." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"value\":\"420123456789\",\"valid_from\":\"2026-07-01\"}" }, "description": "Upsert a parameter value for a customer's active service via `services_active_param_edit`.\n\n- `valid_from` defaults to **today** (effective now). A **future** `valid_from` schedules a\n value change: a new validity slot is inserted and the prior slot's `valid_to` is closed\n automatically.\n- The response is the slot **effective at `valid_from`** (the row just written\/affected) \u2014\n not necessarily a freshly created id, because the SP reconnects same-value neighbours.\n- `PASSWORD`-typed params take **plaintext** (the SP hashes it); reads expose the stored\n ciphertext. `FILE`-typed and price-bearing params are rejected with 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SP_ID\":3745557,\"SP_SRV_ID\":2878,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"2006-05-28T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"nostrum\",\"SP_CREATED\":\"2026-03-31T19:09:05.000000Z\",\"SP_L_ID\":5485}}", "name": "" } ] }, { "name": "Delete customer service param", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:customerService\/params\/:name", "query": [ { "key": "valid_to", "value": "2026-12-31", "description": "Date to end validity (YYYY-MM-DD), passed as a query parameter (?valid_to=YYYY-MM-DD). Omitted = immediate termination. A past date is rejected by the SP (Services.ParamDelete.BackwardDelete \u2192 400).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:customerService\/params\/:name?valid_to=2026-12-31", "variable": [ { "id": "customerService", "key": "customerService", "value": "12345", "description": "The active-service ID (services_active.ID)." }, { "id": "name", "key": "name", "value": "msisdn", "description": "The parameter name (SP_NAME)." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "End the validity of a parameter via `services_active_param_delete`. Provide `valid_to`\n(query param) to schedule the end date; omit it for **immediate** termination (closes\nstill-valid rows to yesterday, or hard-deletes a not-yet-started row). Returns **404** when\nno currently-active row exists for the name (the SP itself cannot signal this). A past\n`valid_to` is rejected with `error_name=Services.ParamDelete.BackwardDelete` (400)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Customer Services", "description": "", "item": [ { "name": "List Customer Services", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated service IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "user", "value": "100", "description": "Filter by customer (user) ID", "disabled": false }, { "key": "state", "value": "01%2C03", "description": "Filter by comma-separated state codes. When omitted, cancelled services (02) are excluded; pass `state` to include them.", "disabled": false }, { "key": "periodic", "value": "true", "description": "Filter by periodic billing: true = monthly (TYPE=M), false = one-time (TYPE=S)", "disabled": false }, { "key": "dependent", "value": "true", "description": "Filter by dependency: true = dependent services, false = base services", "disabled": false }, { "key": "base_service", "value": "500", "description": "Filter dependent services linked to a specific base service ID", "disabled": false }, { "key": "device", "value": "200", "description": "Filter services linked to a specific device (node) ID", "disabled": false }, { "key": "provider", "value": "500", "description": "Filter by provider user ID", "disabled": false }, { "key": "service_definition", "value": "10%2C20%2C30", "description": "Filter by comma-separated service definition IDs", "disabled": false }, { "key": "billing_plan", "value": "42", "description": "Filter by current billing plan ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-services?ids=1%2C2%2C3&cts=1%2C2%2C3&user=100&state=01%2C03&periodic=true&dependent=true&base_service=500&device=200&provider=500&service_definition=10%2C20%2C30&billing_plan=42" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of customer services.\nBy default, cancelled services (state 02) are excluded." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":4790476,\"USER_ID\":\"02878\",\"SERVICE_ID\":\"2839\",\"PRICE\":\"3668.8918\",\"DATE_START\":\"2015-01-19\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2022-08-17\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"cyear\",\"SA_LOCATION\":null,\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":null,\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:49\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745549,\"SP_SRV_ID\":4790476,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1973-08-19T23:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"ipsum\",\"SP_CREATED\":\"2026-07-26T02:03:21.000000Z\",\"SP_L_ID\":7018}],\"discounts\":[{\"SAD_ID\":316273,\"SAD_U_ID\":4486,\"SAD_SA_ID\":4790476,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"points\",\"SAD_VALUE\":\"72.9772\",\"SAD_START\":\"1997-02-21\",\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-05-23 02:00:34\",\"SAD_CREATOR_L_ID\":2327,\"SAD_STATUS\":\"FINISHED\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}]},{\"ID\":4790477,\"USER_ID\":\"05468\",\"SERVICE_ID\":\"5937\",\"PRICE\":\"8661.9358\",\"DATE_START\":\"2023-08-06\",\"DATE_END\":null,\"STATE\":\"02\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"1975-01-02\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"none\",\"SA_LOCATION\":\"Daphneview\",\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":\"Libero aliquam veniam corporis dolorem mollitia deleniti.\",\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:50\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745550,\"SP_SRV_ID\":4790477,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1976-05-05T23:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"officia\",\"SP_CREATED\":\"2026-05-31T10:59:40.000000Z\",\"SP_L_ID\":8925}],\"discounts\":[{\"SAD_ID\":316274,\"SAD_U_ID\":2531,\"SAD_SA_ID\":4790477,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"points\",\"SAD_VALUE\":\"88.4282\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-01-23 09:32:27\",\"SAD_CREATOR_L_ID\":5560,\"SAD_STATUS\":\"WAITING\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}]}]}", "name": "" } ] }, { "name": "Activate Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":100,\"date_start\":\"2026-01-01\",\"date_from\":\"2026-01-01\",\"service_id\":50,\"date_min\":\"architecto\",\"price\":299,\"bp_id\":16,\"billing_data\":[],\"period\":\"month\",\"location\":\"architecto\",\"note\":\"architecto\",\"service_params\":[],\"invoice_note\":\"architecto\",\"not_use_connect\":16,\"due_days\":\"architecto\",\"premise_id\":16,\"add_param\":\"architecto\",\"node_id\":16,\"needs_process\":16,\"salesman_id\":16,\"agreement_date\":\"architecto\",\"crm_channel\":16,\"base_service_id\":16,\"unicredit_assign\":16,\"autoconnect\":16,\"uc_type\":\"architecto\",\"nodeavail_sgd_id\":16,\"name\":\"architecto\",\"bp_user_default_change\":16,\"snd_id\":16,\"provider_user_id\":16}" }, "description": "Activates (creates) a new customer service." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":4790478,\"USER_ID\":\"02938\",\"SERVICE_ID\":\"4027\",\"PRICE\":\"6356.1332\",\"DATE_START\":\"1972-12-17\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2020-04-10\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"vyear\",\"SA_LOCATION\":null,\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":\"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\",\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:50\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745551,\"SP_SRV_ID\":4790478,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1981-07-28T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"adipisci\",\"SP_CREATED\":\"2026-07-21T23:00:08.000000Z\",\"SP_L_ID\":2617}],\"discounts\":[{\"SAD_ID\":316275,\"SAD_U_ID\":8015,\"SAD_SA_ID\":4790478,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"credit\",\"SAD_VALUE\":\"19.6504\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-04-10 12:49:02\",\"SAD_CREATOR_L_ID\":1839,\"SAD_STATUS\":\"WAITING\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}]}}", "name": "" } ] }, { "name": "Get Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single customer service by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":4790479,\"USER_ID\":\"07222\",\"SERVICE_ID\":\"6935\",\"PRICE\":\"4414.3963\",\"DATE_START\":\"2000-07-01\",\"DATE_END\":null,\"STATE\":\"02\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"1973-12-21\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"none\",\"SA_LOCATION\":\"South Hanna\",\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":null,\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:51\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745552,\"SP_SRV_ID\":4790479,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"2008-08-18T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"voluptatem\",\"SP_CREATED\":\"2026-07-05T17:52:58.000000Z\",\"SP_L_ID\":1580}],\"discounts\":[{\"SAD_ID\":316276,\"SAD_U_ID\":8900,\"SAD_SA_ID\":4790479,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"definite\",\"SAD_VALUE\":\"64.5372\",\"SAD_START\":\"1990-03-27\",\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-06-05 11:08:43\",\"SAD_CREATOR_L_ID\":1416,\"SAD_STATUS\":\"ACTIVE\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}],\"dependent_services\":[{\"SAL_ID\":\"00000202332\",\"SAL_TYPE\":\"motivation1\",\"SAL_SA_ID\":4790479,\"SAL_LINKED_SA_ID\":1284,\"SAL_VALID_FROM\":null,\"SAL_VALID_TO\":null,\"SAL_SAD_ID\":null,\"SAL_CREATED\":\"2026-07-12 23:20:49\",\"SAL_CREATOR_ID\":\"009930\"}]}}", "name": "" } ] }, { "name": "Change Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-01-01\",\"price\":399,\"bp_id\":16,\"billing_data\":[],\"period\":\"month\",\"note\":\"architecto\",\"service_params\":[],\"date_min\":\"architecto\",\"nodeavail_sgd_id\":16,\"salesman_id\":16,\"name\":\"architecto\",\"bp_user_default_change\":16,\"period_dep\":16}" }, "description": "Changes (edits) an existing customer service via services_active_change." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":4790480,\"USER_ID\":\"02938\",\"SERVICE_ID\":\"4027\",\"PRICE\":\"6356.1332\",\"DATE_START\":\"1972-12-17\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2020-04-10\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"vyear\",\"SA_LOCATION\":null,\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":\"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\",\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:51\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745553,\"SP_SRV_ID\":4790480,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1981-07-28T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"adipisci\",\"SP_CREATED\":\"2026-07-21T22:57:37.000000Z\",\"SP_L_ID\":2617}],\"discounts\":[{\"SAD_ID\":316277,\"SAD_U_ID\":8015,\"SAD_SA_ID\":4790480,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"credit\",\"SAD_VALUE\":\"19.6504\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-04-10 12:48:50\",\"SAD_CREATOR_L_ID\":1839,\"SAD_STATUS\":\"WAITING\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}]}}", "name": "" } ] }, { "name": "Cancel Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"date_end\":\"2026-12-31\"}" }, "description": "Cancels (deactivates) a customer service. This is a soft cancel, not a hard delete.\n\nOptional `date_end` (YYYY-MM-DD) sets the termination date the service ends on; omitted = today.\n\nOnly periodic (recurring) services can be cancelled; a one-time service is rejected with `Services.CanCancel.Periodicity` (HTTP 400)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Block Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id\/block", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id\/block", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-01-01\",\"note\":\"architecto\",\"interrupt\":16,\"blocked_billing\":16,\"blocked_auto\":16,\"credit_create\":16}" }, "description": "Blocks an active customer service." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Unblock Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id\/unblock", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id\/unblock", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"date\":\"architecto\",\"note\":\"architecto\",\"interrupt\":16,\"blocked_billing\":16,\"sn_id_list\":[16],\"blocked_auto\":16,\"create_credit\":16}" }, "description": "Unblocks a blocked customer service." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Connect Customer Service", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-services\/:id\/connect", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-services\/:id\/connect", "variable": [ { "id": "id", "key": "id", "value": "105", "description": "The ID of the customer service." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"date\":\"2026-07-09\",\"note\":\"architecto\",\"can_connect_in_future\":16}" }, "description": "Connects a prepared-but-not-yet-connected customer service (state 03 \"Nezapojeno\"),\ntransitioning it to active (state 01 \"Aktivn\u00ed\"). Requires the CONNECT_SERVICE right and a\nreadiness event on the service; the Mango procedure may reject it (see error_name)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":4790481,\"USER_ID\":\"02938\",\"SERVICE_ID\":\"4027\",\"PRICE\":\"6356.1332\",\"DATE_START\":\"1972-12-17\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2020-04-10\",\"ACCOUNT_TO\":null,\"DUE_DATE\":30,\"VAR_SYMBOL\":null,\"ACCORD_NUM\":null,\"TRADING_LIMIT\":null,\"SA_TRADING_LIMIT_ALERTED\":0,\"CUSTOMER_CHANGE_DEPRECATED\":null,\"SA_PERIOD\":\"vyear\",\"SA_LOCATION\":null,\"SA_TAX_CLOSURE\":null,\"SA_TAX_PREV_CLOSURE\":null,\"NOTE\":\"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\",\"SA_INV_NOTE\":null,\"SA_P_ID\":null,\"SA_CANCEL_REASON\":null,\"SA_AGREEMENT_DATE\":null,\"SA_NEEDS_PROCESS\":null,\"SA_CREATED\":\"2026-08-12 16:54:51\",\"SA_SALESMAN_ID\":null,\"SA_MOVING\":0,\"SA_MOVE_DATA\":null,\"SA_BOND_START\":null,\"SA_NODEAVAIL_SGD_ID\":null,\"SA_NAME\":null,\"SA_PROVIDER_USER_ID\":null,\"SA_PAY_TO\":null,\"SA_DATE_BASE\":null,\"params\":[{\"SP_ID\":3745554,\"SP_SRV_ID\":4790481,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1981-07-28T22:00:00.000000Z\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"adipisci\",\"SP_CREATED\":\"2026-07-21T22:57:37.000000Z\",\"SP_L_ID\":2617}],\"discounts\":[{\"SAD_ID\":316278,\"SAD_U_ID\":8015,\"SAD_SA_ID\":4790481,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"credit\",\"SAD_VALUE\":\"19.6504\",\"SAD_START\":null,\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-04-10 12:48:50\",\"SAD_CREATOR_L_ID\":1839,\"SAD_STATUS\":\"WAITING\",\"SAD_POINTS\":null,\"SAD_SD_START_RECREATE\":null,\"SAD_SADG_ID\":null,\"SAD_END_NOTIFIED\":null,\"SAD_STOP_FLOATING\":null}],\"dependent_services\":[{\"SAL_ID\":\"00000202333\",\"SAL_TYPE\":\"together\",\"SAL_SA_ID\":4790481,\"SAL_LINKED_SA_ID\":7018,\"SAL_VALID_FROM\":null,\"SAL_VALID_TO\":null,\"SAL_SAD_ID\":null,\"SAL_CREATED\":\"2026-05-18 19:08:38\",\"SAL_CREATOR_ID\":\"004196\"}]}}", "name": "" } ] } ] }, { "name": "Customer Units", "description": "", "item": [ { "name": "List Customer Units", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-units", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated customer unit IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "100", "description": "Filter by customer ID \u2014 returns units linked to this customer via nodes_services.", "disabled": false }, { "key": "customer_service", "value": "500", "description": "Filter by customer service ID \u2014 returns units linked to this service via nodes_services.", "disabled": false }, { "key": "unit_city", "value": "1234", "description": "Filter by UIR city ID (via uir_city_parts registry).", "disabled": false }, { "key": "unit_citypart", "value": "5678", "description": "Filter by UIR city part ID (N_UCP_ID).", "disabled": false }, { "key": "unit_street", "value": "9012", "description": "Filter by UIR street ID (N_US_ID).", "disabled": false }, { "key": "unit_address", "value": "3456", "description": "Filter by UIR address ID (N_UA_ID).", "disabled": false }, { "key": "region", "value": "10", "description": "Filter by address region group ID (groups_address). Matches units whose UIR address falls within the region.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customer-units?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=100&customer_service=500&unit_city=1234&unit_citypart=5678&unit_street=9012&unit_address=3456®ion=10" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a paginated list of customer units (residential\/business premises).\n Customer units are connection points in the network where customer services are delivered." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1811151,\"NAME\":\"UNIT-uwpwlv\",\"NOTE\":\"Odit et et modi.\",\"MANAGED\":0,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":null,\"N_TYPE\":\"BLK_DEVICE\",\"N_DEVICE_TYPE\":\"blk_device\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":1,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":0,\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":76,\"N_CREATED\":null,\"N_L_ID\":568,\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"omnis\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604096,\"NODE_ID\":1811151,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_flat_number\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203623,\"NS_N_ID\":1811151,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-01-22 20:34:06\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}]},{\"ID\":1811152,\"NAME\":\"UNIT-zsnrwt\",\"NOTE\":null,\"MANAGED\":0,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":null,\"N_TYPE\":\"BLK_DEVICE\",\"N_DEVICE_TYPE\":\"blk_device\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":1,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":0,\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":19,\"N_CREATED\":null,\"N_L_ID\":292,\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"quis\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604097,\"NODE_ID\":1811152,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_connection_type\",\"PAR_INDEX\":0,\"VALUE\":\"deleniti\",\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203624,\"NS_N_ID\":1811152,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-06-11 00:15:06\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}]}]}", "name": "" } ] }, { "name": "Get Customer Unit", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customer-units\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customer-units\/:id", "variable": [ { "id": "id", "key": "id", "value": "116416", "description": "The ID of the customer unit." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a specific customer unit by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1811153,\"NAME\":\"UNIT-qwrsit\",\"NOTE\":null,\"MANAGED\":0,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":null,\"N_TYPE\":\"BLK_DEVICE\",\"N_DEVICE_TYPE\":\"blk_device\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":1,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":0,\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":46,\"N_CREATED\":null,\"N_L_ID\":646,\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"autem\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604098,\"NODE_ID\":1811153,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_connection_type\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203625,\"NS_N_ID\":1811153,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-01-20 15:51:35\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}]}}", "name": "" } ] } ] }, { "name": "Customers", "description": "", "item": [ { "name": "List Customers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers", "query": [ { "key": "per_page", "value": "10", "description": "Number of users to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "search", "value": "Smith", "description": "Full-text search across FIRST_NAME, LAST_NAME, COMPANY (case-insensitive LIKE)", "disabled": false }, { "key": "groups_all", "value": "1%2C2", "description": "Filter customers who are members of ALL specified group IDs (comma-separated, AND logic)", "disabled": false }, { "key": "groups_any", "value": "1%2C2", "description": "Filter customers who are members of ANY of the specified group IDs (comma-separated, OR logic)", "disabled": false }, { "key": "device", "value": "4967", "description": "Filter customers linked to a specific device (node) ID via nodes_services", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/customers?per_page=10&page=1&active=true&ids=1%2C2%2C3&cts=1%2C2%2C3&search=Smith&groups_all=1%2C2&groups_any=1%2C2&device=4967" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint gets a list of customers.\n The list can be filtered and sorted." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"USER_ID\":2188777,\"LOGIN\":\"price.amber\",\"U_PASS_QUESTION\":null,\"U_PASS_ANSWER\":null,\"TYPE\":\"S\",\"P_TITLE\":null,\"FIRST_NAME\":\"Bailee\",\"LAST_NAME\":\"Leffler\",\"COMPANY\":\"Mitchell-VonRueden\",\"STREET\":\"Vesta Coves\",\"HOUSE_ID\":\"47809\",\"CITY\":\"Considinehaven\",\"ZIP\":\"36080-\",\"U_UC_ID\":null,\"U_US_ID\":null,\"U_UA_ID\":null,\"U_CL_ID\":null,\"ADR2\":null,\"U_RECIPIENT2\":null,\"STREET2\":null,\"HOUSE_ID2\":null,\"CITY2\":null,\"ZIP2\":null,\"U_UC_ID2\":null,\"U_US_ID2\":null,\"U_UA_ID2\":null,\"U_CL_ID2\":null,\"ADR3\":null,\"U_RECIPIENT3\":null,\"STREET3\":null,\"HOUSE_ID3\":null,\"CITY3\":null,\"ZIP3\":null,\"U_UC_ID3\":null,\"U_US_ID3\":null,\"U_UA_ID3\":null,\"U_CL_ID3\":null,\"FAX\":null,\"SERVICES\":\"doloremque\",\"COMP_ID\":null,\"COMP_FID\":null,\"ACTIVATION\":\"1900-01-01 00:00:00\",\"U_ACTIVATION_LAST\":\"2026-02-28 18:58:33\",\"INFO_MAIL\":1,\"INFO_POST\":null,\"USER_NOTE\":null,\"INTERNAL_NOTE\":null,\"CT\":\"008\",\"FLAT\":null,\"NOTE1\":null,\"NOTE2\":null,\"NOTE3\":null,\"NOTE4\":null,\"NOTE5\":null,\"NOTE6\":null,\"NOTE7\":null,\"NOTE8\":null,\"SIPO_NUM\":null,\"DATE_BEGIN\":null,\"DATE_END\":null,\"SIPO_DATE_FROM\":null,\"GROUP_ID\":null,\"VAR_SYMBOL\":null,\"AGR_NAME\":null,\"PERSON_ID_NUMBER\":null,\"U_BIRTHDAY\":null,\"U_PERSONAL_NUMBER\":null,\"U_DOCUMENT_NUMBER\":null,\"ACCOUNT_PRE_NUMBER\":null,\"ACCOUNT_NUMBER\":null,\"ACCOUNT_BANK\":null,\"U_IBAN\":null,\"U_ACCOUNT_ATTACH\":null,\"U_ACCOUNT_SPECSYM\":null,\"SALESMAN\":null,\"U_BIRTH_NUMBER\":null,\"U_TECH_LOC\":null,\"U_FLAT_TYPE\":null,\"U_TECH_NAME\":null,\"U_PREMISES\":0,\"U_INV_NOTE\":null,\"U_CODENAME\":null,\"U_ACTIVE\":1,\"LOG_LEVEL\":\"INFO\",\"U_INFO_SMS\":0,\"U_PERSON_ID\":null,\"U_STATUTARY\":null,\"U_COMP_VATID\":null,\"U_DEFAULT_BP_ID\":null,\"U_EU_FIRST_LOGIN\":1,\"U_PASS_EXPIRE\":null,\"U_PASS_CHANGE\":null,\"U_REGENERATE\":null,\"U_REGENERATE_L_ID\":null,\"U_REGENERATE_PAYMENTS\":null,\"U_REGENERATE_PAYMENTS_L_ID\":null,\"U_PROV_LEVEL\":10,\"U_DEGREE_BEHIND\":null,\"U_PROVISIONING\":0,\"U_CODE_REFERENCES\":null,\"U_BATCH\":null,\"U_VALUATION\":null,\"U_PROVIDER_USER_ID\":null,\"U_PROVIDER_TYPE\":\"NONE\",\"U_PROVIDER_LABEL\":null,\"U_PROVIDER_ACTIVE\":null,\"U_INFO_MARKETING\":null,\"U_OFF_LIMIT\":null,\"U_LAST_USAGE\":null,\"U_LAST_CHANGE\":null,\"U_DEBTS_GENERATE\":0,\"U_EXTRA_WORK_DETAIL\":0,\"U_WORKS_COUNT_STRATEGY\":\"MINS\",\"U_GROUP_COMP_FID\":0,\"params\":[{\"UP_ID\":998818,\"UP_USER_ID\":2188777,\"UP_NAME\":\"param_wqbe\",\"UP_VALID_FROM\":\"2026-04-04T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Mollitia deleniti nemo.\",\"UP_CONTENT\":\"Est dignissimos neque blanditiis odio veritatis excepturi doloribus. Fugit qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.\",\"UP_CREATED\":\"2026-08-05T00:47:30.000000Z\",\"UP_L_ID\":712}],\"contact_phone_numbers\":[{\"CPN_ID\":1215929,\"CPN_SUBJ_ID\":2188777,\"CPN_VALID\":1,\"CPN_PHONE\":612737045,\"CPN_L_ID\":2580,\"CPN_LAST_UPDATE\":\"2026-02-01 10:29:20\"}],\"contact_email_addresses\":[{\"CEA_ID\":454907,\"CEA_SUBJ_ID\":2188777,\"CEA_VALID\":1,\"CEA_EMAIL\":\"ggreenholt@example.com\",\"CEA_L_ID\":2192,\"CEA_LAST_UPDATE\":\"2026-05-11 22:46:43\"}]},{\"USER_ID\":2188778,\"LOGIN\":\"lakin.ellsworth\",\"U_PASS_QUESTION\":6,\"U_PASS_ANSWER\":\"sed\",\"TYPE\":\"S\",\"P_TITLE\":null,\"FIRST_NAME\":\"Lambert\",\"LAST_NAME\":\"Watsica\",\"COMPANY\":\"Johnson, Kris and Leffler\",\"STREET\":\"Raymundo Plains\",\"HOUSE_ID\":\"794\",\"CITY\":\"Batzchester\",\"ZIP\":\"26870-\",\"U_UC_ID\":null,\"U_US_ID\":null,\"U_UA_ID\":null,\"U_CL_ID\":null,\"ADR2\":null,\"U_RECIPIENT2\":null,\"STREET2\":null,\"HOUSE_ID2\":null,\"CITY2\":null,\"ZIP2\":null,\"U_UC_ID2\":null,\"U_US_ID2\":null,\"U_UA_ID2\":null,\"U_CL_ID2\":null,\"ADR3\":null,\"U_RECIPIENT3\":null,\"STREET3\":null,\"HOUSE_ID3\":null,\"CITY3\":null,\"ZIP3\":null,\"U_UC_ID3\":null,\"U_US_ID3\":null,\"U_UA_ID3\":null,\"U_CL_ID3\":null,\"FAX\":null,\"SERVICES\":\"odit\",\"COMP_ID\":null,\"COMP_FID\":null,\"ACTIVATION\":\"1900-01-01 00:00:00\",\"U_ACTIVATION_LAST\":\"2026-04-13 21:57:27\",\"INFO_MAIL\":1,\"INFO_POST\":null,\"USER_NOTE\":null,\"INTERNAL_NOTE\":null,\"CT\":\"002\",\"FLAT\":null,\"NOTE1\":null,\"NOTE2\":null,\"NOTE3\":null,\"NOTE4\":null,\"NOTE5\":null,\"NOTE6\":null,\"NOTE7\":null,\"NOTE8\":null,\"SIPO_NUM\":null,\"DATE_BEGIN\":null,\"DATE_END\":null,\"SIPO_DATE_FROM\":null,\"GROUP_ID\":null,\"VAR_SYMBOL\":null,\"AGR_NAME\":null,\"PERSON_ID_NUMBER\":null,\"U_BIRTHDAY\":null,\"U_PERSONAL_NUMBER\":null,\"U_DOCUMENT_NUMBER\":null,\"ACCOUNT_PRE_NUMBER\":null,\"ACCOUNT_NUMBER\":null,\"ACCOUNT_BANK\":null,\"U_IBAN\":null,\"U_ACCOUNT_ATTACH\":null,\"U_ACCOUNT_SPECSYM\":null,\"SALESMAN\":null,\"U_BIRTH_NUMBER\":null,\"U_TECH_LOC\":null,\"U_FLAT_TYPE\":null,\"U_TECH_NAME\":null,\"U_PREMISES\":0,\"U_INV_NOTE\":null,\"U_CODENAME\":null,\"U_ACTIVE\":1,\"LOG_LEVEL\":\"INFO\",\"U_INFO_SMS\":0,\"U_PERSON_ID\":null,\"U_STATUTARY\":null,\"U_COMP_VATID\":null,\"U_DEFAULT_BP_ID\":null,\"U_EU_FIRST_LOGIN\":1,\"U_PASS_EXPIRE\":null,\"U_PASS_CHANGE\":null,\"U_REGENERATE\":null,\"U_REGENERATE_L_ID\":null,\"U_REGENERATE_PAYMENTS\":null,\"U_REGENERATE_PAYMENTS_L_ID\":null,\"U_PROV_LEVEL\":10,\"U_DEGREE_BEHIND\":null,\"U_PROVISIONING\":0,\"U_CODE_REFERENCES\":null,\"U_BATCH\":null,\"U_VALUATION\":null,\"U_PROVIDER_USER_ID\":null,\"U_PROVIDER_TYPE\":\"NONE\",\"U_PROVIDER_LABEL\":null,\"U_PROVIDER_ACTIVE\":null,\"U_INFO_MARKETING\":null,\"U_OFF_LIMIT\":null,\"U_LAST_USAGE\":null,\"U_LAST_CHANGE\":null,\"U_DEBTS_GENERATE\":0,\"U_EXTRA_WORK_DETAIL\":0,\"U_WORKS_COUNT_STRATEGY\":\"MINS\",\"U_GROUP_COMP_FID\":0,\"params\":[{\"UP_ID\":998819,\"UP_USER_ID\":2188778,\"UP_NAME\":\"param_bfyw\",\"UP_VALID_FROM\":\"2026-06-22T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Dolores omnis et earum consequatur.\",\"UP_CONTENT\":null,\"UP_CREATED\":\"2026-04-01T21:06:51.000000Z\",\"UP_L_ID\":851}],\"contact_phone_numbers\":[{\"CPN_ID\":1215930,\"CPN_SUBJ_ID\":2188778,\"CPN_VALID\":1,\"CPN_PHONE\":441332341,\"CPN_L_ID\":1589,\"CPN_LAST_UPDATE\":\"2026-01-25 02:52:07\"}],\"contact_email_addresses\":[{\"CEA_ID\":454908,\"CEA_SUBJ_ID\":2188778,\"CEA_VALID\":0,\"CEA_EMAIL\":\"kenna.ortiz@example.org\",\"CEA_L_ID\":1601,\"CEA_LAST_UPDATE\":\"2026-05-12 19:46:31\"}]}]}", "name": "" } ] }, { "name": "Create Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"login\":\"john.doe\",\"password\":\"secret123\",\"pass_question\":\"architecto\",\"pass_answer\":\"architecto\",\"type\":\"S\",\"ptitle\":\"architecto\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"company\":\"Doe Corp\",\"street\":\"Main Street 1\",\"house_id\":\"12A\",\"city\":\"New York\",\"zip\":\"10001\",\"adr2\":\"AS1\",\"recipient2\":\"architecto\",\"street2\":\"architecto\",\"house_id2\":\"architecto\",\"city2\":\"architecto\",\"zip2\":\"architecto\",\"adr3\":\"AS2\",\"recipient3\":\"architecto\",\"street3\":\"architecto\",\"house_id3\":\"architecto\",\"city3\":\"architecto\",\"zip3\":\"architecto\",\"phones\":[\"architecto\"],\"fax\":\"architecto\",\"emails\":[\"architecto\"],\"comp_id\":\"12345678\",\"comp_fid\":\"CZ12345678\",\"personal_number\":\"architecto\",\"birthday\":\"1990-01-15\",\"info_mail\":1,\"info_post\":0,\"info_sms\":0,\"premises\":\"architecto\",\"active\":1,\"agr_name\":\"architecto\",\"varsym\":\"architecto\",\"sipo\":\"architecto\",\"account_pre_num\":\"architecto\",\"account_num\":\"architecto\",\"account_bank\":\"architecto\",\"account_specsym\":\"architecto\",\"note_user\":\"architecto\",\"note_internal\":\"architecto\",\"note_invoice\":\"architecto\",\"flat\":\"architecto\",\"flat_type\":\"architecto\",\"tech_loc\":\"architecto\",\"tech_name\":\"architecto\",\"codename\":\"architecto\",\"log_level\":\"INFO\",\"document_number\":\"architecto\",\"statutary\":\"architecto\",\"comp_vatid\":\"SK1234567890\",\"default_bp_id\":16,\"eu_first_login\":16,\"activation\":\"2024-01-15 09:00:00\",\"prov_level\":16,\"degree_behind\":\"architecto\",\"account_attach\":\"architecto\",\"code_references\":\"architecto\",\"valuation\":\"architecto\",\"uc_id\":16,\"us_id\":16,\"ua_id\":16,\"uc_id2\":16,\"us_id2\":16,\"ua_id2\":16,\"uc_id3\":16,\"us_id3\":16,\"ua_id3\":16,\"bp_ids\":[16],\"provider_user_id\":16,\"cl_id\":16,\"cl_id2\":16,\"cl_id3\":16,\"iban\":\"architecto\",\"info_marketing\":16,\"vat_registered\":16,\"group_comp_fid\":\"architecto\",\"params\":[[]],\"consent\":[{\"flag\":1,\"pdc_id\":11,\"channel\":\"email\",\"date_consent\":\"2024-01-01\"}]}" }, "description": " This endpoint creates a new customer." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"USER_ID\":2188779,\"LOGIN\":\"gbailey\",\"U_PASS_QUESTION\":7,\"U_PASS_ANSWER\":\"perspiciatis\",\"TYPE\":\"S\",\"P_TITLE\":\"Mr.\",\"FIRST_NAME\":\"Amber\",\"LAST_NAME\":\"Dare\",\"COMPANY\":\"Leuschke Inc\",\"STREET\":\"McLaughlin Mountain\",\"HOUSE_ID\":\"1052\",\"CITY\":\"Careymouth\",\"ZIP\":\"17091-\",\"U_UC_ID\":null,\"U_US_ID\":null,\"U_UA_ID\":null,\"U_CL_ID\":null,\"ADR2\":null,\"U_RECIPIENT2\":null,\"STREET2\":null,\"HOUSE_ID2\":null,\"CITY2\":null,\"ZIP2\":null,\"U_UC_ID2\":null,\"U_US_ID2\":null,\"U_UA_ID2\":null,\"U_CL_ID2\":null,\"ADR3\":null,\"U_RECIPIENT3\":null,\"STREET3\":null,\"HOUSE_ID3\":null,\"CITY3\":null,\"ZIP3\":null,\"U_UC_ID3\":null,\"U_US_ID3\":null,\"U_UA_ID3\":null,\"U_CL_ID3\":null,\"FAX\":null,\"SERVICES\":\"enim\",\"COMP_ID\":null,\"COMP_FID\":null,\"ACTIVATION\":\"1900-01-01 00:00:00\",\"U_ACTIVATION_LAST\":\"2026-05-23 02:07:08\",\"INFO_MAIL\":1,\"INFO_POST\":null,\"USER_NOTE\":null,\"INTERNAL_NOTE\":null,\"CT\":\"000\",\"FLAT\":null,\"NOTE1\":null,\"NOTE2\":null,\"NOTE3\":null,\"NOTE4\":null,\"NOTE5\":null,\"NOTE6\":null,\"NOTE7\":null,\"NOTE8\":null,\"SIPO_NUM\":null,\"DATE_BEGIN\":null,\"DATE_END\":null,\"SIPO_DATE_FROM\":null,\"GROUP_ID\":null,\"VAR_SYMBOL\":null,\"AGR_NAME\":null,\"PERSON_ID_NUMBER\":null,\"U_BIRTHDAY\":null,\"U_PERSONAL_NUMBER\":null,\"U_DOCUMENT_NUMBER\":null,\"ACCOUNT_PRE_NUMBER\":null,\"ACCOUNT_NUMBER\":null,\"ACCOUNT_BANK\":null,\"U_IBAN\":null,\"U_ACCOUNT_ATTACH\":null,\"U_ACCOUNT_SPECSYM\":null,\"SALESMAN\":null,\"U_BIRTH_NUMBER\":null,\"U_TECH_LOC\":null,\"U_FLAT_TYPE\":null,\"U_TECH_NAME\":null,\"U_PREMISES\":0,\"U_INV_NOTE\":null,\"U_CODENAME\":null,\"U_ACTIVE\":1,\"LOG_LEVEL\":\"INFO\",\"U_INFO_SMS\":0,\"U_PERSON_ID\":null,\"U_STATUTARY\":null,\"U_COMP_VATID\":null,\"U_DEFAULT_BP_ID\":null,\"U_EU_FIRST_LOGIN\":1,\"U_PASS_EXPIRE\":null,\"U_PASS_CHANGE\":null,\"U_REGENERATE\":null,\"U_REGENERATE_L_ID\":null,\"U_REGENERATE_PAYMENTS\":null,\"U_REGENERATE_PAYMENTS_L_ID\":null,\"U_PROV_LEVEL\":10,\"U_DEGREE_BEHIND\":null,\"U_PROVISIONING\":0,\"U_CODE_REFERENCES\":null,\"U_BATCH\":null,\"U_VALUATION\":null,\"U_PROVIDER_USER_ID\":null,\"U_PROVIDER_TYPE\":\"NONE\",\"U_PROVIDER_LABEL\":null,\"U_PROVIDER_ACTIVE\":null,\"U_INFO_MARKETING\":null,\"U_OFF_LIMIT\":null,\"U_LAST_USAGE\":null,\"U_LAST_CHANGE\":null,\"U_DEBTS_GENERATE\":0,\"U_EXTRA_WORK_DETAIL\":0,\"U_WORKS_COUNT_STRATEGY\":\"MINS\",\"U_GROUP_COMP_FID\":0,\"params\":[{\"UP_ID\":998820,\"UP_USER_ID\":2188779,\"UP_NAME\":\"param_rwtu\",\"UP_VALID_FROM\":\"2026-03-29T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Quis adipisci molestias fugit.\",\"UP_CONTENT\":null,\"UP_CREATED\":\"2026-06-10T23:01:46.000000Z\",\"UP_L_ID\":945}],\"contact_phone_numbers\":[{\"CPN_ID\":1215931,\"CPN_SUBJ_ID\":2188779,\"CPN_VALID\":1,\"CPN_PHONE\":739965127,\"CPN_L_ID\":4781,\"CPN_LAST_UPDATE\":\"2026-02-07 14:02:09\"}],\"contact_email_addresses\":[{\"CEA_ID\":454909,\"CEA_SUBJ_ID\":2188779,\"CEA_VALID\":1,\"CEA_EMAIL\":\"madisen51@example.net\",\"CEA_L_ID\":1076,\"CEA_LAST_UPDATE\":\"2026-04-28 14:32:20\"}]}}", "name": "" } ] }, { "name": "Get Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "68", "description": "The ID of the customer." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint retrieves a specific customer by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"USER_ID\":2188780,\"LOGIN\":\"imclaughlin\",\"U_PASS_QUESTION\":null,\"U_PASS_ANSWER\":\"praesentium\",\"TYPE\":\"S\",\"P_TITLE\":null,\"FIRST_NAME\":\"Annabelle\",\"LAST_NAME\":\"Kshlerin\",\"COMPANY\":\"Hettinger, Nitzsche and Ankunding\",\"STREET\":\"Verlie Manors\",\"HOUSE_ID\":\"651\",\"CITY\":\"Lake Noahberg\",\"ZIP\":\"40837-\",\"U_UC_ID\":null,\"U_US_ID\":null,\"U_UA_ID\":null,\"U_CL_ID\":null,\"ADR2\":null,\"U_RECIPIENT2\":null,\"STREET2\":null,\"HOUSE_ID2\":null,\"CITY2\":null,\"ZIP2\":null,\"U_UC_ID2\":null,\"U_US_ID2\":null,\"U_UA_ID2\":null,\"U_CL_ID2\":null,\"ADR3\":null,\"U_RECIPIENT3\":null,\"STREET3\":null,\"HOUSE_ID3\":null,\"CITY3\":null,\"ZIP3\":null,\"U_UC_ID3\":null,\"U_US_ID3\":null,\"U_UA_ID3\":null,\"U_CL_ID3\":null,\"FAX\":null,\"SERVICES\":\"blanditiis\",\"COMP_ID\":null,\"COMP_FID\":null,\"ACTIVATION\":\"1900-01-01 00:00:00\",\"U_ACTIVATION_LAST\":\"2026-07-01 10:22:19\",\"INFO_MAIL\":1,\"INFO_POST\":null,\"USER_NOTE\":null,\"INTERNAL_NOTE\":null,\"CT\":\"008\",\"FLAT\":null,\"NOTE1\":null,\"NOTE2\":null,\"NOTE3\":null,\"NOTE4\":null,\"NOTE5\":null,\"NOTE6\":null,\"NOTE7\":null,\"NOTE8\":null,\"SIPO_NUM\":null,\"DATE_BEGIN\":null,\"DATE_END\":null,\"SIPO_DATE_FROM\":null,\"GROUP_ID\":null,\"VAR_SYMBOL\":null,\"AGR_NAME\":null,\"PERSON_ID_NUMBER\":null,\"U_BIRTHDAY\":null,\"U_PERSONAL_NUMBER\":null,\"U_DOCUMENT_NUMBER\":null,\"ACCOUNT_PRE_NUMBER\":null,\"ACCOUNT_NUMBER\":null,\"ACCOUNT_BANK\":null,\"U_IBAN\":null,\"U_ACCOUNT_ATTACH\":null,\"U_ACCOUNT_SPECSYM\":null,\"SALESMAN\":null,\"U_BIRTH_NUMBER\":null,\"U_TECH_LOC\":null,\"U_FLAT_TYPE\":null,\"U_TECH_NAME\":null,\"U_PREMISES\":0,\"U_INV_NOTE\":null,\"U_CODENAME\":null,\"U_ACTIVE\":1,\"LOG_LEVEL\":\"INFO\",\"U_INFO_SMS\":0,\"U_PERSON_ID\":null,\"U_STATUTARY\":null,\"U_COMP_VATID\":null,\"U_DEFAULT_BP_ID\":null,\"U_EU_FIRST_LOGIN\":1,\"U_PASS_EXPIRE\":null,\"U_PASS_CHANGE\":null,\"U_REGENERATE\":null,\"U_REGENERATE_L_ID\":null,\"U_REGENERATE_PAYMENTS\":null,\"U_REGENERATE_PAYMENTS_L_ID\":null,\"U_PROV_LEVEL\":10,\"U_DEGREE_BEHIND\":null,\"U_PROVISIONING\":0,\"U_CODE_REFERENCES\":null,\"U_BATCH\":null,\"U_VALUATION\":null,\"U_PROVIDER_USER_ID\":null,\"U_PROVIDER_TYPE\":\"NONE\",\"U_PROVIDER_LABEL\":null,\"U_PROVIDER_ACTIVE\":null,\"U_INFO_MARKETING\":null,\"U_OFF_LIMIT\":null,\"U_LAST_USAGE\":null,\"U_LAST_CHANGE\":null,\"U_DEBTS_GENERATE\":0,\"U_EXTRA_WORK_DETAIL\":0,\"U_WORKS_COUNT_STRATEGY\":\"MINS\",\"U_GROUP_COMP_FID\":0,\"params\":[{\"UP_ID\":998821,\"UP_USER_ID\":2188780,\"UP_NAME\":\"param_tcvi\",\"UP_VALID_FROM\":\"2026-03-06T23:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Repudiandae laboriosam est.\",\"UP_CONTENT\":null,\"UP_CREATED\":\"2026-08-11T16:11:37.000000Z\",\"UP_L_ID\":796}],\"contact_phone_numbers\":[{\"CPN_ID\":1215932,\"CPN_SUBJ_ID\":2188780,\"CPN_VALID\":0,\"CPN_PHONE\":590549722,\"CPN_L_ID\":1012,\"CPN_LAST_UPDATE\":\"2026-05-21 17:23:58\"}],\"contact_email_addresses\":[{\"CEA_ID\":454910,\"CEA_SUBJ_ID\":2188780,\"CEA_VALID\":1,\"CEA_EMAIL\":\"modesta58@example.net\",\"CEA_L_ID\":1846,\"CEA_LAST_UPDATE\":\"2026-07-14 10:11:42\"}]}}", "name": "" } ] }, { "name": "Update Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "68", "description": "The ID of the customer." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"login\":\"john.doe\",\"password\":\"secret123\",\"pass_question\":\"architecto\",\"pass_answer\":\"architecto\",\"type\":\"S\",\"ptitle\":\"architecto\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"company\":\"Doe Corp\",\"street\":\"Main Street 1\",\"house_id\":\"12A\",\"city\":\"New York\",\"zip\":\"10001\",\"adr2\":\"AS1\",\"recipient2\":\"architecto\",\"street2\":\"architecto\",\"house_id2\":\"architecto\",\"city2\":\"architecto\",\"zip2\":\"architecto\",\"adr3\":\"AS1\",\"recipient3\":\"architecto\",\"street3\":\"architecto\",\"house_id3\":\"architecto\",\"city3\":\"architecto\",\"zip3\":\"architecto\",\"fax\":\"architecto\",\"comp_id\":\"12345678\",\"comp_fid\":\"CZ12345678\",\"personal_number\":\"architecto\",\"birthday\":\"1990-01-15\",\"info_mail\":1,\"info_post\":0,\"info_sms\":0,\"premises\":\"architecto\",\"active\":1,\"agr_name\":\"architecto\",\"varsym\":\"architecto\",\"sipo\":\"architecto\",\"account_pre_num\":\"architecto\",\"account_num\":\"architecto\",\"account_bank\":\"architecto\",\"account_specsym\":\"architecto\",\"note_user\":\"architecto\",\"note_internal\":\"architecto\",\"note_invoice\":\"architecto\",\"flat\":\"architecto\",\"flat_type\":\"architecto\",\"tech_loc\":\"architecto\",\"tech_name\":\"architecto\",\"codename\":\"architecto\",\"log_level\":\"WARNING\",\"document_number\":\"architecto\",\"statutary\":\"architecto\",\"comp_vatid\":\"SK1234567890\",\"default_bp_id\":16,\"eu_first_login\":16,\"prov_level\":16,\"degree_behind\":\"architecto\",\"account_attach\":\"architecto\",\"valuation\":\"architecto\",\"uc_id\":16,\"us_id\":16,\"ua_id\":16,\"uc_id2\":16,\"us_id2\":16,\"ua_id2\":16,\"uc_id3\":16,\"us_id3\":16,\"ua_id3\":16,\"bp_ids\":[16],\"provider_user_id\":16,\"cl_id\":16,\"cl_id2\":16,\"cl_id3\":16,\"iban\":\"architecto\",\"info_marketing\":16,\"vat_registered\":16,\"vat_registered_from\":\"2024-01-01\",\"group_comp_fid\":\"architecto\",\"consent\":[{\"flag\":1,\"pdc_id\":11,\"channel\":\"email\",\"date_consent\":\"2024-01-01\"}]}" }, "description": " This endpoint updates an existing customer.\n\n Deactivation (`active=-1`): setting `active=-1` soft-deletes the customer (see the\n `active` field). It is allowed only when the customer has no open obligations; the\n Mango procedure rejects the change with HTTP 400 while any of these exist: unfinished\n periodic services (`User.Edit.ExistServicePeriodic` \u2014 \"Existuj\u00ed neukon\u010den\u00e9 slu\u017eby \u2026\n Nelze prov\u00e9st zm\u011bnu aktivn\u00edho z\u00e1kazn\u00edka na neaktivn\u00edho.\"), unicredit services\n (`User.Edit.ExistServiceUnicredit`), unclosed variable-priced services\n (`User.Edit.VariableSrvNoClosed`), open orders (`User.Edit.ExistOrderNoDone`), offers\n (`User.Edit.ExistOfferNoClosed`), enquiries (`User.Edit.Exist.EnquiryNoClosed`),\n unsettled debts (`User.Edit.ExistDebt`), unfinished processes\n (`User.Edit.ExistMaintenance`), task reminders (`User.Edit.ExistTaskReminder`), or an\n active provider role (`User.Edit.ProviderActive`). Finish the customer's services\n first via `DELETE \/customer-services\/{id}`. Unlike hard `DELETE`, deactivation\n tolerates services that are already finished." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"USER_ID\":2188781,\"LOGIN\":\"zbailey\",\"U_PASS_QUESTION\":null,\"U_PASS_ANSWER\":\"quidem\",\"TYPE\":\"S\",\"P_TITLE\":\"Mr.\",\"FIRST_NAME\":\"Alayna\",\"LAST_NAME\":\"Leuschke\",\"COMPANY\":\"Fritsch-O'Keefe\",\"STREET\":\"Carey Greens\",\"HOUSE_ID\":\"57515\",\"CITY\":\"North Roderick\",\"ZIP\":\"06227\",\"U_UC_ID\":null,\"U_US_ID\":null,\"U_UA_ID\":null,\"U_CL_ID\":null,\"ADR2\":null,\"U_RECIPIENT2\":null,\"STREET2\":null,\"HOUSE_ID2\":null,\"CITY2\":null,\"ZIP2\":null,\"U_UC_ID2\":null,\"U_US_ID2\":null,\"U_UA_ID2\":null,\"U_CL_ID2\":null,\"ADR3\":null,\"U_RECIPIENT3\":null,\"STREET3\":null,\"HOUSE_ID3\":null,\"CITY3\":null,\"ZIP3\":null,\"U_UC_ID3\":null,\"U_US_ID3\":null,\"U_UA_ID3\":null,\"U_CL_ID3\":null,\"FAX\":null,\"SERVICES\":\"praesentium\",\"COMP_ID\":null,\"COMP_FID\":null,\"ACTIVATION\":\"1900-01-01 00:00:00\",\"U_ACTIVATION_LAST\":\"2026-06-22 17:49:53\",\"INFO_MAIL\":1,\"INFO_POST\":null,\"USER_NOTE\":null,\"INTERNAL_NOTE\":null,\"CT\":\"006\",\"FLAT\":null,\"NOTE1\":null,\"NOTE2\":null,\"NOTE3\":null,\"NOTE4\":null,\"NOTE5\":null,\"NOTE6\":null,\"NOTE7\":null,\"NOTE8\":null,\"SIPO_NUM\":null,\"DATE_BEGIN\":null,\"DATE_END\":null,\"SIPO_DATE_FROM\":null,\"GROUP_ID\":null,\"VAR_SYMBOL\":null,\"AGR_NAME\":null,\"PERSON_ID_NUMBER\":null,\"U_BIRTHDAY\":null,\"U_PERSONAL_NUMBER\":null,\"U_DOCUMENT_NUMBER\":null,\"ACCOUNT_PRE_NUMBER\":null,\"ACCOUNT_NUMBER\":null,\"ACCOUNT_BANK\":null,\"U_IBAN\":null,\"U_ACCOUNT_ATTACH\":null,\"U_ACCOUNT_SPECSYM\":null,\"SALESMAN\":null,\"U_BIRTH_NUMBER\":null,\"U_TECH_LOC\":null,\"U_FLAT_TYPE\":null,\"U_TECH_NAME\":null,\"U_PREMISES\":0,\"U_INV_NOTE\":null,\"U_CODENAME\":null,\"U_ACTIVE\":1,\"LOG_LEVEL\":\"INFO\",\"U_INFO_SMS\":0,\"U_PERSON_ID\":null,\"U_STATUTARY\":null,\"U_COMP_VATID\":null,\"U_DEFAULT_BP_ID\":null,\"U_EU_FIRST_LOGIN\":1,\"U_PASS_EXPIRE\":null,\"U_PASS_CHANGE\":null,\"U_REGENERATE\":null,\"U_REGENERATE_L_ID\":null,\"U_REGENERATE_PAYMENTS\":null,\"U_REGENERATE_PAYMENTS_L_ID\":null,\"U_PROV_LEVEL\":10,\"U_DEGREE_BEHIND\":null,\"U_PROVISIONING\":0,\"U_CODE_REFERENCES\":null,\"U_BATCH\":null,\"U_VALUATION\":null,\"U_PROVIDER_USER_ID\":null,\"U_PROVIDER_TYPE\":\"NONE\",\"U_PROVIDER_LABEL\":null,\"U_PROVIDER_ACTIVE\":null,\"U_INFO_MARKETING\":null,\"U_OFF_LIMIT\":null,\"U_LAST_USAGE\":null,\"U_LAST_CHANGE\":null,\"U_DEBTS_GENERATE\":0,\"U_EXTRA_WORK_DETAIL\":0,\"U_WORKS_COUNT_STRATEGY\":\"MINS\",\"U_GROUP_COMP_FID\":0,\"params\":[{\"UP_ID\":998822,\"UP_USER_ID\":2188781,\"UP_NAME\":\"param_lxjk\",\"UP_VALID_FROM\":\"2026-06-10T22:00:00.000000Z\",\"UP_VALID_TO\":null,\"UP_VALUE\":\"Doloremque id aut libero.\",\"UP_CONTENT\":\"Dolorem mollitia deleniti nemo. Quia officia est dignissimos neque. Odio veritatis excepturi doloribus delectus fugit qui repudiandae. Est alias tenetur ratione.\",\"UP_CREATED\":\"2026-02-21T07:29:23.000000Z\",\"UP_L_ID\":868}],\"contact_phone_numbers\":[{\"CPN_ID\":1215933,\"CPN_SUBJ_ID\":2188781,\"CPN_VALID\":1,\"CPN_PHONE\":335213199,\"CPN_L_ID\":4860,\"CPN_LAST_UPDATE\":\"2026-01-30 13:31:47\"}],\"contact_email_addresses\":[{\"CEA_ID\":454911,\"CEA_SUBJ_ID\":2188781,\"CEA_VALID\":0,\"CEA_EMAIL\":\"bernhard.kendra@example.net\",\"CEA_L_ID\":6058,\"CEA_LAST_UPDATE\":\"2026-07-14 23:11:41\"}]}}", "name": "" } ] }, { "name": "Delete Customer", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/customers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/customers\/:id", "variable": [ { "id": "id", "key": "id", "value": "68", "description": "The ID of the customer." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Hard-deletes a customer. Succeeds only for a customer with no attached records;\n the Mango procedure rejects the delete with HTTP 400 while the customer still has\n any of: active services (`User.Delete.ActiveServices` \u2014 \"Z\u00e1kazn\u00edk m\u00e1 ji\u017e zalo\u017eeny\n slu\u017eby\"), invoices (`User.Delete.Invoices`), payments (`User.Delete.Payments`),\n orders (`User.Delete.Orders`), offers (`User.Delete.Offer`), agreements\n (`User.Delete.Agreements`), maintenance tasks (`User.Delete.MaintenanceTasks`), or\n reminders (`User.Delete.Reminders`). Provider \/ CT-default-provider customers add\n further guards (`User.Delete.CTProvider`, `User.Delete.Provider.Users`\/`.Nodes`).\n Clear the customer's services first via `DELETE \/customer-services\/{id}`. To retire\n a customer while keeping its history, deactivate it instead (`PUT` with `active=-1`).\n The rejection key is returned in the `error_name` field (the `message` is localized)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Device Connection", "description": "", "item": [ { "name": "Reconnect a device uplink", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device\/connection", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device\/connection", "variable": [ { "id": "device", "key": "device", "value": "12345", "description": "The device (node) ID whose uplink is rewired." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"parent_node\":100,\"parent_interface\":200,\"interface\":201}" }, "description": "Rewire the device's uplink edge to a new parent \/ interface via the Mango procedure\n`network_node_connection_reconnect`. The old edge coordinates are read server-side, so the\nrequest carries only the new target.\n\nThe device must already have an uplink edge: a device created without a parent can only be\nconnected at creation time (`POST \/v3\/devices`) \u2014 connect-orphan is not supported here.\n\nResponses:\n- **404** \u2014 the device has no existing uplink edge (or is outside your CT scope).\n- **200** \u2014 a no-op PUT (the payload equals the current edge) returns the unchanged edge\n without calling the procedure.\n- **400** with an `error_name` on a gate failure:\n `Network.Connection.Reconnect.TopsDiff` (old or new parent outside your operator tops),\n `Network.Connection.Reconnect.Restricted` (the reconnection is not permitted \u2014 the new\n parent is the device itself or already sits under its subtree, the (parent type, device\n type) pair is not allowed, the interface types are incompatible, or the interface\n connection limit is reached; the procedure collapses all `can_connect` rejections into\n this single name)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NC_ID\":3087815,\"NC_A_N_ID\":1811149,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811150,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}", "name": "" } ] }, { "name": "Disconnect a device from its parent", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device\/connection", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device\/connection", "variable": [ { "id": "device", "key": "device", "value": "12345", "description": "The device (node) ID to disconnect." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Detach the device from its parent via the Mango procedure\n`network_node_connection_disconnect`. Removes the uplink edge and clears the device's\n`PARENT_NODE`.\n\nResponses:\n- **404** \u2014 the device has no uplink edge (or is outside your CT scope).\n- **403** `Network.ConnectionCanDisconnect.NoRights` \u2014 you lack rights to this node.\n- **400** with an `error_name` on a gate failure:\n `Network.ConnectionCanDisconnect.ExistingService` (a service is still bound to the device),\n `Network.ConnectionCanDisconnect.IsParent` (the device is itself a parent of another node)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Device Interfaces", "description": "", "item": [ { "name": "List Device Interfaces", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/interfaces", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/interfaces", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "device", "key": "device", "value": "39015", "description": "The device ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a paginated list of physical network interfaces for a specific device." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"NPI_ID\":3349380,\"NPI_N_ID\":5732,\"NPI_TYPE\":1561,\"NPI_NAME\":\"ethu\",\"NPI_L_ID\":929,\"NPI_CREATED\":\"2026-06-05 16:08:26\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"},{\"NPI_ID\":3349381,\"NPI_N_ID\":5732,\"NPI_TYPE\":1,\"NPI_NAME\":\"ethk\",\"NPI_L_ID\":610,\"NPI_CREATED\":\"2026-04-03 04:47:46\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}]}", "name": "" } ] }, { "name": "Create Device Interface", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/interfaces", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/interfaces", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "device", "key": "device", "value": "39015", "description": "The device ID" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"type\":1,\"name\":\"eth0\",\"note\":\"Uplink port\"}" }, "description": " Create a new physical network interface on a device.\n The interface type cannot be changed after creation.\n Validates uniqueness of name per device and type, and checks interface count limits." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NPI_ID\":3349382,\"NPI_N_ID\":5732,\"NPI_TYPE\":11,\"NPI_NAME\":\"ethl\",\"NPI_L_ID\":481,\"NPI_CREATED\":\"2026-03-06 21:19:54\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}}", "name": "" } ] }, { "name": "Get Device Interface", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/interfaces\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/interfaces\/:id", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the interface." }, { "id": "device", "key": "device", "value": "39015", "description": "The device ID" }, { "id": "interface", "key": "interface", "value": "18", "description": "The interface ID" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a specific physical network interface by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NPI_ID\":3349383,\"NPI_N_ID\":5732,\"NPI_TYPE\":18096,\"NPI_NAME\":\"ethv\",\"NPI_L_ID\":709,\"NPI_CREATED\":\"2026-07-07 05:54:48\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}}", "name": "" } ] }, { "name": "Update Device Interface", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/interfaces\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/interfaces\/:id", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the interface." }, { "id": "device", "key": "device", "value": "39015", "description": "The device ID" }, { "id": "interface", "key": "interface", "value": "18", "description": "The interface ID" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"eth1\",\"note\":\"Updated uplink port\"}" }, "description": " Update a physical network interface. Only name and note can be changed;\n the interface type is immutable after creation." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NPI_ID\":3349384,\"NPI_N_ID\":5732,\"NPI_TYPE\":10,\"NPI_NAME\":\"eths\",\"NPI_L_ID\":633,\"NPI_CREATED\":\"2026-03-27 21:26:55\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}}", "name": "" } ] }, { "name": "Delete Device Interface", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/interfaces\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/interfaces\/:id", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the interface." }, { "id": "device", "key": "device", "value": "39015", "description": "The device ID" }, { "id": "interface", "key": "interface", "value": "18", "description": "The interface ID" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Delete a physical network interface from a device.\n Fails if the interface has active connections or if deleting would violate\n minimum interface count requirements." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Device Param Definitions", "description": "", "item": [ { "name": "List Device Param Definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/device-param-definitions", "query": [ { "key": "per_page", "value": "10", "description": "Number of definitions to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C8%2C15", "description": "Filter by comma-separated definition IDs", "disabled": false }, { "key": "cts", "value": "12%2C101", "description": "Filter by comma-separated location (installation) IDs. Returns global definitions (NP_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.", "disabled": false }, { "key": "device_kind", "value": "MIKROTIK", "description": "Filter by device type (N_TYPE). Accepts a single device type string. Same concept as \"kind\" filter on \/devices endpoint.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/device-param-definitions?per_page=10&page=1&ids=1%2C8%2C15&cts=12%2C101&device_kind=MIKROTIK" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of device parameter definitions.\nThese define the schema (name, type, constraints, visibility) of parameters\nthat can be set on devices of a given type.\nGlobal definitions (NP_CT IS NULL) are always included alongside\nlocation-specific ones." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":4447,\"NP_NPG_ID\":null,\"PAR_NAME\":\"INCIDUNT\",\"PAR_TYPE\":\"CHAR\",\"NN_TITLE\":\"odit et\",\"N_TYPE\":\"WIFI\",\"NP_INTERFACE\":null,\"NP_CT\":128,\"INDEXED\":0,\"NP_DISTINCT\":1,\"NP_DOMAIN\":null,\"NP_NOTNULL\":0,\"NP_UNIQUE\":\"\",\"DEFAULT_VALUE\":null,\"NP_CREATE\":1,\"NP_EDITABLE\":1,\"TYPE\":\"AUTO\",\"NP_PARENT_PARAM\":null,\"NP_PARENT_N_TYPE\":null,\"NP_NOTE\":null,\"DOC_VAR_NAME\":null,\"NP_VIEW\":\"\",\"NP_UPDATE_NODE\":1,\"NP_ORDER\":null,\"NP_GROUP_NAME\":null,\"NP_DEPENDENCY\":null},{\"ID\":4448,\"NP_NPG_ID\":null,\"PAR_NAME\":\"IPSUM\",\"PAR_TYPE\":\"MAC\",\"NN_TITLE\":\"omnis autem\",\"N_TYPE\":\"ONT\",\"NP_INTERFACE\":null,\"NP_CT\":68,\"INDEXED\":0,\"NP_DISTINCT\":1,\"NP_DOMAIN\":null,\"NP_NOTNULL\":0,\"NP_UNIQUE\":\"\",\"DEFAULT_VALUE\":null,\"NP_CREATE\":1,\"NP_EDITABLE\":1,\"TYPE\":\"AUTO\",\"NP_PARENT_PARAM\":null,\"NP_PARENT_N_TYPE\":null,\"NP_NOTE\":null,\"DOC_VAR_NAME\":null,\"NP_VIEW\":\"\",\"NP_UPDATE_NODE\":1,\"NP_ORDER\":null,\"NP_GROUP_NAME\":null,\"NP_DEPENDENCY\":null}]}", "name": "" } ] } ] }, { "name": "Device Params", "description": "", "item": [ { "name": "List device params", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/params", "query": [ { "key": "order", "value": "ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: ID, PAR_NAME, NI_NPI_ID, PAR_INDEX.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "name", "value": "DNS_SERVER", "description": "Filter by exact parameter name (PAR_NAME).", "disabled": false }, { "key": "interface_id", "value": "0", "description": "Filter by network interface ID (NI_NPI_ID). 0 = device-level parameters.", "disabled": true }, { "key": "index", "value": "1", "description": "Filter by multi-value index (PAR_INDEX). 0 = single\/first value.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/params?order=ID%3Adesc&per_page=15&page=1&name=DNS_SERVER&interface_id=0&index=1", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "device", "key": "device", "value": "12345", "description": "The device ID (nodes.ID)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns the parameter value rows (node_info) for a device \u2014 device-level, interface,\nand indexed values alike. Filter by `name`, `interface_id` (0 = device-level), or `index`.\nDevice params are not time-resolved, so there is no date filter." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":307604092,\"NODE_ID\":2878,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":\"nostrum\",\"CONTENT\":null,\"TEXT_CONTENT\":null},{\"ID\":307604093,\"NODE_ID\":8015,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":\"iure\",\"CONTENT\":null,\"TEXT_CONTENT\":null}]}", "name": "" } ] }, { "name": "Add device param value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/params", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/params", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "device", "key": "device", "value": "12345", "description": "The device ID (nodes.ID)." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"DNS_SERVER\",\"value\":\"8.8.8.8\",\"interface_id\":0}" }, "description": "Create one parameter value for a device. `interface_id` selects an interface param\n(must belong to the device); omitted\/0 creates a device-level param. For INDEXED\ndefinitions the SP appends the next PAR_INDEX automatically.\n\nReturns 422 when no parameter definition matches the device type \/ interface, or the\ndefinition is not editable in this context. Writes are gated by the SP's node-rights\ncheck (403), not a controller module right." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":307604094,\"NODE_ID\":2878,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":\"nostrum\",\"CONTENT\":null,\"TEXT_CONTENT\":null}}", "name": "" } ] }, { "name": "Update device param value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/params\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/params\/:id", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the param." }, { "id": "device", "key": "device", "value": "12345", "description": "The device ID (nodes.ID)." }, { "id": "param", "key": "param", "value": "67890", "description": "The parameter row ID (node_info.ID)." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"value\":\"1.1.1.1\"}" }, "description": "Update a single parameter value in place. `{param}` is the node_info.ID; name, interface,\nand index are fixed properties of that row and cannot be changed here. The response ID is\nstable (the row is updated in place, not re-slotted).\n\nReturns 422 when the parameter's definition is not editable in this context \u2014 without this\nguard the underlying SP would return success while writing nothing." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":307604095,\"NODE_ID\":2878,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":\"nostrum\",\"CONTENT\":null,\"TEXT_CONTENT\":null}}", "name": "" } ] }, { "name": "Delete device param value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device_id\/params\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device_id\/params\/:id", "variable": [ { "id": "device_id", "key": "device_id", "value": "318", "description": "The ID of the device." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the param." }, { "id": "device", "key": "device", "value": "12345", "description": "The device ID (nodes.ID)." }, { "id": "param", "key": "param", "value": "67890", "description": "The parameter row ID (node_info.ID)." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Hard-delete a single parameter value row (node_info). `{param}` is the node_info.ID.\nReturns 400 when deleting the last remaining value of a required (NP_NOTNULL) parameter." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Device Service History", "description": "", "item": [ { "name": "List Device Service History", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/device-service-history", "query": [ { "key": "per_page", "value": "10", "description": "Number of results per page (optional).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional).", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated device service history IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "100", "description": "Filter by customer ID (NSH_U_ID).", "disabled": false }, { "key": "device", "value": "40022", "description": "Filter by device (node) ID (NSH_N_ID).", "disabled": false }, { "key": "customer_service", "value": "200", "description": "Filter by active service instance ID (NSH_SA_ID).", "disabled": false }, { "key": "from", "value": "2024-01-01", "description": "Filter events on or after this date\/datetime (NSH_TIME column).", "disabled": false }, { "key": "to", "value": "2024-12-31", "description": "Filter events on or before this date\/datetime (NSH_TIME column).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/device-service-history?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=100&device=40022&customer_service=200&from=2024-01-01&to=2024-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of device service history events.\nAt least one identifying filter (customer, device, or customer_service) is required." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"NSH_ID\":3503818,\"NSH_N_ID\":759832,\"NSH_U_ID\":null,\"NSH_SA_ID\":null,\"NSH_EVENT\":20,\"NSH_L_ID\":339,\"NSH_TIME\":\"2026-05-08 11:57:04\",\"NSH_CREATED\":\"2026-03-31 20:58:33\",\"NSH_NOTE\":null,\"NSH_NOTE_BODY\":null},{\"NSH_ID\":3503819,\"NSH_N_ID\":314167,\"NSH_U_ID\":null,\"NSH_SA_ID\":null,\"NSH_EVENT\":18,\"NSH_L_ID\":274,\"NSH_TIME\":\"2026-06-13 00:36:15\",\"NSH_CREATED\":\"2026-04-10 12:48:02\",\"NSH_NOTE\":null,\"NSH_NOTE_BODY\":null}]}", "name": "" } ] }, { "name": "Get Device Service History Event", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/device-service-history\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/device-service-history\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the device service history." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a specific device service history event by ID, including the resolved event name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NSH_ID\":3503820,\"NSH_N_ID\":759832,\"NSH_U_ID\":null,\"NSH_SA_ID\":null,\"NSH_EVENT\":20,\"NSH_L_ID\":339,\"NSH_TIME\":\"2026-05-08 11:57:04\",\"NSH_CREATED\":\"2026-03-31 20:58:33\",\"NSH_NOTE\":null,\"NSH_NOTE_BODY\":null}}", "name": "" } ] } ] }, { "name": "Devices", "description": "", "item": [ { "name": "List Devices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated device IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.", "disabled": false }, { "key": "kind", "value": "AP", "description": "Filter by device type (N_TYPE)", "disabled": false }, { "key": "parent_id", "value": "100", "description": "Filter by parent device ID (devices connected under this parent)", "disabled": false }, { "key": "child_id", "value": "200", "description": "Filter by child device ID (returns the parent device above this child)", "disabled": false }, { "key": "parent_interface_id", "value": "300", "description": "Only devices connected to this parent-side interface (NPI_ID). Lists everything plugged into a given port.", "disabled": false }, { "key": "groups", "value": "5%2C10", "description": "Filter by device group ID(s), comma-separated", "disabled": false }, { "key": "service_ids", "value": "1%2C2", "description": "Filter by service IDs (comma-separated), devices linked to these services", "disabled": false }, { "key": "user_id", "value": "100", "description": "Filter by customer ID, devices linked to this customer via nodes_services", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/devices?ids=1%2C2%2C3&cts=1%2C2%2C3&kind=AP&parent_id=100&child_id=200&parent_interface_id=300&groups=5%2C10&service_ids=1%2C2&user_id=100" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a paginated list of devices.\n Supports complex CT filtering (customer devices by N_CT, infrastructure by infra_loc param)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1811135,\"NAME\":\"DEV-uwpwlv\",\"NOTE\":\"Odit et et modi.\",\"MANAGED\":0,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":\"OLT\",\"N_TYPE\":\"CISCO\",\"N_DEVICE_TYPE\":\"switch\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"085\",\"N_CREATED\":null,\"N_L_ID\":\"000607\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"enim\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604085,\"NODE_ID\":1811135,\"NI_NPI_ID\":0,\"PAR_NAME\":\"SERVICE_STATE\",\"PAR_INDEX\":0,\"VALUE\":\"ex\",\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203615,\"NS_N_ID\":1811135,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-01-23 21:37:52\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349373,\"NPI_N_ID\":1811135,\"NPI_TYPE\":8,\"NPI_NAME\":\"ethj\",\"NPI_L_ID\":292,\"NPI_CREATED\":\"2026-06-22 17:40:17\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087808,\"NC_A_N_ID\":1811136,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811135,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}},{\"ID\":1811137,\"NAME\":\"DEV-oqitpx\",\"NOTE\":null,\"MANAGED\":1,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":\"ONU\",\"N_TYPE\":\"LINUX\",\"N_DEVICE_TYPE\":\"router\",\"N_CUSTOMER\":0,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"071\",\"N_CREATED\":null,\"N_L_ID\":\"000812\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"repudiandae\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604086,\"NODE_ID\":1811137,\"NI_NPI_ID\":0,\"PAR_NAME\":\"VIRTUAL_IP\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203616,\"NS_N_ID\":1811137,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-08-11 18:01:41\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349374,\"NPI_N_ID\":1811137,\"NPI_TYPE\":4111,\"NPI_NAME\":\"ethg\",\"NPI_L_ID\":425,\"NPI_CREATED\":\"2026-06-21 07:41:56\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087809,\"NC_A_N_ID\":1811138,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811137,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}]}", "name": "" } ] }, { "name": "Create Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"customer\":1,\"type\":\"AP\",\"device_type\":\"MikroTik RB750\",\"name\":\"AP Roof\",\"interface\":\"eth0\",\"parent_node\":100,\"parent_interface\":16,\"premise_id\":16,\"serial_num\":\"SN123456\",\"ct\":5,\"user_id\":16,\"services\":[16],\"street\":\"Main Street\",\"house_id\":\"12A\",\"zip\":\"56001\",\"city\":\"Prague\",\"socket\":\"architecto\",\"note\":\"architecto\",\"gps_latitude\":49.8175,\"gps_longitude\":15.473,\"params\":[[]],\"ucp_id\":16,\"us_id\":16,\"ua_id\":16}" }, "description": " Create a new device." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1811139,\"NAME\":\"DEV-ngzmiy\",\"NOTE\":\"Nihil accusantium harum mollitia modi deserunt.\",\"MANAGED\":0,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":\"OLT\",\"N_TYPE\":\"CISCO\",\"N_DEVICE_TYPE\":\"router\",\"N_CUSTOMER\":0,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"007\",\"N_CREATED\":null,\"N_L_ID\":\"000592\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"adipisci\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604087,\"NODE_ID\":1811139,\"NI_NPI_ID\":0,\"PAR_NAME\":\"SERVICE_STATE\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203617,\"NS_N_ID\":1811139,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-03-29 10:29:25\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349375,\"NPI_N_ID\":1811139,\"NPI_TYPE\":18096,\"NPI_NAME\":\"ethq\",\"NPI_L_ID\":274,\"NPI_CREATED\":\"2026-06-13 00:42:27\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087810,\"NC_A_N_ID\":1811140,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811139,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}}", "name": "" } ] }, { "name": "Get Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "318", "description": "The ID of the device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve a specific device by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1811141,\"NAME\":\"DEV-qwrsit\",\"NOTE\":null,\"MANAGED\":1,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":\"SWITCH\",\"N_TYPE\":\"CISCO\",\"N_DEVICE_TYPE\":\"switch\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"085\",\"N_CREATED\":null,\"N_L_ID\":\"000185\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"non\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604088,\"NODE_ID\":1811141,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":\"voluptatem\",\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203618,\"NS_N_ID\":1811141,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-03-30 10:09:36\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349376,\"NPI_N_ID\":1811141,\"NPI_TYPE\":11,\"NPI_NAME\":\"ethw\",\"NPI_L_ID\":258,\"NPI_CREATED\":\"2026-05-20 01:13:43\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087811,\"NC_A_N_ID\":1811142,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811141,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}}", "name": "" } ] }, { "name": "Update Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "318", "description": "The ID of the device." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"customer\":1,\"device_type\":\"MikroTik RB750\",\"name\":\"AP Roof\",\"premise_id\":16,\"serial_num\":\"SN123456\",\"ct\":5,\"user_id\":16,\"services\":[16],\"street\":\"Main Street\",\"house_id\":\"12A\",\"zip\":\"56001\",\"city\":\"Prague\",\"socket\":\"architecto\",\"note\":\"architecto\",\"gps_latitude\":\"49.8175\",\"gps_longitude\":\"15.473\",\"params\":[[]],\"ucp_id\":16,\"us_id\":16,\"ua_id\":16}" }, "description": " Update an existing device. Every omitted field keeps its current value \u2014 plain\n columns, `device_type`, and the binding fields alike (the underlying Mango\n procedure is a true partial update).\n\n Send `user_id` + `services` together to reconcile the device's service bindings\n to that list: `services: []` detaches all of that user's services, `user_id: 0`\n detaches every binding. `premise_id: null` unlinks the premise; omitting it\n preserves the link. A write to a device outside your network scope is rejected\n with a permission error." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1811143,\"NAME\":\"DEV-vdljni\",\"NOTE\":null,\"MANAGED\":1,\"MANAG_IP\":\"41.168.31.124\",\"PARENT_NODE\":null,\"F_TYPE\":\"AP\",\"N_TYPE\":\"CISCO\",\"N_DEVICE_TYPE\":\"router\",\"N_CUSTOMER\":0,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"007\",\"N_CREATED\":null,\"N_L_ID\":\"000751\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"quidem\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604089,\"NODE_ID\":1811143,\"NI_NPI_ID\":0,\"PAR_NAME\":\"DATA_COUNTER\",\"PAR_INDEX\":0,\"VALUE\":\"incidunt\",\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203619,\"NS_N_ID\":1811143,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-07-07 05:54:48\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349377,\"NPI_N_ID\":1811143,\"NPI_TYPE\":2517,\"NPI_NAME\":\"ethr\",\"NPI_L_ID\":765,\"NPI_CREATED\":\"2026-07-01 20:01:50\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087812,\"NC_A_N_ID\":1811144,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811143,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}}", "name": "" } ] }, { "name": "Delete Device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:id", "variable": [ { "id": "id", "key": "id", "value": "318", "description": "The ID of the device." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Delete a device (soft-delete)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List Device Children", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device\/children", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated device IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.", "disabled": false }, { "key": "kind", "value": "AP", "description": "Filter by device type (N_TYPE)", "disabled": false }, { "key": "parent_id", "value": "100", "description": "Filter by parent device ID (devices connected under this parent)", "disabled": false }, { "key": "child_id", "value": "200", "description": "Filter by child device ID (returns the parent device above this child)", "disabled": false }, { "key": "parent_interface_id", "value": "300", "description": "Only devices connected to this parent-side interface (NPI_ID). Lists everything plugged into a given port.", "disabled": false }, { "key": "groups", "value": "5%2C10", "description": "Filter by device group ID(s), comma-separated", "disabled": false }, { "key": "service_ids", "value": "1%2C2", "description": "Filter by service IDs (comma-separated), devices linked to these services", "disabled": false }, { "key": "user_id", "value": "100", "description": "Filter by customer ID, devices linked to this customer via nodes_services", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device\/children?ids=1%2C2%2C3&cts=1%2C2%2C3&kind=AP&parent_id=100&child_id=200&parent_interface_id=300&groups=5%2C10&service_ids=1%2C2&user_id=100", "variable": [ { "id": "device", "key": "device", "value": "318", "description": "The device." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Retrieve child devices of the specified device.\n Returns the same structure as the main device list endpoint." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1811145,\"NAME\":\"DEV-cpscql\",\"NOTE\":null,\"MANAGED\":1,\"MANAG_IP\":\"20.76.47.75\",\"PARENT_NODE\":null,\"F_TYPE\":\"ONU\",\"N_TYPE\":\"UBNT\",\"N_DEVICE_TYPE\":\"ap\",\"N_CUSTOMER\":1,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"076\",\"N_CREATED\":null,\"N_L_ID\":\"000258\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"adipisci\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604090,\"NODE_ID\":1811145,\"NI_NPI_ID\":0,\"PAR_NAME\":\"infra_loc\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203620,\"NS_N_ID\":1811145,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-06-11 00:47:11\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349378,\"NPI_N_ID\":1811145,\"NPI_TYPE\":16545,\"NPI_NAME\":\"ethp\",\"NPI_L_ID\":535,\"NPI_CREATED\":\"2026-06-18 20:46:04\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087813,\"NC_A_N_ID\":1811146,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811145,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}},{\"ID\":1811147,\"NAME\":\"DEV-usgiog\",\"NOTE\":null,\"MANAGED\":1,\"MANAG_IP\":null,\"PARENT_NODE\":null,\"F_TYPE\":\"AP\",\"N_TYPE\":\"MIKROTIK\",\"N_DEVICE_TYPE\":\"switch\",\"N_CUSTOMER\":0,\"USER_SERVICE_ID\":0,\"CUSTOMER_PARENT\":0,\"CUSTOMER_TYPE\":null,\"CUSTOMER_LOCATION\":0,\"MAC\":null,\"UPDATE_FLAG\":0,\"AGR_GROUP\":null,\"STREET\":null,\"HOUSE_ID\":null,\"N_ZIP\":null,\"N_CITY\":null,\"SOCKET\":null,\"N_COUNTER_ID\":\"000000\",\"N_PRODUCER\":null,\"N_SERIAL_NUM\":null,\"N_LAST_RESPONSE\":null,\"N_CT\":\"051\",\"N_CREATED\":null,\"N_L_ID\":\"000640\",\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"tenetur\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":307604091,\"NODE_ID\":1811147,\"NI_NPI_ID\":0,\"PAR_NAME\":\"SERVICE_STATE\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2203621,\"NS_N_ID\":1811147,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-06-25 09:53:03\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}],\"interfaces\":[{\"NPI_ID\":3349379,\"NPI_N_ID\":1811147,\"NPI_TYPE\":1,\"NPI_NAME\":\"ethb\",\"NPI_L_ID\":461,\"NPI_CREATED\":\"2026-02-21 08:17:58\",\"NPI_CHANGED\":null,\"NPI_NOTE\":\"\"}],\"connection\":{\"NC_ID\":3087814,\"NC_A_N_ID\":1811148,\"NC_A_NPI_ID\":null,\"NC_B_N_ID\":1811147,\"NC_B_NPI_ID\":null,\"NC_TYPE_ID\":null}}]}", "name": "" } ] }, { "name": "Attach customer service to device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device\/services\/:customerService", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device\/services\/:customerService", "variable": [ { "id": "device", "key": "device", "value": "12345", "description": "The device (node) ID." }, { "id": "customerService", "key": "customerService", "value": "67890", "description": "The customer service (services_active) ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Bind a customer service to a device (a `nodes_services` row). Idempotent upsert keyed\non the (device, service) pair \u2014 re-PUT of an existing binding is a no-op returning the\nsame `NS_ID`. No request body: the owning customer is derived from the service and the\nbinding time defaults to now.\n\nSide effects handled by the Mango procedure `network_node_service_set`:\n- On node types limited to a single base service, attaching a base service\n auto-disconnects the conflicting base service(s) already bound to the device.\n- A service with `DATE_START` in the future gets `NS_NEEDS_UPDATE=1` (the device\n configuration update is deferred to the activation day).\n- History: writes an `NSH_ADD` event; a same-day pending detach is flipped to\n `NSH_DELETE_CANCELED` instead, so a same-day detach+attach cancels out.\n\nThere is no read endpoint on this path \u2014 read bindings via the device detail\n(`customer_service_devices`), `GET \/v3\/customer-services?device={id}`, or\n`GET \/v3\/device-service-history`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NS_ID\":2203622,\"NS_N_ID\":5732,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-03-19 23:54:06\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}}", "name": "" } ] }, { "name": "Detach customer service from device", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/devices\/:device\/services\/:customerService", "query": [], "raw": "{{baseUrl}}\/api\/v3\/devices\/:device\/services\/:customerService", "variable": [ { "id": "device", "key": "device", "value": "12345", "description": "The device (node) ID." }, { "id": "customerService", "key": "customerService", "value": "67890", "description": "The customer service (services_active) ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Remove a device\u2194service binding. 404 when the binding does not exist.\n\nSide effects handled by the Mango procedure `network_node_service_delete`:\n- Dependent services (linked via `dependency`\/`dependency_free`) are detached from\n the device first (cascade).\n- History: writes an `NSH_DELETE` event; a same-day attach is flipped to\n `NSH_ADD_CANCELED` instead, so a same-day attach+detach cancels out.\n\nThere is no read endpoint on this path \u2014 read bindings via the device detail\n(`customer_service_devices`), `GET \/v3\/customer-services?device={id}`, or\n`GET \/v3\/device-service-history`." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Discount Definitions", "description": "", "item": [ { "name": "List Discount Definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/discount-definitions", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated discount definition IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "active_only", "value": "1", "description": "When true, return only definitions whose validity has not expired (SD_VALID_TO is null or >= today).", "disabled": false }, { "key": "type", "value": "percentage", "description": "Filter by discount type.", "disabled": false }, { "key": "service_class", "value": "1", "description": "Filter by service class ID (checks M:N pivot table).", "disabled": false }, { "key": "service", "value": "10", "description": "Filter by service name ID (checks M:N pivot table).", "disabled": false }, { "key": "service_group", "value": "5", "description": "Filter by service group definition ID (SD_SGD_ID).", "disabled": false }, { "key": "area", "value": "3", "description": "Filter by address group \/ area ID (SD_GA_ID).", "disabled": false }, { "key": "applies_to_groups", "value": "", "description": "Filter by campaign mode. true = group campaigns only, false = standard campaigns only.", "disabled": true }, { "key": "search", "value": "internet", "description": "Search in discount name and note (partial match).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/discount-definitions?per_page=15&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&active_only=1&type=percentage&service_class=1&service=10&service_group=5&area=3&applies_to_groups=&search=internet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of discount campaign definitions.\n Filterable by type, service class, service, area, active status, and more." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SD_ID\":1764,\"SD_NAME\":\"aut adipisci quidem\",\"SD_GROUPS\":\"none\",\"SD_TYPE\":\"info\",\"SD_SC_ID\":null,\"SD_SN_ID\":null,\"SD_SNB_ID\":null,\"SD_SND_IDS\":null,\"SD_SGD_ID\":null,\"SD_GA_ID\":null,\"SD_VALUE\":\"42.5404\",\"SD_VARIABILITY\":\"none\",\"SD_CONDITION\":null,\"SD_CONDITION_PERIOD\":null,\"SD_TIME_LIMITED\":null,\"SD_TRADING_LIMIT\":null,\"SD_VALID_TO\":null,\"SD_GROUP\":null,\"SD_NOTE\":null,\"SD_CREATED\":\"2026-03-29 10:20:31\",\"SD_L_ID\":709,\"SD_CT\":3,\"SD_START_DELAY\":null,\"SD_CONDITION_END\":\"pay_duly\",\"SD_END_PENALTY\":null,\"SD_CASH\":null,\"SD_INVOICE\":null,\"SD_PROFORMA\":null,\"SD_START_RECREATE\":1,\"SD_BULK_TRANSFER\":0,\"SD_END_NOTIFY\":null,\"SD_FORCED\":null,\"SD_FLOATING\":null,\"available_for_classes\":[15],\"available_for_services\":[28]},{\"SD_ID\":1765,\"SD_NAME\":\"ipsum nostrum omnis\",\"SD_GROUPS\":\"none\",\"SD_TYPE\":\"definite\",\"SD_SC_ID\":null,\"SD_SN_ID\":null,\"SD_SNB_ID\":null,\"SD_SND_IDS\":null,\"SD_SGD_ID\":null,\"SD_GA_ID\":null,\"SD_VALUE\":\"76.5282\",\"SD_VARIABILITY\":\"none\",\"SD_CONDITION\":null,\"SD_CONDITION_PERIOD\":null,\"SD_TIME_LIMITED\":null,\"SD_TRADING_LIMIT\":null,\"SD_VALID_TO\":null,\"SD_GROUP\":null,\"SD_NOTE\":null,\"SD_CREATED\":\"2026-06-20 13:34:43\",\"SD_L_ID\":94,\"SD_CT\":6,\"SD_START_DELAY\":null,\"SD_CONDITION_END\":\"pay_duly\",\"SD_END_PENALTY\":null,\"SD_CASH\":null,\"SD_INVOICE\":null,\"SD_PROFORMA\":null,\"SD_START_RECREATE\":1,\"SD_BULK_TRANSFER\":0,\"SD_END_NOTIFY\":null,\"SD_FORCED\":null,\"SD_FLOATING\":null,\"available_for_classes\":[2],\"available_for_services\":[25]}]}", "name": "" } ] }, { "name": "Get Discount Definition", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/discount-definitions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/discount-definitions\/:id", "variable": [ { "id": "id", "key": "id", "value": "48", "description": "The ID of the discount definition." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single discount campaign definition by ID.\n Includes applied_to_services \u2014 active service IDs where this discount is currently assigned." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SD_ID\":1766,\"SD_NAME\":\"aut adipisci quidem\",\"SD_GROUPS\":\"none\",\"SD_TYPE\":\"info\",\"SD_SC_ID\":null,\"SD_SN_ID\":null,\"SD_SNB_ID\":null,\"SD_SND_IDS\":null,\"SD_SGD_ID\":null,\"SD_GA_ID\":null,\"SD_VALUE\":\"42.5404\",\"SD_VARIABILITY\":\"none\",\"SD_CONDITION\":null,\"SD_CONDITION_PERIOD\":null,\"SD_TIME_LIMITED\":null,\"SD_TRADING_LIMIT\":null,\"SD_VALID_TO\":null,\"SD_GROUP\":null,\"SD_NOTE\":null,\"SD_CREATED\":\"2026-03-29 10:20:31\",\"SD_L_ID\":709,\"SD_CT\":3,\"SD_START_DELAY\":null,\"SD_CONDITION_END\":\"pay_duly\",\"SD_END_PENALTY\":null,\"SD_CASH\":null,\"SD_INVOICE\":null,\"SD_PROFORMA\":null,\"SD_START_RECREATE\":1,\"SD_BULK_TRANSFER\":0,\"SD_END_NOTIFY\":null,\"SD_FORCED\":null,\"SD_FLOATING\":null,\"available_for_classes\":[15],\"available_for_services\":[28],\"applied_to_services\":[6877]}}", "name": "" } ] } ] }, { "name": "Esbe", "description": "", "item": [ { "name": "Orders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders", "query": [ { "key": "user_id", "value": "16", "description": "ID of the user placing the order", "disabled": false }, { "key": "transport_service_id", "value": "16", "description": "ID of the transport service", "disabled": false }, { "key": "billing_plan_id", "value": "16", "description": "ID of the billing plan", "disabled": false }, { "key": "transport_premise_id", "value": "16", "description": "ID of the transport premise", "disabled": false }, { "key": "order_date", "value": "architecto", "description": "Date of the order", "disabled": false }, { "key": "note", "value": "architecto", "description": "Optional note for the order", "disabled": false }, { "key": "delivery_date", "value": "architecto", "description": "Date of the delivery", "disabled": false } ], "raw": "{{baseUrl}}\/api\/esbe\/orders?user_id=16&transport_service_id=16&billing_plan_id=16&transport_premise_id=16&order_date=architecto¬e=architecto&delivery_date=architecto" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint create an empty order.\n The next step is to add products to the order." }, "response": [ { "header": [], "code": 200, "body": "{\"order_id\":\"int Example: 12345\"}", "name": "" } ] }, { "name": "Add Single Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/item", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/item", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":41994,\"product_id\":101,\"quantity\":2,\"price\":150.5,\"price_wo_vat\":124.38,\"parent_product_id\":9876}" }, "description": " This endpoint adds a single item to an existing order." }, "response": [ { "header": [], "code": 200, "body": "{\"order_item_id\":\"int Example: 67890\",\"personalized_product_id\":\"int Example: 54321\"}", "name": "" } ] }, { "name": "Update Single Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/item", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/item", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":41994,\"product_id\":101,\"quantity\":2,\"price\":150.5,\"price_wo_vat\":124.38}" }, "description": " This endpoint update a single item in an existing order." }, "response": [ { "header": [], "code": 200, "body": "{\"personalized_product_id\":\"int Example: 54321\"}", "name": "" } ] }, { "name": "Finalize Order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/realize", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/realize", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"delivery_date\":\"2025-09-10 00:00:00\",\"recipient_person\":\"architecto\",\"recipient_phone\":\"architecto\",\"reference_number\":\"architecto\",\"recipient_city\":\"architecto\",\"recipient_zip\":\"architecto\",\"recipient_street\":\"architecto\",\"recipient_house_id\":\"architecto\",\"transport_premise_id\":16,\"transport_service_id\":16,\"billing_plan_id\":16,\"note\":\"architecto\"}" }, "description": " This endpoint finalizes or \"realizes\" an order that has all its items.\n This is the final step to make an order active." }, "response": [ { "header": [], "code": 200, "body": "{\"message\":\"Order finalized successfully.\"}", "name": "" } ] }, { "name": "Generate Order Number", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/generate-number", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/generate-number", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint generates a unique order number for an existing order.\n If the order already has a number, it returns the existing one." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":\"boolean Example: true\",\"order_number\":\"int Example: 202409240001\",\"updated\":\"boolean Example: true\"}", "name": "" } ] }, { "name": "Update Order User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/user", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/user", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":12345}" }, "description": " This endpoint updates the user assigned to an order and all its items.\n It also updates associated personalized products and service data." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":\"boolean Example: true\",\"user_id\":\"int Example: 12345\"}", "name": "" } ] }, { "name": "Delete Order", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint deletes an order. This should be used for cleanup if the ordering process fails." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Remove Single Item", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/orders\/:order\/item", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/orders\/:order\/item", "variable": [ { "id": "order", "key": "order", "value": "architecto", "description": "The order." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"product_id\":12345}" }, "description": " This endpoint removes a single item from an existing order." }, "response": [ { "header": [], "code": 200, "body": "{\"success\":\"boolean Example: true\"}", "name": "" } ] }, { "name": "Send Email Using Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/esbe\/send-email-using-template", "query": [], "raw": "{{baseUrl}}\/api\/esbe\/send-email-using-template" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"from\":\"sender@example.com\",\"to\":\"recipient@example.com\",\"ctype\":\"architecto\",\"sched\":\"architecto\",\"ct\":\"architecto\",\"tt_name\":\"order_confirmation\",\"params\":\"architecto\",\"parsep\":\"architecto\",\"valsep\":\"architecto\"}" }, "description": " This endpoint sends an email using a predefined template.\n It processes the template with provided parameters and sends the email to the specified recipient." }, "response": [ { "header": [], "code": 200, "body": "{\"result\":\"string Example: success\",\"eo_ids\":\"string Example: 123,456\"}", "name": "" } ] } ] }, { "name": "Internal Tax Documents", "description": "", "item": [ { "name": "List Internal Tax Documents", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/internal-tax-documents", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "100%2C200%2C300", "description": "Filter by comma-separated document IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "345", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "type", "value": "SERVICE%2CCREDIT_NOTE", "description": "Filter by document type. Accepts comma-separated values.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter documents issued on or after this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter documents issued on or before this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).", "disabled": false }, { "key": "service", "value": "19", "description": "Filter by service definition ID (ITD_SN_ID \u2192 services_name).", "disabled": false }, { "key": "service_class", "value": "1", "description": "Filter by service class ID (requires JOIN to services_name \u2192 services_class).", "disabled": false }, { "key": "billing_plan", "value": "5", "description": "Filter by billing plan ID (via ITD_SAB_ID \u2192 services_active_billing.SAB_BP_ID).", "disabled": false }, { "key": "search", "value": "100000", "description": "Search by document number (ID).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/internal-tax-documents?per_page=10&page=1&ids=100%2C200%2C300&cts=1%2C2%2C3&customer=345&type=SERVICE%2CCREDIT_NOTE&date_from=2024-01-01&date_to=2024-12-31&service=19&service_class=1&billing_plan=5&search=100000" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of internal tax documents (billing prescriptions).\n **At least one** of the following filters must be provided:\n `customer`, `type`, `date_from`, `service`, `search`.\n Without a narrowing filter the endpoint returns HTTP 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":0,\"ITD_ADVANCE_ID\":110,\"ITD_TYPE\":\"NON_ATTACH\",\"USER_ID\":4524,\"SRV_ID\":2617,\"Y\":2025,\"MON\":4,\"ITD_DAY\":null,\"ITD_Y_END\":2023,\"MON_END\":null,\"ITD_DAY_END\":null,\"PERIOD\":\"month\",\"PER\":0,\"TAX_DATE\":null,\"ITD_MATURITY\":null,\"PRICE\":null,\"ITD_PRICE_VAT\":null,\"ITD_PRICE_WO_VAT\":null,\"ITD_PRICE_ROUND\":null,\"ITD_FIX_PRICE\":null,\"ITD_FIX_PRICE_VAT\":null,\"ITD_FIX_PRICE_WO_VAT\":null,\"ITD_VAR_PRICE\":null,\"ITD_VAR_PRICE_VAT\":null,\"ITD_VAR_PRICE_WO_VAT\":null,\"ITD_TL_VALUE_PERCENT\":null,\"ITD_SAB_ID\":null,\"CT\":76,\"ITD_TAX_PRICE\":null,\"ITD_TAX_PRICE_VAT\":null,\"ITD_TAX_PRICE_WO_VAT\":null,\"ITD_TAX_PRICE_ROUND\":null,\"ITD_PRICE_PRIM\":null,\"ITD_PRICE_PRIM_VAT\":null,\"ITD_PRICE_PRIM_WO_VAT\":null,\"ITD_SN_ID\":12,\"ITD_VAR_SYMBOL\":null,\"ITD_INVOICING\":null,\"ITD_VAS\":null,\"ITD_REVERSE_CHARGE\":null,\"detail\":null,\"payment\":null,\"note\":null},{\"ID\":0,\"ITD_ADVANCE_ID\":41,\"ITD_TYPE\":\"NON_ATTACH\",\"USER_ID\":1769,\"SRV_ID\":967,\"Y\":2023,\"MON\":7,\"ITD_DAY\":null,\"ITD_Y_END\":2022,\"MON_END\":null,\"ITD_DAY_END\":null,\"PERIOD\":\"month\",\"PER\":0,\"TAX_DATE\":null,\"ITD_MATURITY\":null,\"PRICE\":null,\"ITD_PRICE_VAT\":null,\"ITD_PRICE_WO_VAT\":null,\"ITD_PRICE_ROUND\":null,\"ITD_FIX_PRICE\":null,\"ITD_FIX_PRICE_VAT\":null,\"ITD_FIX_PRICE_WO_VAT\":null,\"ITD_VAR_PRICE\":null,\"ITD_VAR_PRICE_VAT\":null,\"ITD_VAR_PRICE_WO_VAT\":null,\"ITD_TL_VALUE_PERCENT\":null,\"ITD_SAB_ID\":null,\"CT\":38,\"ITD_TAX_PRICE\":null,\"ITD_TAX_PRICE_VAT\":null,\"ITD_TAX_PRICE_WO_VAT\":null,\"ITD_TAX_PRICE_ROUND\":null,\"ITD_PRICE_PRIM\":null,\"ITD_PRICE_PRIM_VAT\":null,\"ITD_PRICE_PRIM_WO_VAT\":null,\"ITD_SN_ID\":383,\"ITD_VAR_SYMBOL\":null,\"ITD_INVOICING\":null,\"ITD_VAS\":null,\"ITD_REVERSE_CHARGE\":null,\"detail\":null,\"payment\":null,\"note\":null}]}", "name": "" } ] }, { "name": "Get Internal Tax Document", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/internal-tax-documents\/:id", "query": [ { "key": "advance_id", "value": "0", "description": "Advance ID within the document. Defaults to 0 (base document).", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v3\/internal-tax-documents\/:id?advance_id=0", "variable": [ { "id": "id", "key": "id", "value": "1000000010510504", "description": "The ID of the internal tax document." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single internal tax document by ID.\n Use `advance_id` query parameter to specify which advance record to return (defaults to 0 \u2014 the base document)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":0,\"ITD_ADVANCE_ID\":10,\"ITD_TYPE\":\"NON_ATTACH\",\"USER_ID\":2617,\"SRV_ID\":8015,\"Y\":2026,\"MON\":7,\"ITD_DAY\":null,\"ITD_Y_END\":2021,\"MON_END\":null,\"ITD_DAY_END\":null,\"PERIOD\":\"month\",\"PER\":0,\"TAX_DATE\":null,\"ITD_MATURITY\":null,\"PRICE\":null,\"ITD_PRICE_VAT\":null,\"ITD_PRICE_WO_VAT\":null,\"ITD_PRICE_ROUND\":null,\"ITD_FIX_PRICE\":null,\"ITD_FIX_PRICE_VAT\":null,\"ITD_FIX_PRICE_WO_VAT\":null,\"ITD_VAR_PRICE\":null,\"ITD_VAR_PRICE_VAT\":null,\"ITD_VAR_PRICE_WO_VAT\":null,\"ITD_TL_VALUE_PERCENT\":null,\"ITD_SAB_ID\":null,\"CT\":39,\"ITD_TAX_PRICE\":null,\"ITD_TAX_PRICE_VAT\":null,\"ITD_TAX_PRICE_WO_VAT\":null,\"ITD_TAX_PRICE_ROUND\":null,\"ITD_PRICE_PRIM\":null,\"ITD_PRICE_PRIM_VAT\":null,\"ITD_PRICE_PRIM_WO_VAT\":null,\"ITD_SN_ID\":765,\"ITD_VAR_SYMBOL\":null,\"ITD_INVOICING\":null,\"ITD_VAS\":null,\"ITD_REVERSE_CHARGE\":null,\"detail\":null,\"payment\":null,\"note\":null}}", "name": "" } ] } ] }, { "name": "Invoices", "description": "", "item": [ { "name": "List Invoices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/invoices", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "100%2C200%2C300", "description": "Filter by comma-separated invoice IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "345", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "type", "value": "INVOICE%2CADVANCE", "description": "Filter by invoice type. Accepts comma-separated values.", "disabled": false }, { "key": "year", "value": "2024", "description": "Filter by year of issue date (DATE_V).", "disabled": false }, { "key": "status", "value": "A", "description": "Filter by status flag. A = active, S = cancelled, all = both. Default: only active (A).", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter invoices issued on or after this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter invoices issued on or before this date (YYYY-MM-DD).", "disabled": false }, { "key": "search", "value": "102", "description": "Search by invoice record number (NUMBER_RECORD) or variable symbol (VAR_SYM).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/invoices?per_page=10&page=1&ids=100%2C200%2C300&cts=1%2C2%2C3&customer=345&type=INVOICE%2CADVANCE&year=2024&status=A&date_from=2024-01-01&date_to=2024-12-31&search=102" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of invoices.\n **At least one** of the following filters must be provided:\n `customer`, `year`, `type`, `date_from`, `search`.\n Without a narrowing filter the endpoint returns HTTP 422.\n By default, only active invoices (IH_STAT_FLAG = 'A') are returned.\n Use `status=S` for cancelled, or `status=all` for both." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":33969129,\"USER_ID\":2878,\"NUMBER_RECORD\":\"26824\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"2006-05-29\",\"DATE_U\":null,\"DATE_V\":\"2015-01-19\",\"TERM\":\"\",\"CON_SYM\":\"\",\"VAR_SYM\":2031881,\"NUMBER_DLIST\":1,\"CT\":40,\"NUM\":709,\"IH_DOC_ID\":8862,\"IH_AUTHOR\":12,\"IH_CREATED\":null,\"NOTE\":null,\"IH_STAT_FLAG\":\"A\",\"IH_TYPE\":\"CREDIT_NOTE\",\"IH_TAX\":false,\"IH_TICKET\":null,\"IH_PL_ID\":null,\"IH_DATE_CONFIRM\":null,\"IH_CANCELLED\":null,\"IH_CANCEL_L_ID\":null,\"IH_CANCEL_NOTE\":null,\"IH_PROVIDER_USER_ID\":null,\"IH_PA_ID\":null,\"IH_NO_AUTO_DISPATCH\":null,\"IH_HIDE_PRICE_DETAIL\":null,\"items\":[{\"ID\":38979897,\"ID_INVOICE\":33969129,\"NOTE\":\"Ipsum nostrum omnis autem et consequatur aut dolores enim.\",\"COUNT\":null,\"AMOUNT\":\"7786.7381\",\"IB_ITD_PRICE_VAT\":null,\"IB_ITD_PRICE_WO_VAT\":null,\"IB_ITD_PRICE_ROUND\":null,\"MONTH\":\"08\",\"YEAR\":\"2024\",\"USER_SERVICE_ID\":5468,\"IB_PER\":3,\"IB_NOTE2\":null,\"IB_ATTACHMENT\":null,\"IB_ITD_ID\":null,\"IB_ITD_ADVANCE_ID\":0,\"IB_PRICE_TYPE\":\"ALL\",\"IB_DISCOUNT\":0,\"IB_SAD_ID\":null,\"IB_ACCOUNT_ADVANCE\":0,\"IB_REVERSE_CHARGE\":null,\"IB_SA_ID\":null,\"IB_SA_BASE_ID\":null,\"IB_TL_VALUE_PERCENT\":null,\"IB_NO_PAY\":null}]},{\"ID\":33969130,\"USER_ID\":1462,\"NUMBER_RECORD\":\"48309\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"1975-01-02\",\"DATE_U\":null,\"DATE_V\":\"2024-01-23\",\"TERM\":\"\",\"CON_SYM\":\"\",\"VAR_SYM\":8327339,\"NUMBER_DLIST\":1,\"CT\":51,\"NUM\":177,\"IH_DOC_ID\":782,\"IH_AUTHOR\":614,\"IH_CREATED\":null,\"NOTE\":null,\"IH_STAT_FLAG\":\"A\",\"IH_TYPE\":\"CREDIT_NOTE_ADVANCE\",\"IH_TAX\":false,\"IH_TICKET\":null,\"IH_PL_ID\":null,\"IH_DATE_CONFIRM\":null,\"IH_CANCELLED\":null,\"IH_CANCEL_L_ID\":null,\"IH_CANCEL_NOTE\":null,\"IH_PROVIDER_USER_ID\":null,\"IH_PA_ID\":null,\"IH_NO_AUTO_DISPATCH\":null,\"IH_HIDE_PRICE_DETAIL\":null,\"items\":[{\"ID\":38979898,\"ID_INVOICE\":33969130,\"NOTE\":\"Aliquam veniam corporis dolorem mollitia deleniti nemo.\",\"COUNT\":null,\"AMOUNT\":\"4091.1341\",\"IB_ITD_PRICE_VAT\":null,\"IB_ITD_PRICE_WO_VAT\":null,\"IB_ITD_PRICE_ROUND\":null,\"MONTH\":\"05\",\"YEAR\":\"2020\",\"USER_SERVICE_ID\":7643,\"IB_PER\":6,\"IB_NOTE2\":null,\"IB_ATTACHMENT\":null,\"IB_ITD_ID\":null,\"IB_ITD_ADVANCE_ID\":0,\"IB_PRICE_TYPE\":\"FIX\",\"IB_DISCOUNT\":0,\"IB_SAD_ID\":null,\"IB_ACCOUNT_ADVANCE\":0,\"IB_REVERSE_CHARGE\":null,\"IB_SA_ID\":null,\"IB_SA_BASE_ID\":null,\"IB_TL_VALUE_PERCENT\":null,\"IB_NO_PAY\":null}]}]}", "name": "" } ] }, { "name": "Get Invoice", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/invoices\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/invoices\/:id", "variable": [ { "id": "id", "key": "id", "value": "5352", "description": "The ID of the invoice." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single invoice by ID, including line items." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":33969131,\"USER_ID\":2878,\"NUMBER_RECORD\":\"89349\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"2015-01-19\",\"DATE_U\":null,\"DATE_V\":\"2010-05-22\",\"TERM\":\"\",\"CON_SYM\":\"\",\"VAR_SYM\":1310719,\"NUMBER_DLIST\":1,\"CT\":79,\"NUM\":274,\"IH_DOC_ID\":9279,\"IH_AUTHOR\":765,\"IH_CREATED\":null,\"NOTE\":null,\"IH_STAT_FLAG\":\"A\",\"IH_TYPE\":\"INVOICE\",\"IH_TAX\":false,\"IH_TICKET\":null,\"IH_PL_ID\":null,\"IH_DATE_CONFIRM\":null,\"IH_CANCELLED\":null,\"IH_CANCEL_L_ID\":null,\"IH_CANCEL_NOTE\":null,\"IH_PROVIDER_USER_ID\":null,\"IH_PA_ID\":null,\"IH_NO_AUTO_DISPATCH\":null,\"IH_HIDE_PRICE_DETAIL\":null,\"items\":[{\"ID\":38979899,\"ID_INVOICE\":33969131,\"NOTE\":\"Nostrum omnis autem et consequatur aut.\",\"COUNT\":null,\"AMOUNT\":\"4770.9696\",\"IB_ITD_PRICE_VAT\":null,\"IB_ITD_PRICE_WO_VAT\":null,\"IB_ITD_PRICE_ROUND\":null,\"MONTH\":\"05\",\"YEAR\":\"2023\",\"USER_SERVICE_ID\":2327,\"IB_PER\":9,\"IB_NOTE2\":null,\"IB_ATTACHMENT\":null,\"IB_ITD_ID\":null,\"IB_ITD_ADVANCE_ID\":0,\"IB_PRICE_TYPE\":\"FIX\",\"IB_DISCOUNT\":0,\"IB_SAD_ID\":null,\"IB_ACCOUNT_ADVANCE\":0,\"IB_REVERSE_CHARGE\":null,\"IB_SA_ID\":null,\"IB_SA_BASE_ID\":null,\"IB_TL_VALUE_PERCENT\":null,\"IB_NO_PAY\":null}]}}", "name": "" } ] } ] }, { "name": "Locations", "description": "", "item": [ { "name": "List Locations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/locations", "query": [ { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location IDs (overrides X-CT header)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/locations?cts=1%2C2%2C3" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of non-hidden locations within the login's allowed CTs." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":\"298\",\"NAME\":\"aut adipisci quidem\",\"DESCRIPTION\":\"Commodi incidunt iure odit et et modi.\",\"LOCATION\":null,\"START_DATE\":\"2026-07-26\",\"SIPO_KODOZ\":\"sc\",\"SIPO_CISORG\":null,\"INFO_EMAIL\":\"ztromp@example.org\",\"HIDDEN\":0,\"PATH\":null,\"I_COMPANY_ID\":48,\"I_CP_ID\":1,\"I_MAP_ID\":null,\"I_NOTE\":\"Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia. Dignissimos neque blanditiis odio.\",\"I_MAP_CENTER_LAT\":28.134129,\"I_MAP_CENTER_LON\":116.728477,\"I_MAP_ZOOM\":20,\"I_MAP_ID_NAME\":\"MAPNAME-mgos\",\"I_CL_ID\":1},{\"ID\":\"299\",\"NAME\":\"officiis corporis nesciunt\",\"DESCRIPTION\":null,\"LOCATION\":\"Tressatown\",\"START_DATE\":\"2026-06-14\",\"SIPO_KODOZ\":\"zc\",\"SIPO_CISORG\":\"cvalex\",\"INFO_EMAIL\":\"alia45@example.net\",\"HIDDEN\":0,\"PATH\":null,\"I_COMPANY_ID\":52,\"I_CP_ID\":1,\"I_MAP_ID\":null,\"I_NOTE\":\"Ut dicta vitae assumenda consequatur ut et sunt. Sit repellendus ut eaque alias ratione. Sed rem ea ut aut deserunt. In quod id aspernatur consectetur id a. Assumenda eaque neque sit sunt nihil accusantium odit. Perspiciatis rem dolorem aut quis ut.\",\"I_MAP_CENTER_LAT\":31.792143,\"I_MAP_CENTER_LON\":54.509342,\"I_MAP_ZOOM\":8,\"I_MAP_ID_NAME\":\"MAPNAME-xpvf\",\"I_CL_ID\":1}]}", "name": "" } ] } ] }, { "name": "Network Event Triggers", "description": "", "item": [ { "name": "List Network Event Triggers", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/network-event\/triggers", "query": [ { "key": "order", "value": "NET_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: NET_ID, NET_STATUS, NET_NEFG_ID, NET_CP_ID.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated trigger IDs (NET_ID).", "disabled": false }, { "key": "webhook_eligible", "value": "1", "description": "When true, return only triggers that have an active WEBHOOK target \u2014 i.e. those selectable for a device-event webhook config.", "disabled": false }, { "key": "active", "value": "1", "description": "Filter by active status. When omitted, only active triggers (NET_ACTIVE = 1) are returned.", "disabled": false }, { "key": "ct", "value": "129", "description": "Narrow the offer to triggers whose filter group is CT-global (NEFG_CT is NULL) or matches this CT.", "disabled": false }, { "key": "cp_id", "value": "3", "description": "Narrow the offer to triggers that are CP-global (NET_CP_ID is NULL) or match this CP.", "disabled": false }, { "key": "status", "value": "CRITICAL", "description": "Filter by configured trigger status.", "disabled": false }, { "key": "nefg_id", "value": "5", "description": "Filter by filter-group ID (NET_NEFG_ID).", "disabled": false }, { "key": "node_id", "value": "42", "description": "Filter by node ID (NET_N_ID).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/network-event\/triggers?order=NET_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&webhook_eligible=1&active=1&ct=129&cp_id=3&status=CRITICAL&nefg_id=5&node_id=42" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of operator network-event triggers, scoped by CP.\n Intended as the picker source for device-event webhook configs \u2014 pass\n `?webhook_eligible=1` to get only triggers with an active WEBHOOK target.\n The trigger has no name of its own; compose a label from the returned\n `filter_group.NEFG_NAME`, `NET_STATUS` and `node`." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"NET_ID\":482,\"NET_NEFG_ID\":464,\"NET_N_ID\":1811132,\"NET_STATUS\":\"OK\",\"NET_TRIGGER_UNCHANGED_STATE\":0,\"NET_ACTIVE\":1,\"NET_CREATED\":\"2026-03-19T23:05:12.000000Z\",\"NET_CREATE_L_ID\":751,\"NET_CHANGED\":null,\"NET_CHANGE_L_ID\":null,\"NET_CP_ID\":null,\"NET_TRIGGER_TREE_CHECK\":0,\"filter_group\":{\"NEFG_ID\":464,\"NEFG_NAME\":\"quidem nostrum qui\",\"NEFG_CT\":null,\"NEFG_CP\":null},\"node\":{\"ID\":1811132,\"NAME\":\"DEV-wrsitc\"}},{\"NET_ID\":483,\"NET_NEFG_ID\":465,\"NET_N_ID\":1811133,\"NET_STATUS\":\"OK\",\"NET_TRIGGER_UNCHANGED_STATE\":0,\"NET_ACTIVE\":1,\"NET_CREATED\":\"2026-01-23T20:40:02.000000Z\",\"NET_CREATE_L_ID\":46,\"NET_CHANGED\":null,\"NET_CHANGE_L_ID\":null,\"NET_CP_ID\":null,\"NET_TRIGGER_TREE_CHECK\":0,\"filter_group\":{\"NEFG_ID\":465,\"NEFG_NAME\":\"praesentium quis adipisci\",\"NEFG_CT\":null,\"NEFG_CP\":null},\"node\":{\"ID\":1811133,\"NAME\":\"DEV-klqppw\"}}]}", "name": "" } ] }, { "name": "Get Network Event Trigger", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/network-event\/triggers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/network-event\/triggers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the trigger." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single network-event trigger by ID, with its filter group and node." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"NET_ID\":484,\"NET_NEFG_ID\":466,\"NET_N_ID\":1811134,\"NET_STATUS\":\"OK\",\"NET_TRIGGER_UNCHANGED_STATE\":0,\"NET_ACTIVE\":1,\"NET_CREATED\":\"2026-03-19T23:03:21.000000Z\",\"NET_CREATE_L_ID\":751,\"NET_CHANGED\":null,\"NET_CHANGE_L_ID\":null,\"NET_CP_ID\":null,\"NET_TRIGGER_TREE_CHECK\":0,\"filter_group\":{\"NEFG_ID\":466,\"NEFG_NAME\":\"commodi incidunt iure\",\"NEFG_CT\":null,\"NEFG_CP\":null},\"node\":{\"ID\":1811134,\"NAME\":\"DEV-itcpsc\"}}}", "name": "" } ] } ] }, { "name": "Operator Roles", "description": "", "item": [ { "name": "List Operator Roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/operator-roles", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "9%2C12", "description": "Filter by comma-separated role IDs.", "disabled": false }, { "key": "cibs_partners", "value": "3%2C69", "description": "Filter by comma-separated CIBS partner IDs. Use \"null\" to get global (partnerless) roles only.", "disabled": false }, { "key": "search", "value": "admin", "description": "Search in role name.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/operator-roles?per_page=15&page=1&ids=9%2C12&cibs_partners=3%2C69&search=admin" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of operator roles.\nPartner-bound users see roles of their CIBS partner + global roles (LR_CP_ID IS NULL)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"LR_ID\":742,\"LR_CP_ID\":null,\"LR_NAME\":\"aut adipisci quidem\",\"LR_LEVEL\":7,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-03-31 21:01:11\",\"LR_L_ID\":1,\"rights\":[{\"ID\":661709,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":742,\"NAME\":\"incidunt-iure-odit\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-04-10 12:48:14\",\"UR_CREATOR_L_ID\":1}]},{\"LR_ID\":743,\"LR_CP_ID\":null,\"LR_NAME\":\"et modi ipsum\",\"LR_LEVEL\":1,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-06-21 01:33:33\",\"LR_L_ID\":1,\"rights\":[{\"ID\":661710,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":743,\"NAME\":\"et-consequatur\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-01-22 20:47:36\",\"UR_CREATOR_L_ID\":1}]}]}", "name": "" } ] }, { "name": "Get Operator Role", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/operator-roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/operator-roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "9", "description": "The ID of the operator role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single operator role by ID, including its rights and assigned operators." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"LR_ID\":744,\"LR_CP_ID\":null,\"LR_NAME\":\"aut adipisci quidem\",\"LR_LEVEL\":7,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-03-31 21:01:11\",\"LR_L_ID\":1,\"rights\":[{\"ID\":661711,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":744,\"NAME\":\"et-modi-ipsum\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-07-26 04:03:05\",\"UR_CREATOR_L_ID\":1}],\"operators\":[{\"ID\":5871,\"FIRST_NAME\":\"Isidro\",\"SURNAME\":\"McLaughlin\",\"LOGIN\":\"ztromp\",\"L_LEVEL\":3,\"MAIL\":\"wnitzsche@example.org\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"NOTICE\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-05-08 10:10:33\",\"L_L_ID\":1,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"MACHINE\",\"L_SIGNATURE\":null,\"L_SELFCARE\":0,\"L_CACHE_INITIALS\":\"\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0,\"pivot\":{\"LRC_LR_ID\":744,\"LRC_L_ID\":5871}}]}}", "name": "" } ] } ] }, { "name": "Operators", "description": "", "item": [ { "name": "List Operators", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/operators", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "294%2C705", "description": "Filter by comma-separated operator IDs.", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status. When omitted, only active operators are returned.", "disabled": false }, { "key": "role", "value": "12", "description": "Filter operators by assigned role ID.", "disabled": false }, { "key": "type", "value": "PERSON", "description": "Filter by operator type (PERSON, MACHINE, COOPERATION).", "disabled": false }, { "key": "search", "value": "jan", "description": "Search in name, surname, login, and email.", "disabled": false }, { "key": "include_internal", "value": "true", "description": "Include internal operators (L_CP_ID IS NULL) with limited fields. Only relevant for partner-bound users.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/operators?per_page=15&page=1&ids=294%2C705&active=true&role=12&type=PERSON&search=jan&include_internal=true" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of system operators (admin users).\nBy default only active operators are returned (L_ACTIVE=1).\nUse the `active` filter to include\/filter inactive operators.\nPartner-bound users only see operators of their CIBS partner.\nUse `include_internal=true` to also see internal operators (with limited fields)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":5868,\"FIRST_NAME\":\"Morgan\",\"SURNAME\":\"Hirthe\",\"LOGIN\":\"pfritsch\",\"L_LEVEL\":4,\"MAIL\":\"pauline09@example.com\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"NOTICE\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-03-04 16:35:23\",\"L_L_ID\":1,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"MACHINE\",\"L_SIGNATURE\":null,\"L_SELFCARE\":0,\"L_CACHE_INITIALS\":\"\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0,\"roles\":[{\"LR_ID\":739,\"LR_CP_ID\":null,\"LR_NAME\":\"deleniti distinctio eum\",\"LR_LEVEL\":2,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-02-28 18:45:57\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5868,\"LRC_LR_ID\":739}}],\"effective_rights\":[{\"ID\":331367280,\"USER_ID\":5868,\"NAME\":\"aliquam-veniam-corporis\",\"OPTIONS\":\"\"}],\"own_rights\":[]},{\"ID\":5869,\"FIRST_NAME\":\"Amari\",\"SURNAME\":\"Torp\",\"LOGIN\":\"kirsten.ward\",\"L_LEVEL\":9,\"MAIL\":\"anderson.herbert@example.com\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"NOTICE\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-05-21 17:23:04\",\"L_L_ID\":1,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"MACHINE\",\"L_SIGNATURE\":null,\"L_SELFCARE\":0,\"L_CACHE_INITIALS\":\"\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0,\"roles\":[{\"LR_ID\":740,\"LR_CP_ID\":null,\"LR_NAME\":\"modi rerum ex\",\"LR_LEVEL\":4,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-06-26 01:12:20\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5869,\"LRC_LR_ID\":740}}],\"effective_rights\":[{\"ID\":331367281,\"USER_ID\":5869,\"NAME\":\"ab-reiciendis-quia\",\"OPTIONS\":\"\"}],\"own_rights\":[]}]}", "name": "" } ] }, { "name": "Get Operator", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/operators\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/operators\/:id", "variable": [ { "id": "id", "key": "id", "value": "0", "description": "The ID of the operator." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single operator by ID, including roles (with their rights),\neffective rights, and own rights." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":5870,\"FIRST_NAME\":\"Morgan\",\"SURNAME\":\"Hirthe\",\"LOGIN\":\"carey67\",\"L_LEVEL\":10,\"MAIL\":\"daphne59@example.com\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"NOTICE\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-06-18 20:44:28\",\"L_L_ID\":1,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"MACHINE\",\"L_SIGNATURE\":null,\"L_SELFCARE\":0,\"L_CACHE_INITIALS\":\"\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0,\"roles\":[{\"LR_ID\":741,\"LR_CP_ID\":null,\"LR_NAME\":\"aliquam veniam corporis\",\"LR_LEVEL\":3,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-01-04 02:08:16\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5870,\"LRC_LR_ID\":741},\"rights\":[{\"ID\":661707,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":741,\"NAME\":\"nemo-odit\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-07-01 05:01:22\",\"UR_CREATOR_L_ID\":1}]}],\"effective_rights\":[{\"ID\":331367282,\"USER_ID\":5870,\"NAME\":\"dignissimos-neque\",\"OPTIONS\":\"\"}],\"own_rights\":[]}}", "name": "" } ] } ] }, { "name": "Payment Accounts", "description": "", "item": [ { "name": "List Payment Accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/payment-accounts", "query": [ { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "2%2C11%2C12", "description": "Filter by comma-separated payment account IDs.", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (installation) IDs. Returns accounts linked to any of the given locations. Overrides X-CT header default.", "disabled": false }, { "key": "type", "value": "cash", "description": "Filter by account type.", "disabled": false }, { "key": "active", "value": "false", "description": "Filter by active status. When omitted, only active accounts (PA_ACTUAL = 1) are returned.", "disabled": false }, { "key": "search", "value": "Pokladna", "description": "Search by account name (PA_NAME).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/payment-accounts?per_page=15&page=1&ids=2%2C11%2C12&cts=11%2C12&type=cash&active=false&search=Pokladna" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of payment accounts (cash registers and bank accounts).\n By default only active accounts are returned; use `active=false` for inactive.\n CT scoping is indirect \u2014 only accounts linked to at least one of the\n user's authorized locations (via pay_account_loc) are visible." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"PA_ID\":1556,\"PA_TYPE\":\"cash\",\"PA_CC_ID\":1,\"PA_NAME\":\"adipisci quidem nostrum\",\"PA_ACCOUNT_PREFIX\":null,\"PA_ACCOUNT_NUMBER\":null,\"PA_ACCOUNT_BANK\":null,\"PA_IBAN\":null,\"PA_IMPORT_TYPE\":\"gpc\",\"PA_COLLECTION_TYPE\":\"kpc\",\"PA_CP_ID\":1,\"PA_ACTUAL\":1,\"PA_IMPORT_CHECK\":\"STATEMENT_NO\",\"PA_IMPORT_DATE\":null,\"PA_COMMISSION\":\"none\",\"PA_CORRELATION\":null,\"PA_CORRELATION_CARD\":null,\"PA_CORRELATION_SIPO\":null,\"PA_NO_CHARGED\":null,\"PA_WRITE_OFF\":null,\"PA_EET\":null,\"PA_EET_DEFAULT\":null,\"PA_EET_SHOP_SIGN\":null,\"PA_EET_CASH_SIGN\":null,\"PA_EET_NOTIFICATION\":null,\"PA_AUTOCONFIRM\":0,\"PA_AUTOCONFIRM_DAY\":null,\"PA_AUTOCONFIRM_TYPE\":null,\"PA_AUTOCONFIRM_MAKE_PAYMENT\":null,\"PA_AUTOCONFIRM_NOTIFICATION\":null,\"PA_AUTOCONFIRM_SEND_ALWAYS\":null,\"PA_AUTOGENERATE\":0,\"PA_AUTOGENERATE_DAY\":null,\"PA_AUTOGENERATE_TYPE\":null,\"PA_AUTOGENERATE_NOTIFICATION\":null,\"PA_AUTOGENERATE_SEND_ALWAYS\":null,\"PA_ROUNDING\":null,\"PA_ROUNDING_VALUE\":null,\"PA_ROUNDING_REVENUES_ACCOUNT\":null,\"PA_ROUNDING_COST_ACCOUNT\":null,\"PA_CREATE_L_ID\":1,\"PA_CREATED\":\"2026-03-31 20:58:33\",\"locations\":[{\"PAL_ID\":1583,\"PAL_PA_ID\":1556,\"PAL_CT\":10,\"PAL_PROVIDER_USER_ID\":null,\"PAL_DEFAULT\":0}]},{\"PA_ID\":1557,\"PA_TYPE\":\"cash\",\"PA_CC_ID\":1,\"PA_NAME\":\"iure odit et\",\"PA_ACCOUNT_PREFIX\":null,\"PA_ACCOUNT_NUMBER\":null,\"PA_ACCOUNT_BANK\":null,\"PA_IBAN\":null,\"PA_IMPORT_TYPE\":\"gpc\",\"PA_COLLECTION_TYPE\":\"kpc\",\"PA_CP_ID\":1,\"PA_ACTUAL\":1,\"PA_IMPORT_CHECK\":\"STATEMENT_NO\",\"PA_IMPORT_DATE\":null,\"PA_COMMISSION\":\"none\",\"PA_CORRELATION\":null,\"PA_CORRELATION_CARD\":null,\"PA_CORRELATION_SIPO\":null,\"PA_NO_CHARGED\":null,\"PA_WRITE_OFF\":null,\"PA_EET\":null,\"PA_EET_DEFAULT\":null,\"PA_EET_SHOP_SIGN\":null,\"PA_EET_CASH_SIGN\":null,\"PA_EET_NOTIFICATION\":null,\"PA_AUTOCONFIRM\":0,\"PA_AUTOCONFIRM_DAY\":null,\"PA_AUTOCONFIRM_TYPE\":null,\"PA_AUTOCONFIRM_MAKE_PAYMENT\":null,\"PA_AUTOCONFIRM_NOTIFICATION\":null,\"PA_AUTOCONFIRM_SEND_ALWAYS\":null,\"PA_AUTOGENERATE\":0,\"PA_AUTOGENERATE_DAY\":null,\"PA_AUTOGENERATE_TYPE\":null,\"PA_AUTOGENERATE_NOTIFICATION\":null,\"PA_AUTOGENERATE_SEND_ALWAYS\":null,\"PA_ROUNDING\":null,\"PA_ROUNDING_VALUE\":null,\"PA_ROUNDING_REVENUES_ACCOUNT\":null,\"PA_ROUNDING_COST_ACCOUNT\":null,\"PA_CREATE_L_ID\":1,\"PA_CREATED\":\"2026-07-01 19:58:08\",\"locations\":[{\"PAL_ID\":1584,\"PAL_PA_ID\":1557,\"PAL_CT\":8,\"PAL_PROVIDER_USER_ID\":null,\"PAL_DEFAULT\":0}]}]}", "name": "" } ] }, { "name": "Get Payment Account", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/payment-accounts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/payment-accounts\/:id", "variable": [ { "id": "id", "key": "id", "value": "2", "description": "The ID of the payment account." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single payment account by ID, including its business location assignments." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"PA_ID\":1558,\"PA_TYPE\":\"cash\",\"PA_CC_ID\":1,\"PA_NAME\":\"adipisci quidem nostrum\",\"PA_ACCOUNT_PREFIX\":null,\"PA_ACCOUNT_NUMBER\":null,\"PA_ACCOUNT_BANK\":null,\"PA_IBAN\":null,\"PA_IMPORT_TYPE\":\"gpc\",\"PA_COLLECTION_TYPE\":\"kpc\",\"PA_CP_ID\":1,\"PA_ACTUAL\":1,\"PA_IMPORT_CHECK\":\"STATEMENT_NO\",\"PA_IMPORT_DATE\":null,\"PA_COMMISSION\":\"none\",\"PA_CORRELATION\":null,\"PA_CORRELATION_CARD\":null,\"PA_CORRELATION_SIPO\":null,\"PA_NO_CHARGED\":null,\"PA_WRITE_OFF\":null,\"PA_EET\":null,\"PA_EET_DEFAULT\":null,\"PA_EET_SHOP_SIGN\":null,\"PA_EET_CASH_SIGN\":null,\"PA_EET_NOTIFICATION\":null,\"PA_AUTOCONFIRM\":0,\"PA_AUTOCONFIRM_DAY\":null,\"PA_AUTOCONFIRM_TYPE\":null,\"PA_AUTOCONFIRM_MAKE_PAYMENT\":null,\"PA_AUTOCONFIRM_NOTIFICATION\":null,\"PA_AUTOCONFIRM_SEND_ALWAYS\":null,\"PA_AUTOGENERATE\":0,\"PA_AUTOGENERATE_DAY\":null,\"PA_AUTOGENERATE_TYPE\":null,\"PA_AUTOGENERATE_NOTIFICATION\":null,\"PA_AUTOGENERATE_SEND_ALWAYS\":null,\"PA_ROUNDING\":null,\"PA_ROUNDING_VALUE\":null,\"PA_ROUNDING_REVENUES_ACCOUNT\":null,\"PA_ROUNDING_COST_ACCOUNT\":null,\"PA_CREATE_L_ID\":1,\"PA_CREATED\":\"2026-03-31 20:58:33\",\"locations\":[{\"PAL_ID\":1585,\"PAL_PA_ID\":1558,\"PAL_CT\":10,\"PAL_PROVIDER_USER_ID\":null,\"PAL_DEFAULT\":0}]}}", "name": "" } ] } ] }, { "name": "Payments", "description": "", "item": [ { "name": "List Payments", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/payments", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "100%2C200%2C300", "description": "Filter by comma-separated payment IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "1009", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "account", "value": "1", "description": "Filter by payment account ID.", "disabled": false }, { "key": "type", "value": "P", "description": "Filter by payment method (TYPE column).", "disabled": false }, { "key": "join_type", "value": "U", "description": "Filter by matching status. U = Mango, O = Other, S = SIPO, N = Unmatched, C = Card.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter payments on or after this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter payments on or before this date (YYYY-MM-DD).", "disabled": false }, { "key": "var_symbol", "value": "1234567890", "description": "Filter by variable symbol.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/payments?per_page=10&page=1&ids=100%2C200%2C300&cts=1%2C2%2C3&customer=1009&account=1&type=P&join_type=U&date_from=2024-01-01&date_to=2024-12-31&var_symbol=1234567890" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of payments.\n **At least one** of the following filters must be provided:\n `customer`, `account`, `date_from`, `var_symbol`.\n Without a narrowing filter the endpoint returns HTTP 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":25632863,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1981-07-29\",\"PL_DATE_ACCOUNT_BANK\":null,\"AMOUNT\":\"9473.3378\",\"TYPE\":\"H\",\"VAR_SYMBOL\":7214902,\"PL_SPEC_SYMBOL\":null,\"PL_KONS_SYMBOL\":null,\"USER_ID\":5485,\"CT\":95,\"NOTE\":null,\"SYS_TIME\":\"2026-08-12 16:54:55\",\"PL_DOC_ID\":null,\"PL_JOIN_TYPE\":\"S\",\"PL_BANK_DOC_ID\":null,\"PL_BANK_ACC_PREFIX\":null,\"PL_BANK_ACC_NUMBER\":null,\"PL_BANK_ACC_BANK\":null,\"PL_IBAN\":null,\"PL_SIPO_ID\":null,\"PL_FLAG\":\"O\",\"PL_MATCHING_STRATEGY\":0,\"PL_INTERNAL_ID\":null,\"PL_DATE_DEATTACH\":null,\"PL_AUTHOR_DEATTACH\":null,\"PL_UDF_TYPE\":null,\"PL_DEATTACH\":null,\"PL_DEATTACH_ATTACH\":null,\"PL_CREATE_L_ID\":null,\"PL_CREATED\":null,\"PL_CHANGE_L_ID\":null,\"PL_CHANGED\":null,\"PL_PF_ID\":null,\"PL_PROVIDER_USER_ID\":null,\"PL_CREDIT_NOTE_ADVANCE\":null,\"PL_CACHE_ATTACHED\":null,\"PL_CACHE_ADVANCE\":null},{\"ID\":25632864,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1989-10-07\",\"PL_DATE_ACCOUNT_BANK\":null,\"AMOUNT\":\"-7760.2620\",\"TYPE\":\"P\",\"VAR_SYMBOL\":8265058,\"PL_SPEC_SYMBOL\":null,\"PL_KONS_SYMBOL\":null,\"USER_ID\":6877,\"CT\":76,\"NOTE\":\"Consequatur aut dolores enim non facere tempora.\",\"SYS_TIME\":\"2026-08-12 16:54:55\",\"PL_DOC_ID\":null,\"PL_JOIN_TYPE\":\"S\",\"PL_BANK_DOC_ID\":null,\"PL_BANK_ACC_PREFIX\":null,\"PL_BANK_ACC_NUMBER\":null,\"PL_BANK_ACC_BANK\":null,\"PL_IBAN\":null,\"PL_SIPO_ID\":null,\"PL_FLAG\":\"O\",\"PL_MATCHING_STRATEGY\":0,\"PL_INTERNAL_ID\":null,\"PL_DATE_DEATTACH\":null,\"PL_AUTHOR_DEATTACH\":null,\"PL_UDF_TYPE\":null,\"PL_DEATTACH\":null,\"PL_DEATTACH_ATTACH\":null,\"PL_CREATE_L_ID\":null,\"PL_CREATED\":null,\"PL_CHANGE_L_ID\":null,\"PL_CHANGED\":null,\"PL_PF_ID\":null,\"PL_PROVIDER_USER_ID\":null,\"PL_CREDIT_NOTE_ADVANCE\":null,\"PL_CACHE_ATTACHED\":null,\"PL_CACHE_ADVANCE\":null}]}", "name": "" } ] }, { "name": "Get Payment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/payments\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/payments\/:id", "variable": [ { "id": "id", "key": "id", "value": "259", "description": "The ID of the payment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single payment by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":25632865,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1981-07-29\",\"PL_DATE_ACCOUNT_BANK\":null,\"AMOUNT\":\"9473.3378\",\"TYPE\":\"H\",\"VAR_SYMBOL\":8988862,\"PL_SPEC_SYMBOL\":null,\"PL_KONS_SYMBOL\":null,\"USER_ID\":5485,\"CT\":95,\"NOTE\":null,\"SYS_TIME\":\"2026-08-12 16:54:55\",\"PL_DOC_ID\":null,\"PL_JOIN_TYPE\":\"S\",\"PL_BANK_DOC_ID\":null,\"PL_BANK_ACC_PREFIX\":null,\"PL_BANK_ACC_NUMBER\":null,\"PL_BANK_ACC_BANK\":null,\"PL_IBAN\":null,\"PL_SIPO_ID\":null,\"PL_FLAG\":\"O\",\"PL_MATCHING_STRATEGY\":0,\"PL_INTERNAL_ID\":null,\"PL_DATE_DEATTACH\":null,\"PL_AUTHOR_DEATTACH\":null,\"PL_UDF_TYPE\":null,\"PL_DEATTACH\":null,\"PL_DEATTACH_ATTACH\":null,\"PL_CREATE_L_ID\":null,\"PL_CREATED\":null,\"PL_CHANGE_L_ID\":null,\"PL_CHANGED\":null,\"PL_PF_ID\":null,\"PL_PROVIDER_USER_ID\":null,\"PL_CREDIT_NOTE_ADVANCE\":null,\"PL_CACHE_ATTACHED\":null,\"PL_CACHE_ADVANCE\":null}}", "name": "" } ] } ] }, { "name": "Premise Groups", "description": "", "item": [ { "name": "List premise groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premise-groups", "query": [ { "key": "order", "value": "ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: ID, GROUP_NAME.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of groups to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated group IDs", "disabled": false }, { "key": "search", "value": "Region", "description": "Filter by group name (substring match)", "disabled": false }, { "key": "cts", "value": "31%2C216", "description": "Filter by comma-separated installation (CT) IDs, within those the login may access", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/premise-groups?order=ID%3Adesc&per_page=10&page=1&ids=1%2C2%2C3&search=Region&cts=31%2C216" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "List groups currently used to categorise premises (regions, store formats, etc.). Read-only \u2014 premise-group assignments are managed in the Mango UI; no CUD endpoints exist in v3." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":2782,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"qui commodi\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null},{\"ID\":2783,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"odit et\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null}]}", "name": "" } ] } ] }, { "name": "Premise Parameter Definitions", "description": "", "item": [ { "name": "List premise parameter definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premise-parameter-definitions", "query": [ { "key": "order", "value": "PPD_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: PPD_ID, PPD_NAME, PPD_CT, PPD_TYPE.", "disabled": false }, { "key": "per_page", "value": "10", "description": "Number of definitions to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated definition IDs", "disabled": false }, { "key": "cts", "value": "31%2C101", "description": "Filter by comma-separated location (installation) IDs. Returns global definitions (PPD_CT = 0) plus definitions for the specified CTs.", "disabled": false }, { "key": "name", "value": "TEMPERATURE", "description": "Filter by exact parameter name match", "disabled": false }, { "key": "disabled", "value": "all", "description": "Filter by disabled status. Default (omitted): only enabled (PPD_DISABLED=0). 'true' = disabled only, 'all' = both enabled and disabled.", "disabled": false }, { "key": "system", "value": "N", "description": "Filter by system type (N=normal, S=system, I=internal)", "disabled": false }, { "key": "view", "value": "premise", "description": "Filter by view type (substring match, e.g., premise)", "disabled": false }, { "key": "search", "value": "TEMP", "description": "Filter by parameter name (substring match)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/premise-parameter-definitions?order=PPD_ID%3Adesc&per_page=10&page=1&ids=1%2C2%2C3&cts=31%2C101&name=TEMPERATURE&disabled=all&system=N&view=premise&search=TEMP" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "List parameter definitions visible to the operator. Definitions with PPD_CT=0 are global (visible to all CTs); others are CT-specific. By default, disabled definitions are hidden \u2014 pass `disabled=true` to include them." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"PPD_ID\":256,\"PPD_CT\":0,\"PPD_NAME\":\"AUTEM\",\"PPD_DISPLAY\":null,\"PPD_DEFAULT_VALUE\":\"\",\"PPD_TYPE\":\"FLOAT\",\"PPD_INDEXED\":0,\"PPD_DOMAIN\":null,\"PPD_NOTNULL\":0,\"PPD_TIME_RESOLUTION\":1,\"PPD_DISABLED\":0,\"PPD_PUBLIC\":1,\"PPD_L_ID\":\"0000000004\",\"PPD_CREATED\":\"2026-08-12 16:55:04\",\"PPD_DOC_VARNAME\":\"\",\"PPD_PROVISIONING\":0,\"PPD_SYSTEM\":\"N\",\"PPD_EU_VISIBLE\":0,\"PPD_VIEW\":\"premise\",\"PPD_ORDER\":null,\"PPD_GROUP_NAME\":null},{\"PPD_ID\":257,\"PPD_CT\":0,\"PPD_NAME\":\"DOLORES\",\"PPD_DISPLAY\":null,\"PPD_DEFAULT_VALUE\":\"\",\"PPD_TYPE\":\"STRING\",\"PPD_INDEXED\":0,\"PPD_DOMAIN\":null,\"PPD_NOTNULL\":0,\"PPD_TIME_RESOLUTION\":1,\"PPD_DISABLED\":0,\"PPD_PUBLIC\":1,\"PPD_L_ID\":\"0000000004\",\"PPD_CREATED\":\"2026-08-12 16:55:04\",\"PPD_DOC_VARNAME\":\"\",\"PPD_PROVISIONING\":0,\"PPD_SYSTEM\":\"N\",\"PPD_EU_VISIBLE\":0,\"PPD_VIEW\":\"premise\",\"PPD_ORDER\":null,\"PPD_GROUP_NAME\":null}]}", "name": "" } ] } ] }, { "name": "Premise Params", "description": "", "item": [ { "name": "List premise params", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises\/:premise_id\/params", "query": [ { "key": "order", "value": "PP_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: PP_ID, PP_NAME, PP_VALID_FROM, PP_VALID_TO, PP_CREATED.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "name", "value": "OTVIRACIDOBA.PO", "description": "Filter by parameter name. Returns all rows for that name (full history + planned). Overrides default valid_at=today.", "disabled": false }, { "key": "valid_at", "value": "2026-01-15", "description": "Filter to parameters valid on this date (YYYY-MM-DD). Default: today when `name` is not set. Ignored when `name` is set.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/premises\/:premise_id\/params?order=PP_ID%3Adesc&per_page=15&page=1&name=OTVIRACIDOBA.PO&valid_at=2026-01-15", "variable": [ { "id": "premise_id", "key": "premise_id", "value": "1", "description": "The ID of the premise." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "List parameter values for a premise. By default returns only currently-valid rows. Filter by `name` to see the full history of a single param (planned + past values), or `valid_at=YYYY-MM-DD` to see what is\/was\/will be valid on a specific date." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"PP_ID\":820283,\"PP_P_ID\":11311,\"PP_NAME\":\"IURE\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Et et modi ipsum nostrum.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4},{\"PP_ID\":820284,\"PP_P_ID\":11312,\"PP_NAME\":\"RATIONE\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Impedit molestiae ut rem est esse.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}]}", "name": "" } ] }, { "name": "Add premise param value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises\/:premise_id\/params", "query": [], "raw": "{{baseUrl}}\/api\/v3\/premises\/:premise_id\/params", "variable": [ { "id": "premise_id", "key": "premise_id", "value": "1", "description": "The ID of the premise." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"OTVIRACIDOBA.PO\",\"value\":\"08:00-18:00\",\"valid_from\":\"2026-01-15\"}" }, "description": "Insert a new parameter value row for a premise. For time-resolved params (PPD_TIME_RESOLUTION=1) this creates a new validity slot starting at `valid_from` (default: today). The SP rejects duplicates of the same name+valid_from for time-resolved params, and any second row at all for non-time-resolved params." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"PP_ID\":820285,\"PP_P_ID\":11313,\"PP_NAME\":\"ODIT\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Et modi ipsum nostrum omnis autem et consequatur.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}}", "name": "" } ] }, { "name": "Update premise param value", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises\/:premise_id\/params\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/premises\/:premise_id\/params\/:id", "variable": [ { "id": "premise_id", "key": "premise_id", "value": "1", "description": "The ID of the premise." }, { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the param." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"value\":\"08:00-19:00\",\"valid_from\":\"2026-02-01\"}" }, "description": "Update a parameter value (upsert). For time-resolved params, if `valid_from` matches the targeted row's date the row is updated in place; otherwise a new validity slot is inserted and the SP closes adjacent rows automatically. The response's PP_ID may differ from the URL `{param}` when a new slot is inserted." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"PP_ID\":820286,\"PP_P_ID\":11314,\"PP_NAME\":\"MODI\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Nostrum omnis autem et consequatur aut.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}}", "name": "" } ] } ] }, { "name": "Premises", "description": "", "item": [ { "name": "List premises", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises", "query": [ { "key": "order", "value": "P_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: P_ID, P_IDENT, P_NAME, P_CREATED, P_LAST_CHANGE.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated premise IDs (P_ID).", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (CT) IDs. Narrows via the owning user's CT.", "disabled": false }, { "key": "user_ids", "value": "41994%2C42000", "description": "Filter by comma-separated owning user IDs (P_U_ID).", "disabled": false }, { "key": "idents", "value": "KO_001%2CKO_002", "description": "Filter by comma-separated premise identifiers (P_IDENT).", "disabled": false }, { "key": "type_sale", "value": "BOX", "description": "Filter by exact sale type (P_TYPE_SALE). Enum: NONE, BOX, MEGA.", "disabled": false }, { "key": "purchase", "value": "true", "description": "Filter by purchase flag (P_PURCHASE). Boolean: true\/false.", "disabled": false }, { "key": "group_ids", "value": "12%2C13", "description": "Filter by comma-separated group IDs. Narrows to premises in these groups via premise_groups bridge.", "disabled": false }, { "key": "search", "value": "Konzum", "description": "Substring search on premise name (P_NAME), identifier (P_IDENT), or city (P_CITY).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/premises?order=P_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&cts=11%2C12&user_ids=41994%2C42000&idents=KO_001%2CKO_002&type_sale=BOX&purchase=true&group_ids=12%2C13&search=Konzum" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of premises visible to the current operator. Each premise includes its currently-valid params and its groups (eager-loaded)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"P_ID\":11306,\"P_U_ID\":2188785,\"P_IDENT\":\"TEST_76wp80\",\"P_NAME\":\"Dare Group\",\"P_EMAIL\":null,\"P_PHONE\":null,\"P_STREET\":null,\"P_HOUSE_ID\":\"02wr\",\"P_CITY\":\"Ferneville\",\"P_ZIP\":\"107365\",\"P_UCP_ID\":null,\"P_US_ID\":null,\"P_UA_ID\":null,\"P_GPS_LATITUDE\":null,\"P_GPS_LONGITUDE\":null,\"P_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"P_L_ID\":4,\"P_TYPE_SALE\":\"NONE\",\"P_PURCHASE\":null,\"P_LAST_CHANGE\":null,\"params\":[{\"PP_ID\":820278,\"PP_P_ID\":11306,\"PP_NAME\":\"DOLORIBUS\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Fugit qui repudiandae laboriosam est alias.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}],\"groups\":[{\"ID\":2777,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"tenetur ratione\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"pivot\":{\"PG_P_ID\":11306,\"PG_GROUP_ID\":2777}}]},{\"P_ID\":11307,\"P_U_ID\":2188786,\"P_IDENT\":\"TEST_39og74\",\"P_NAME\":\"Cruickshank and Sons\",\"P_EMAIL\":null,\"P_PHONE\":null,\"P_STREET\":null,\"P_HOUSE_ID\":\"22hg\",\"P_CITY\":\"Sibylmouth\",\"P_ZIP\":\"664519\",\"P_UCP_ID\":null,\"P_US_ID\":null,\"P_UA_ID\":null,\"P_GPS_LATITUDE\":null,\"P_GPS_LONGITUDE\":null,\"P_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"P_L_ID\":4,\"P_TYPE_SALE\":\"NONE\",\"P_PURCHASE\":null,\"P_LAST_CHANGE\":null,\"params\":[{\"PP_ID\":820279,\"PP_P_ID\":11307,\"PP_NAME\":\"UT\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Sunt quisquam sit repellendus.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}],\"groups\":[{\"ID\":2778,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"ut eaque\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"pivot\":{\"PG_P_ID\":11307,\"PG_GROUP_ID\":2778}}]}]}", "name": "" } ] }, { "name": "Create premise", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises", "query": [], "raw": "{{baseUrl}}\/api\/v3\/premises" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"user_id\":41994,\"ident\":\"KO_001\",\"name\":\"Konzum Zagreb\",\"house_id\":\"A1\",\"city\":\"Zagreb\",\"zip\":\"10000\",\"email\":\"info@konzum.hr\",\"phone\":\"385123456789\",\"street\":\"Kneza Mihajlovic\",\"ucp_id\":100,\"us_id\":200,\"ua_id\":300,\"gps_latitude\":45.815,\"gps_longitude\":16.002,\"type_sale\":\"BOX\",\"purchase\":true}" }, "description": "Create a new premise for an owning customer (P_U_ID). Required fields: user_id, ident, name, house_id, city, zip. The SP auto-materializes premises_params from premises_params_def for the user's CT. Phone numbers and UIR addresses are normalized server-side." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"P_ID\":11308,\"P_U_ID\":2188787,\"P_IDENT\":\"TEST_04lv32\",\"P_NAME\":\"Baumbach Ltd\",\"P_EMAIL\":null,\"P_PHONE\":null,\"P_STREET\":null,\"P_HOUSE_ID\":\"34it\",\"P_CITY\":\"South Isidrostad\",\"P_ZIP\":\"256067\",\"P_UCP_ID\":null,\"P_US_ID\":null,\"P_UA_ID\":null,\"P_GPS_LATITUDE\":null,\"P_GPS_LONGITUDE\":null,\"P_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"P_L_ID\":4,\"P_TYPE_SALE\":\"NONE\",\"P_PURCHASE\":null,\"P_LAST_CHANGE\":null,\"params\":[{\"PP_ID\":820280,\"PP_P_ID\":11308,\"PP_NAME\":\"NEMO\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Accusamus ut et recusandae.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}],\"groups\":[{\"ID\":2779,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"modi rerum\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"pivot\":{\"PG_P_ID\":11308,\"PG_GROUP_ID\":2779}}]}}", "name": "" } ] }, { "name": "Get premise", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/premises\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the premise." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a single premise by ID. Includes currently-valid params and groups (eager-loaded)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"P_ID\":11309,\"P_U_ID\":2188788,\"P_IDENT\":\"TEST_49wr02\",\"P_NAME\":\"Leuschke, Bauch and Fritsch\",\"P_EMAIL\":null,\"P_PHONE\":null,\"P_STREET\":null,\"P_HOUSE_ID\":\"65sc\",\"P_CITY\":\"Baileemouth\",\"P_ZIP\":\"106432\",\"P_UCP_ID\":null,\"P_US_ID\":null,\"P_UA_ID\":null,\"P_GPS_LATITUDE\":null,\"P_GPS_LONGITUDE\":null,\"P_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"P_L_ID\":4,\"P_TYPE_SALE\":\"NONE\",\"P_PURCHASE\":null,\"P_LAST_CHANGE\":null,\"params\":[{\"PP_ID\":820281,\"PP_P_ID\":11309,\"PP_NAME\":\"EX\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Assumenda et tenetur ab reiciendis quia.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}],\"groups\":[{\"ID\":2780,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"perspiciatis deserunt\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"pivot\":{\"PG_P_ID\":11309,\"PG_GROUP_ID\":2780}}]}}", "name": "" } ] }, { "name": "Update premise", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/premises\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/premises\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the premise." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"ident\":\"KO_001\",\"name\":\"Konzum Zagreb\",\"house_id\":\"A1\",\"city\":\"Zagreb\",\"zip\":\"10000\",\"email\":\"info@konzum.hr\",\"phone\":\"385123456789\",\"street\":\"Kneza Mihajlovic\",\"ucp_id\":100,\"us_id\":200,\"ua_id\":300,\"gps_latitude\":45.815,\"gps_longitude\":16.002,\"type_sale\":\"BOX\",\"purchase\":true}" }, "description": "Partially update an existing premise. Omit any field to keep its current value (IFNULL semantics in the underlying SP). The owning user (user_id) cannot be changed; values for ident, name, house_id, city, zip cannot be cleared to empty strings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"P_ID\":11310,\"P_U_ID\":2188789,\"P_IDENT\":\"TEST_00it34\",\"P_NAME\":\"O'Keefe Inc\",\"P_EMAIL\":null,\"P_PHONE\":null,\"P_STREET\":null,\"P_HOUSE_ID\":\"06ql\",\"P_CITY\":\"Lefflerhaven\",\"P_ZIP\":\"197161\",\"P_UCP_ID\":null,\"P_US_ID\":null,\"P_UA_ID\":null,\"P_GPS_LATITUDE\":null,\"P_GPS_LONGITUDE\":null,\"P_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"P_L_ID\":4,\"P_TYPE_SALE\":\"NONE\",\"P_PURCHASE\":null,\"P_LAST_CHANGE\":null,\"params\":[{\"PP_ID\":820282,\"PP_P_ID\":11310,\"PP_NAME\":\"PERSPICIATIS\",\"PP_VALID_FROM\":\"2026-08-11T22:00:00.000000Z\",\"PP_VALID_TO\":null,\"PP_VALUE\":\"Ducimus corrupti et dolores quia maiores assumenda.\",\"PP_CREATED\":\"2026-08-12T14:55:04.000000Z\",\"PP_L_ID\":4}],\"groups\":[{\"ID\":2781,\"G_TARGET\":\"premise\",\"GROUP_NAME\":\"odit doloribus\",\"NOTE\":null,\"G_NOTE_BS\":null,\"CT\":0,\"G_TYPE\":\"OTHER\",\"G_UDF_COLOR\":null,\"G_VIRTUAL\":0,\"G_USER_DETAIL\":0,\"G_WIZARD\":0,\"G_ACTIVE\":1,\"G_SELFCARE\":0,\"G_DETAIL\":null,\"pivot\":{\"PG_P_ID\":11310,\"PG_GROUP_ID\":2781}}]}}", "name": "" } ] } ] }, { "name": "Process Jobs", "description": "", "item": [ { "name": "List Process Jobs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/jobs", "query": [ { "key": "order", "value": "MJ_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: MJ_ID, MJ_DATE, MJ_START, MJ_CREATED, MJ_STATE.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated job IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated CT (installation) IDs", "disabled": false }, { "key": "process_ids", "value": "10%2C20", "description": "Filter by comma-separated parent process IDs", "disabled": false }, { "key": "serman_id", "value": "42", "description": "Filter by serviceman ID", "disabled": false }, { "key": "mjt_id", "value": "1%2C2", "description": "Filter by job type ID(s), comma-separated", "disabled": false }, { "key": "mjk_id", "value": "5%2C6", "description": "Filter by job kind\/category ID(s), comma-separated", "disabled": false }, { "key": "state", "value": "PLANNED", "description": "Filter by job state: PLANNED, DONE, CANCELED", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter jobs with MJ_DATE >= this date (inclusive)", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter jobs with MJ_DATE ", "disabled": false }, { "key": "l_id", "value": "294", "description": "Filter by creator (login) ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/jobs?order=MJ_ID%3Adesc&ids=1%2C2%2C3&cts=1%2C2%2C3&process_ids=10%2C20&serman_id=42&mjt_id=1%2C2&mjk_id=5%2C6&state=PLANNED&date_from=2024-01-01&date_to=2024-12-31&l_id=294", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of jobs for a given process.\n\nJobs are always scoped to the parent process. Process visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https:\/\/wiki.mango.cloud\/) for details.)" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"MJ_ID\":3561788,\"MJ_ML_ID\":1512017,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"NONE\",\"MJ_MJT_ID\":\"050\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-31 21:03:49\",\"MJ_STOP\":null,\"MJ_DURATION\":169,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"PLANNED\",\"MJ_DESCRIPTION\":null,\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005861\",\"MJ_CREATED\":\"2026-04-10 12:48:26\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669744,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561788,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"lawrence.stracke@example.net\",\"MJA_RESPONSE_STATUS\":\"needsAction\",\"MJA_RESPONSE_NOTE\":null}]},{\"MJ_ID\":3561789,\"MJ_ML_ID\":1512018,\"MJ_ML_ORDER\":4,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK\",\"MJ_MJT_ID\":\"092\",\"MJ_MJK_ID\":null,\"MJ_START\":null,\"MJ_STOP\":null,\"MJ_DURATION\":78,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"DONE\",\"MJ_DESCRIPTION\":null,\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005862\",\"MJ_CREATED\":\"2026-01-18 09:27:26\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669745,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561789,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"brutherford@example.com\",\"MJA_RESPONSE_STATUS\":\"needsAction\",\"MJA_RESPONSE_NOTE\":null}]}]}", "name": "" } ] }, { "name": "Create Process Job", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/jobs", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/jobs", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"serman_id\":1,\"sg_id\":16,\"ml_order\":16,\"mjt_id\":16,\"mjk_id\":16,\"planning_policy\":\"LONGTIME\",\"start_time\":\"2026-03-20 08:00:00\",\"stop_time\":\"2026-03-20 10:00:00\",\"from_date\":\"2026-03-20\",\"from_mtb_id\":16,\"to_date\":\"2026-03-25\",\"to_mtb_id\":16,\"points\":5,\"duration\":60,\"recurrence\":\"architecto\",\"recurrence_hr\":\"architecto\",\"recurrence_data\":[\"architecto\"],\"recurrence_exceptions\":\"architecto\",\"linked_mj_id\":16,\"description\":\"Eius et animi quos velit et.\",\"note\":\"architecto\",\"attendees\":[[]],\"notifications\":[[]],\"private\":0,\"service_active_ids\":[16],\"auto_done\":0,\"auto_done_moment\":\"ON_START\",\"auto_done_action\":\"architecto\",\"customer_coop\":0,\"insert_payment\":16,\"ga_id\":16,\"ucp_id\":16,\"us_id\":16,\"ua_id\":16,\"street\":\"architecto\",\"house_id\":\"architecto\",\"zip\":\"architecto\",\"city\":\"architecto\",\"delay_accepted\":16,\"expedice\":0,\"prev_started\":16,\"prev_finished\":16,\"final_states\":\"architecto\",\"planning\":false}" }, "description": "Creates a new job for a process via maintenance_jobs_job_create stored procedure.\nRequired fields depend on planning_policy." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"MJ_ID\":3561790,\"MJ_ML_ID\":1512019,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK\",\"MJ_MJT_ID\":\"066\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-01-11 01:29:40\",\"MJ_STOP\":null,\"MJ_DURATION\":152,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"DONE\",\"MJ_DESCRIPTION\":\"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\",\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005863\",\"MJ_CREATED\":\"2026-04-28 20:21:12\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669746,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561790,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"ludie22@example.net\",\"MJA_RESPONSE_STATUS\":\"declined\",\"MJA_RESPONSE_NOTE\":null}]}}", "name": "" } ] }, { "name": "Update Process Job", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/jobs\/:job", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/jobs\/:job", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." }, { "id": "job", "key": "job", "value": "architecto", "description": "The job." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"state\":\"DONE\",\"action\":\"architecto\",\"task_note\":\"architecto\",\"real_finish_time\":\"architecto\",\"work_time\":16,\"l_id\":16,\"sg_id\":16,\"ml_order\":16,\"planning_policy\":\"architecto\",\"start_time\":\"2026-03-20 08:00:00\",\"stop_time\":\"2026-03-20 10:00:00\",\"from_date\":\"2026-03-20\",\"from_mtb_id\":16,\"to_date\":\"2026-03-25\",\"to_mtb_id\":16,\"points\":16,\"duration\":16,\"recurrence\":\"architecto\",\"recurrence_hr\":\"architecto\",\"recurrence_data\":[\"architecto\"],\"recurrence_exceptions\":\"architecto\",\"description\":\"Eius et animi quos velit et.\",\"note\":\"architecto\",\"attendees\":[[]],\"notifications\":[[]],\"private\":16,\"ga_id\":16,\"ucp_id\":16,\"us_id\":16,\"ua_id\":16,\"street\":\"architecto\",\"house_id\":\"architecto\",\"zip\":\"architecto\",\"city\":\"architecto\",\"expedice\":16,\"prev_started\":16,\"prev_finished\":16,\"final_states\":\"architecto\"}" }, "description": "Updates an existing job via maintenance_jobs_job_edit stored procedure.\n\nState changes (DONE, CANCELED) are performed via the state parameter." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"MJ_ID\":3561791,\"MJ_ML_ID\":1512020,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK\",\"MJ_MJT_ID\":\"066\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-01-11 01:29:40\",\"MJ_STOP\":null,\"MJ_DURATION\":152,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"DONE\",\"MJ_DESCRIPTION\":\"Harum mollitia modi deserunt aut ab provident perspiciatis quo.\",\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005864\",\"MJ_CREATED\":\"2026-04-28 20:21:12\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669747,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561791,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"earlene.cartwright@example.org\",\"MJA_RESPONSE_STATUS\":\"accepted\",\"MJA_RESPONSE_NOTE\":\"Tempora nulla in unde rerum voluptas ab maxime qui.\"}]}}", "name": "" } ] }, { "name": "List Process Jobs (cross-process)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/process-jobs", "query": [ { "key": "order", "value": "MJ_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: MJ_ID, MJ_DATE, MJ_START, MJ_CREATED, MJ_STATE.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated job IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated CT (installation) IDs", "disabled": false }, { "key": "process_ids", "value": "10%2C20", "description": "Filter by comma-separated parent process IDs", "disabled": false }, { "key": "serman_id", "value": "42", "description": "Filter by serviceman ID", "disabled": false }, { "key": "mjt_id", "value": "1%2C2", "description": "Filter by job type ID(s), comma-separated", "disabled": false }, { "key": "mjk_id", "value": "5%2C6", "description": "Filter by job kind\/category ID(s), comma-separated", "disabled": false }, { "key": "state", "value": "PLANNED", "description": "Filter by job state: PLANNED, DONE, CANCELED", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter jobs with MJ_DATE >= this date (inclusive)", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter jobs with MJ_DATE ", "disabled": false }, { "key": "l_id", "value": "294", "description": "Filter by creator (login) ID", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/process-jobs?order=MJ_ID%3Adesc&ids=1%2C2%2C3&cts=1%2C2%2C3&process_ids=10%2C20&serman_id=42&mjt_id=1%2C2&mjk_id=5%2C6&state=PLANNED&date_from=2024-01-01&date_to=2024-12-31&l_id=294" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of jobs across all processes the operator can see.\nSame per-process visibility rules as the nested route (`MAINTENANCE_LIST.VIEW`\nright; CT scope from X-CT or `?cts=` override).\n\nUse filters (`process_ids`, `serman_id`, `date_from`\/`date_to`, etc.) to narrow.\nFor jobs of a single known process, the nested route `\/processes\/{process}\/jobs`\nis equivalent \u2014 pick whichever is more natural for the caller." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"MJ_ID\":3561792,\"MJ_ML_ID\":1512021,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"NONE\",\"MJ_MJT_ID\":\"050\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-31 21:03:49\",\"MJ_STOP\":null,\"MJ_DURATION\":169,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"PLANNED\",\"MJ_DESCRIPTION\":null,\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005865\",\"MJ_CREATED\":\"2026-04-10 12:48:26\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669748,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561792,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"modesta58@example.net\",\"MJA_RESPONSE_STATUS\":\"accepted\",\"MJA_RESPONSE_NOTE\":\"Reiciendis quia perspiciatis deserunt ducimus corrupti et.\"}]},{\"MJ_ID\":3561793,\"MJ_ML_ID\":1512022,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK_RANGE\",\"MJ_MJT_ID\":\"100\",\"MJ_MJK_ID\":null,\"MJ_START\":null,\"MJ_STOP\":null,\"MJ_DURATION\":273,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"CANCELED\",\"MJ_DESCRIPTION\":\"Nesciunt ut ratione iure impedit molestiae ut rem.\",\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005866\",\"MJ_CREATED\":\"2026-04-20 14:14:05\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669749,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561793,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"brutherford@example.com\",\"MJA_RESPONSE_STATUS\":\"needsAction\",\"MJA_RESPONSE_NOTE\":null}]}]}", "name": "" } ] }, { "name": "Get Process Job", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/process-jobs\/:job", "query": [], "raw": "{{baseUrl}}\/api\/v3\/process-jobs\/:job", "variable": [ { "id": "job", "key": "job", "value": "6", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single job by ID. The operator must have visibility on the\nparent process; otherwise responds 404 (CT mismatch or rights gate)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"MJ_ID\":3561794,\"MJ_ML_ID\":1512023,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"NONE\",\"MJ_MJT_ID\":\"050\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-31 21:03:49\",\"MJ_STOP\":null,\"MJ_DURATION\":169,\"MJ_RECURRENCE\":null,\"MJ_CACHE_RECURRENCE_HR\":null,\"MJ_SERMAN_ID\":null,\"MJ_SG_ID\":null,\"MJ_STATE\":\"PLANNED\",\"MJ_DESCRIPTION\":null,\"MJ_NOTE\":null,\"MJ_PRIVATE\":0,\"MJ_DONE_TIME\":null,\"MJ_L_ID\":\"005867\",\"MJ_CREATED\":\"2026-04-10 12:48:26\",\"MJ_EDITED\":\"2026-08-12 16:54:53\",\"MJ_REAL_FINISH_TIME\":null,\"MJ_POINTS\":null,\"MJ_TIME_BLOCK_ID\":null,\"MJ_DATE\":null,\"MJ_FROM_DATE\":null,\"MJ_FROM_MTB_ID\":null,\"MJ_TO_DATE\":null,\"MJ_TO_MTB_ID\":null,\"MJ_LINKED_MJ_ID\":null,\"MJ_REAL_START_TIME\":null,\"MJ_AUTO_DONE\":0,\"MJ_AUTO_DONE_MOMENT\":null,\"MJ_AUTO_DONE_ACTION\":null,\"MJ_CUSTOMER_COOP\":0,\"MJ_INSERT_PAYMENT\":null,\"MJ_LAST_ACTION\":null,\"MJ_GA_ID\":null,\"MJ_UCP_ID\":null,\"MJ_US_ID\":null,\"MJ_UA_ID\":null,\"MJ_STREET\":null,\"MJ_HOUSE_ID\":null,\"MJ_ZIP\":null,\"MJ_CITY\":null,\"MJ_WORK_TIME\":null,\"MJ_CACHE_START\":null,\"MJ_CACHE_STOP\":null,\"MJ_CACHE_MAX_STOP\":null,\"MJ_EXPEDICE\":null,\"MJ_EXPEDANT_ID\":null,\"MJ_MJ_PREV_STARTED\":null,\"MJ_MJ_PREV_FINISHED\":null,\"MJ_PLANNING\":0,\"attendees\":[{\"MJA_ID\":1669750,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3561794,\"MJA_L_ID\":null,\"MJA_EMAIL\":\"lawrence.stracke@example.net\",\"MJA_RESPONSE_STATUS\":\"needsAction\",\"MJA_RESPONSE_NOTE\":null}]}}", "name": "" } ] } ] }, { "name": "Processes", "description": "", "item": [ { "name": "List Processes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "type", "value": "5", "description": "Filter by task type ID(s), comma-separated", "disabled": false }, { "key": "customer_id", "value": "100", "description": "Filter by customer user ID", "disabled": false }, { "key": "in_progress", "value": "true", "description": "Filter by in-progress master state (true = STATE_ID=2)", "disabled": false }, { "key": "substate", "value": "10%2C20", "description": "Filter by substate ID(s), comma-separated", "disabled": false }, { "key": "created_from", "value": "2024-01-01", "description": "Filter processes created from this date (inclusive)", "disabled": false }, { "key": "created_to", "value": "2024-12-31", "description": "Filter processes created to this date (inclusive)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/processes?ids=1%2C2%2C3&cts=1%2C2%2C3&type=5&customer_id=100&in_progress=true&substate=10%2C20&created_from=2024-01-01&created_to=2024-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of maintenance processes.\n\nProcess visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https:\/\/wiki.mango.cloud\/) for details.)\n\nAdd `?time_tracking=true` to include time tracking computed attributes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1512012,\"ML_SG_ID\":null,\"USER_ID\":null,\"STATE_ID\":\"03\",\"ML_MSS_ID\":null,\"ML_FINISH_MSS_ID\":null,\"SERMAN_ID\":null,\"CREATE_ID\":\"977\",\"ML_MTT_ID\":\"0000000081\",\"ML_NODEAVAIL_SGD_ID\":null,\"ML_MTT_STARTING_CODE\":null,\"ML_MTT_CODE\":null,\"NAME\":null,\"ML_CACHE_FULLNAME\":null,\"CREATION_TIME\":\"2026-03-29 10:26:27\",\"FINISH_TIME\":null,\"SOLVING_TIME\":null,\"PRE_FINISH_DATE\":null,\"CT\":\"79\",\"ML_HPC_ID\":null,\"ML_PRIORITY\":\"HIGH\",\"ML_N_ID\":null,\"ML_SA_ID\":null,\"ML_O_ID\":null,\"ML_DOCUMENT_TYPE\":null,\"ML_EXTERN_SOLVED\":0,\"ML_FINISH_MJ_ID\":null,\"ML_REQUIRE_DOC_SCAN\":0,\"ML_INSERT_PAYMENT\":null,\"ML_FINISH_NOTE\":null,\"ML_GA_ID\":null,\"ML_UCP_ID\":null,\"ML_PREV_ML_ID\":null,\"ML_OI_ID\":null,\"ML_US_ID\":null,\"ML_UA_ID\":null,\"ML_STREET\":null,\"ML_HOUSE_ID\":null,\"ML_ZIP\":null,\"ML_CITY\":null,\"ML_USER_CONTACT\":null,\"ML_ML_ID\":null,\"ML_DR_ID\":null,\"ML_DESC\":null,\"ML_DELAY_ACCEPTED\":null,\"ML_PLANNING_STRATEGY\":null,\"ML_CACHE_ADDRESS\":\"544 Aglae Ridge Apt. 067, Lefflerhaven\",\"ML_CONFIG_DATE\":\"2026-05-23 01:50:43\",\"ML_BULK\":0,\"ML_WAKE_TIME\":null,\"ML_SLA_ID\":null,\"ML_SLA_ACT\":\"\",\"ML_SLA_TIME\":null,\"ML_P_ID\":null,\"ML_UC_ID\":null,\"ML_CACHE_MTT_UNIQUE_ID\":25,\"ML_CACHE_MSS_UNIQUE_ID\":50,\"ML_CACHE_FULLNAME_SC\":null,\"params\":[{\"MP_ID\":15649556,\"MP_ML_ID\":1512012,\"MP_NAME\":\"JOB_START_TIME\",\"MP_VALUE\":\"Voluptatem laboriosam praesentium quis adipisci.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-04 16:36:51\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":563461,\"FA_DOC_ID\":1512012,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"deleniti distinctio eum\",\"FA_DESC\":\"Id aut libero aliquam veniam.\",\"FA_FILE_TYPE\":2,\"FA_FILE_SIZE\":null,\"FA_FILE_NAME\":\"noqitp.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-05-21 10:13:53\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]},{\"ID\":1512013,\"ML_SG_ID\":null,\"USER_ID\":null,\"STATE_ID\":\"05\",\"ML_MSS_ID\":null,\"ML_FINISH_MSS_ID\":null,\"SERMAN_ID\":null,\"CREATE_ID\":\"785\",\"ML_MTT_ID\":\"0000000080\",\"ML_NODEAVAIL_SGD_ID\":null,\"ML_MTT_STARTING_CODE\":null,\"ML_MTT_CODE\":null,\"NAME\":null,\"ML_CACHE_FULLNAME\":null,\"CREATION_TIME\":\"2026-01-23 09:22:21\",\"FINISH_TIME\":null,\"SOLVING_TIME\":null,\"PRE_FINISH_DATE\":null,\"CT\":\"16\",\"ML_HPC_ID\":null,\"ML_PRIORITY\":\"MEDIUM\",\"ML_N_ID\":null,\"ML_SA_ID\":null,\"ML_O_ID\":null,\"ML_DOCUMENT_TYPE\":null,\"ML_EXTERN_SOLVED\":0,\"ML_FINISH_MJ_ID\":null,\"ML_REQUIRE_DOC_SCAN\":0,\"ML_INSERT_PAYMENT\":null,\"ML_FINISH_NOTE\":null,\"ML_GA_ID\":null,\"ML_UCP_ID\":null,\"ML_PREV_ML_ID\":null,\"ML_OI_ID\":null,\"ML_US_ID\":null,\"ML_UA_ID\":null,\"ML_STREET\":null,\"ML_HOUSE_ID\":null,\"ML_ZIP\":null,\"ML_CITY\":null,\"ML_USER_CONTACT\":null,\"ML_ML_ID\":null,\"ML_DR_ID\":null,\"ML_DESC\":null,\"ML_DELAY_ACCEPTED\":null,\"ML_PLANNING_STRATEGY\":null,\"ML_CACHE_ADDRESS\":\"752 Brennon Tunnel, Port Roxanneview\",\"ML_CONFIG_DATE\":\"2026-06-24 19:17:46\",\"ML_BULK\":0,\"ML_WAKE_TIME\":null,\"ML_SLA_ID\":null,\"ML_SLA_ACT\":\"\",\"ML_SLA_TIME\":null,\"ML_P_ID\":null,\"ML_UC_ID\":null,\"ML_CACHE_MTT_UNIQUE_ID\":98,\"ML_CACHE_MSS_UNIQUE_ID\":60,\"ML_CACHE_FULLNAME_SC\":null,\"params\":[{\"MP_ID\":15649557,\"MP_ML_ID\":1512013,\"MP_NAME\":\"TERM\",\"MP_VALUE\":\"Assumenda et tenetur ab reiciendis quia.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-06-25 09:53:03\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":563462,\"FA_DOC_ID\":1512013,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"ducimus corrupti et\",\"FA_DESC\":\"Quia maiores assumenda odit.\",\"FA_FILE_TYPE\":null,\"FA_FILE_SIZE\":2227,\"FA_FILE_NAME\":\"tvnbob.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-04-08 11:35:20\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]}]}", "name": "" } ] }, { "name": "Create Process", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"type_id\":5,\"name\":\"Network installation\",\"priority\":\"MEDIUM\",\"description\":\"Eius et animi quos velit et.\",\"customer_id\":100,\"creation_time\":\"2024-01-15 10:00:00\",\"ml_desc\":\"architecto\",\"premise_id\":16,\"uc_id\":16,\"user_contact\":\"architecto\",\"bulk\":16,\"sla_id\":16,\"group_task\":16,\"params\":[[]]}" }, "description": "Creates a new maintenance process via maintenance_task_create stored procedure." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"ID\":1512014,\"ML_SG_ID\":null,\"USER_ID\":null,\"STATE_ID\":\"01\",\"ML_MSS_ID\":null,\"ML_FINISH_MSS_ID\":null,\"SERMAN_ID\":null,\"CREATE_ID\":\"225\",\"ML_MTT_ID\":\"0000000076\",\"ML_NODEAVAIL_SGD_ID\":null,\"ML_MTT_STARTING_CODE\":null,\"ML_MTT_CODE\":null,\"NAME\":null,\"ML_CACHE_FULLNAME\":null,\"CREATION_TIME\":\"2026-01-11 01:29:40\",\"FINISH_TIME\":null,\"SOLVING_TIME\":null,\"PRE_FINISH_DATE\":null,\"CT\":\"43\",\"ML_HPC_ID\":null,\"ML_PRIORITY\":\"MEDIUM\",\"ML_N_ID\":null,\"ML_SA_ID\":null,\"ML_O_ID\":null,\"ML_DOCUMENT_TYPE\":null,\"ML_EXTERN_SOLVED\":0,\"ML_FINISH_MJ_ID\":null,\"ML_REQUIRE_DOC_SCAN\":0,\"ML_INSERT_PAYMENT\":null,\"ML_FINISH_NOTE\":null,\"ML_GA_ID\":null,\"ML_UCP_ID\":null,\"ML_PREV_ML_ID\":null,\"ML_OI_ID\":null,\"ML_US_ID\":null,\"ML_UA_ID\":null,\"ML_STREET\":null,\"ML_HOUSE_ID\":null,\"ML_ZIP\":null,\"ML_CITY\":null,\"ML_USER_CONTACT\":null,\"ML_ML_ID\":null,\"ML_DR_ID\":null,\"ML_DESC\":null,\"ML_DELAY_ACCEPTED\":null,\"ML_PLANNING_STRATEGY\":null,\"ML_CACHE_ADDRESS\":\"26343 Cecil Expressway Apt. 748, Gilbertstad\",\"ML_CONFIG_DATE\":\"2026-03-19 23:54:06\",\"ML_BULK\":0,\"ML_WAKE_TIME\":null,\"ML_SLA_ID\":null,\"ML_SLA_ACT\":\"\",\"ML_SLA_TIME\":null,\"ML_P_ID\":null,\"ML_UC_ID\":null,\"ML_CACHE_MTT_UNIQUE_ID\":72,\"ML_CACHE_MSS_UNIQUE_ID\":7,\"ML_CACHE_FULLNAME_SC\":null,\"params\":[{\"MP_ID\":15649558,\"MP_ML_ID\":1512014,\"MP_NAME\":\"SALESMAN\",\"MP_VALUE\":\"Qui commodi incidunt iure odit.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-04-10 12:48:26\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":563463,\"FA_DOC_ID\":1512014,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"modi ipsum nostrum\",\"FA_DESC\":\"Autem et consequatur aut dolores enim non facere tempora.\",\"FA_FILE_TYPE\":2,\"FA_FILE_SIZE\":2317,\"FA_FILE_NAME\":\"vlxjkl.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-04-04 15:10:02\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]}}", "name": "" } ] }, { "name": "Get Process", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the process." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single maintenance process by ID.\n\nProcess visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https:\/\/wiki.mango.cloud\/) for details.)\n" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1512015,\"ML_SG_ID\":null,\"USER_ID\":null,\"STATE_ID\":\"03\",\"ML_MSS_ID\":null,\"ML_FINISH_MSS_ID\":null,\"SERMAN_ID\":null,\"CREATE_ID\":\"977\",\"ML_MTT_ID\":\"0000000081\",\"ML_NODEAVAIL_SGD_ID\":null,\"ML_MTT_STARTING_CODE\":null,\"ML_MTT_CODE\":null,\"NAME\":null,\"ML_CACHE_FULLNAME\":null,\"CREATION_TIME\":\"2026-03-29 10:26:27\",\"FINISH_TIME\":null,\"SOLVING_TIME\":null,\"PRE_FINISH_DATE\":null,\"CT\":\"79\",\"ML_HPC_ID\":null,\"ML_PRIORITY\":\"HIGH\",\"ML_N_ID\":null,\"ML_SA_ID\":null,\"ML_O_ID\":null,\"ML_DOCUMENT_TYPE\":null,\"ML_EXTERN_SOLVED\":0,\"ML_FINISH_MJ_ID\":null,\"ML_REQUIRE_DOC_SCAN\":0,\"ML_INSERT_PAYMENT\":null,\"ML_FINISH_NOTE\":null,\"ML_GA_ID\":null,\"ML_UCP_ID\":null,\"ML_PREV_ML_ID\":null,\"ML_OI_ID\":null,\"ML_US_ID\":null,\"ML_UA_ID\":null,\"ML_STREET\":null,\"ML_HOUSE_ID\":null,\"ML_ZIP\":null,\"ML_CITY\":null,\"ML_USER_CONTACT\":null,\"ML_ML_ID\":null,\"ML_DR_ID\":null,\"ML_DESC\":null,\"ML_DELAY_ACCEPTED\":null,\"ML_PLANNING_STRATEGY\":null,\"ML_CACHE_ADDRESS\":\"544 Aglae Ridge Apt. 067, Lefflerhaven\",\"ML_CONFIG_DATE\":\"2026-05-23 01:50:43\",\"ML_BULK\":0,\"ML_WAKE_TIME\":null,\"ML_SLA_ID\":null,\"ML_SLA_ACT\":\"\",\"ML_SLA_TIME\":null,\"ML_P_ID\":null,\"ML_UC_ID\":null,\"ML_CACHE_MTT_UNIQUE_ID\":25,\"ML_CACHE_MSS_UNIQUE_ID\":50,\"ML_CACHE_FULLNAME_SC\":null,\"params\":[{\"MP_ID\":15649559,\"MP_ML_ID\":1512015,\"MP_NAME\":\"JOB_START_TIME\",\"MP_VALUE\":\"Voluptatem laboriosam praesentium quis adipisci.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-04 16:36:51\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":563464,\"FA_DOC_ID\":1512015,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"deleniti distinctio eum\",\"FA_DESC\":\"Id aut libero aliquam veniam.\",\"FA_FILE_TYPE\":2,\"FA_FILE_SIZE\":null,\"FA_FILE_NAME\":\"noqitp.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-05-21 10:13:53\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]}}", "name": "" } ] }, { "name": "Update Process", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the process." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"type_id\":5,\"name\":\"Network installation\",\"priority\":\"MEDIUM\",\"description\":\"Eius et animi quos velit et.\",\"customer_id\":100,\"ml_desc\":\"architecto\",\"premise_id\":16,\"uc_id\":16,\"user_contact\":\"architecto\",\"state_change\":16,\"bulk\":16,\"sla_id\":16,\"group_task\":16,\"params\":[[]]}" }, "description": "Updates an existing maintenance process via maintenance_task_edit stored procedure." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1512016,\"ML_SG_ID\":null,\"USER_ID\":null,\"STATE_ID\":\"01\",\"ML_MSS_ID\":null,\"ML_FINISH_MSS_ID\":null,\"SERMAN_ID\":null,\"CREATE_ID\":\"225\",\"ML_MTT_ID\":\"0000000076\",\"ML_NODEAVAIL_SGD_ID\":null,\"ML_MTT_STARTING_CODE\":null,\"ML_MTT_CODE\":null,\"NAME\":null,\"ML_CACHE_FULLNAME\":null,\"CREATION_TIME\":\"2026-01-11 01:29:40\",\"FINISH_TIME\":null,\"SOLVING_TIME\":null,\"PRE_FINISH_DATE\":null,\"CT\":\"43\",\"ML_HPC_ID\":null,\"ML_PRIORITY\":\"MEDIUM\",\"ML_N_ID\":null,\"ML_SA_ID\":null,\"ML_O_ID\":null,\"ML_DOCUMENT_TYPE\":null,\"ML_EXTERN_SOLVED\":0,\"ML_FINISH_MJ_ID\":null,\"ML_REQUIRE_DOC_SCAN\":0,\"ML_INSERT_PAYMENT\":null,\"ML_FINISH_NOTE\":null,\"ML_GA_ID\":null,\"ML_UCP_ID\":null,\"ML_PREV_ML_ID\":null,\"ML_OI_ID\":null,\"ML_US_ID\":null,\"ML_UA_ID\":null,\"ML_STREET\":null,\"ML_HOUSE_ID\":null,\"ML_ZIP\":null,\"ML_CITY\":null,\"ML_USER_CONTACT\":null,\"ML_ML_ID\":null,\"ML_DR_ID\":null,\"ML_DESC\":null,\"ML_DELAY_ACCEPTED\":null,\"ML_PLANNING_STRATEGY\":null,\"ML_CACHE_ADDRESS\":\"26343 Cecil Expressway Apt. 748, Gilbertstad\",\"ML_CONFIG_DATE\":\"2026-03-19 23:54:06\",\"ML_BULK\":0,\"ML_WAKE_TIME\":null,\"ML_SLA_ID\":null,\"ML_SLA_ACT\":\"\",\"ML_SLA_TIME\":null,\"ML_P_ID\":null,\"ML_UC_ID\":null,\"ML_CACHE_MTT_UNIQUE_ID\":72,\"ML_CACHE_MSS_UNIQUE_ID\":7,\"ML_CACHE_FULLNAME_SC\":null,\"params\":[{\"MP_ID\":15649560,\"MP_ML_ID\":1512016,\"MP_NAME\":\"SALESMAN\",\"MP_VALUE\":\"Qui commodi incidunt iure odit.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-04-10 12:48:26\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":563465,\"FA_DOC_ID\":1512016,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"modi ipsum nostrum\",\"FA_DESC\":\"Autem et consequatur aut dolores enim non facere tempora.\",\"FA_FILE_TYPE\":2,\"FA_FILE_SIZE\":2317,\"FA_FILE_NAME\":\"vlxjkl.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-04-04 15:10:02\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]}}", "name": "" } ] }, { "name": "Delete Process (State Change)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:id", "variable": [ { "id": "id", "key": "id", "value": "3", "description": "The ID of the process." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"transition_id\":84}" }, "description": "Performs a substate transition on a process via maintenance_task_change_substate.\nRequires transition_id in the request body." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "Download Process Attachment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/attachments\/:attachment\/download", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/attachments\/:attachment\/download", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." }, { "id": "attachment", "key": "attachment", "value": "architecto", "description": "The attachment." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Downloads a file attachment belonging to a process." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "vary", "value": "Origin" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Upload Process Attachment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/attachments", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/attachments", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "Invoice", "type": "text", "description": "Display name (FA_NAME). Defaults to empty if omitted. Mango stores up to 50 chars." }, { "key": "desc", "value": "Q1 2026", "type": "text", "description": "Description (FA_DESC). Up to 100 chars." }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Uploads a new file attachment to a process.\n\nMultipart `Content-Type: multipart\/form-data`. The `file` field is required; `name` and `desc`\nare optional display metadata. The on-disk filename (`FA_FILE_NAME`) is derived from the upload's\nclient-original name; use the PATCH endpoint to rename later.\n\nPer-process visibility rules apply: `MAINTENANCE_LIST.VIEW` right on the target process is enough\nto upload (matching the existing download endpoint's authorization model)." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"FA_ID\":563466,\"FA_DOC_ID\":2041,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"eius et animi\",\"FA_DESC\":\"Velit et fugiat sunt nihil accusantium.\",\"FA_FILE_TYPE\":1,\"FA_FILE_SIZE\":null,\"FA_FILE_NAME\":\"hwaykc.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-04-28 20:21:12\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}}", "name": "" } ] }, { "name": "Update Process Attachment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/attachments\/:attachment", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/attachments\/:attachment", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." }, { "id": "attachment", "key": "attachment", "value": "564", "description": "The attachment." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Invoice\",\"desc\":\"Q1 2026\",\"file_name\":\"invoice.pdf\",\"file_name_conflict\":\"ERROR\"}" }, "description": "Updates a file attachment's metadata or filename.\n\nAccepts any combination of `name` (display label, FA_NAME), `desc` (FA_DESC), and `file_name`\n(the on-disk filename, FA_FILE_NAME). At least one must be supplied. When `file_name` is\nsupplied, `file_name_conflict` controls how a name collision with another attachment on the\nsame process is resolved: `ERROR` (default), `RENAME` (auto-suffix `(N)`), `OVERWRITE` (soft-\ndelete the conflicting row).\n\nPer-process `MAINTENANCE_LIST.VIEW` is required." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"FA_ID\":563467,\"FA_DOC_ID\":2878,\"FA_DOC_TYPE\":\"maintenance\",\"FA_NAME\":\"adipisci quidem nostrum\",\"FA_DESC\":\"Commodi incidunt iure odit.\",\"FA_FILE_TYPE\":2,\"FA_FILE_SIZE\":5053,\"FA_FILE_NAME\":\"pscqld.pdf\",\"FA_DELETED\":null,\"FA_CREATED\":\"2026-01-20 16:21:39\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}}", "name": "" } ] }, { "name": "Delete Process Attachment", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/attachments\/:attachment", "query": [], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/attachments\/:attachment", "variable": [ { "id": "process", "key": "process", "value": "3", "description": "The process." }, { "id": "attachment", "key": "attachment", "value": "564", "description": "The attachment." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Soft-deletes a process attachment (sets `FA_DELETED=1`). The file on disk is not removed.\n\nPer-process `MAINTENANCE_LIST.VIEW` is required, plus the Mango `FILE_ATTACHMENT.DELETE` SP-level right." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Reminders", "description": "", "item": [ { "name": "List Debt Recovery Processes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/debt-recovery-processes", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated debt recovery process IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "345", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "state", "value": "IN_PROGRESS%2CBLOCKED", "description": "Filter by process state. Accepts comma-separated values.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/debt-recovery-processes?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=345&state=IN_PROGRESS%2CBLOCKED" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of debt recovery processes.\n **At least one** of the following filters must be provided:\n `customer`, `state`.\n Without a narrowing filter the endpoint returns HTTP 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"DR_ID\":512148,\"DR_U_ID\":2878,\"DR_START\":\"2024-12-01 06:49:47\",\"DR_STATE\":\"BLOCKED\",\"DR_ORDER\":3,\"DR_PROVISIONING\":0,\"DR_END\":null,\"DR_SUSPENDED_TO\":null,\"DR_UNBLOCK_FEE\":0,\"DR_CHANGED\":null,\"DR_L_ID\":null},{\"DR_ID\":512149,\"DR_U_ID\":5485,\"DR_START\":\"2025-01-14 22:16:13\",\"DR_STATE\":\"SUSPENDED\",\"DR_ORDER\":5,\"DR_PROVISIONING\":1,\"DR_END\":null,\"DR_SUSPENDED_TO\":null,\"DR_UNBLOCK_FEE\":0,\"DR_CHANGED\":null,\"DR_L_ID\":null}]}", "name": "" } ] }, { "name": "Get Debt Recovery Process", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/debt-recovery-processes\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/debt-recovery-processes\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the debt recovery process." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single debt recovery process by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"DR_ID\":512150,\"DR_U_ID\":2878,\"DR_START\":\"2024-12-01 06:49:47\",\"DR_STATE\":\"BLOCKED\",\"DR_ORDER\":3,\"DR_PROVISIONING\":0,\"DR_END\":null,\"DR_SUSPENDED_TO\":null,\"DR_UNBLOCK_FEE\":0,\"DR_CHANGED\":null,\"DR_L_ID\":null}}", "name": "" } ] }, { "name": "List Reminder Batches", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/reminder-batches", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated batch IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter batches created on or after this date (YYYY-MM-DD). Applies to RHB_DATE.", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter batches created on or before this date (YYYY-MM-DD). Applies to RHB_DATE.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/reminder-batches?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&date_from=2024-01-01&date_to=2024-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of reminder batches.\n **At least one** of the following filters must be provided:\n `date_from`, `date_to`.\n Without a narrowing filter the endpoint returns HTTP 422.\n Reminders within batches are NOT loaded in the list \u2014 use the detail endpoint." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"RHB_ID\":5784,\"RHB_BATCH\":592,\"RHB_ML_ID\":null,\"RHB_MJ_ID\":null,\"RHB_TYPE\":\"REMINDER\",\"RHB_DATE\":null,\"RHB_FINAL_DATE\":null,\"RHB_LAST_REM_DATE\":null,\"RHB_DUE_DAYS\":null,\"RHB_DUE_DATE\":null,\"RHB_DUE_DATE1\":null,\"RHB_DUE_DATE2\":null,\"RHB_TAX_DATE1\":null,\"RHB_TAX_DATE2\":null,\"RHB_ADDRESS\":null,\"RHB_U_FILTER\":null,\"RHB_NOTAX\":null,\"RHB_GROUP\":null,\"RHB_DEBTFROM\":null,\"RHB_DEBTTO\":null,\"RHB_NOTE\":null,\"RHB_CREATOR\":null,\"RHB_CREATED\":null},{\"RHB_ID\":5785,\"RHB_BATCH\":339,\"RHB_ML_ID\":null,\"RHB_MJ_ID\":null,\"RHB_TYPE\":\"REMINDER\",\"RHB_DATE\":null,\"RHB_FINAL_DATE\":null,\"RHB_LAST_REM_DATE\":null,\"RHB_DUE_DAYS\":null,\"RHB_DUE_DATE\":null,\"RHB_DUE_DATE1\":null,\"RHB_DUE_DATE2\":null,\"RHB_TAX_DATE1\":null,\"RHB_TAX_DATE2\":null,\"RHB_ADDRESS\":null,\"RHB_U_FILTER\":null,\"RHB_NOTAX\":null,\"RHB_GROUP\":null,\"RHB_DEBTFROM\":null,\"RHB_DEBTTO\":null,\"RHB_NOTE\":null,\"RHB_CREATOR\":null,\"RHB_CREATED\":null}]}", "name": "" } ] }, { "name": "Get Reminder Batch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/reminder-batches\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/reminder-batches\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the reminder batch." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single reminder batch by ID.\n Includes the `reminders` relation (loaded only in this detail view)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"RHB_ID\":5786,\"RHB_BATCH\":592,\"RHB_ML_ID\":null,\"RHB_MJ_ID\":null,\"RHB_TYPE\":\"REMINDER\",\"RHB_DATE\":null,\"RHB_FINAL_DATE\":null,\"RHB_LAST_REM_DATE\":null,\"RHB_DUE_DAYS\":null,\"RHB_DUE_DATE\":null,\"RHB_DUE_DATE1\":null,\"RHB_DUE_DATE2\":null,\"RHB_TAX_DATE1\":null,\"RHB_TAX_DATE2\":null,\"RHB_ADDRESS\":null,\"RHB_U_FILTER\":null,\"RHB_NOTAX\":null,\"RHB_GROUP\":null,\"RHB_DEBTFROM\":null,\"RHB_DEBTTO\":null,\"RHB_NOTE\":null,\"RHB_CREATOR\":null,\"RHB_CREATED\":null,\"reminders\":[{\"ID\":1890187,\"RH_DOC_ID\":80304,\"USER_ID\":2617,\"DATE_REMIND\":\"2010-05-22\",\"NOTE\":0,\"CT\":40,\"SEND_NOTE\":null,\"RH_ORDER\":1,\"RH_AUTHOR\":274,\"RH_CREATED\":null,\"RH_FINAL_DATE\":null,\"RH_NOTE\":null,\"RH_RHB_ID\":5786,\"RH_DATE_ACK\":null,\"RH_DR_ID\":null,\"RH_PROVIDER_USER_ID\":null}]}}", "name": "" } ] }, { "name": "List Reminders", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/reminders", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated reminder IDs.", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "customer", "value": "345", "description": "Filter by customer (user) ID.", "disabled": false }, { "key": "batch", "value": "100", "description": "Filter by reminder batch ID.", "disabled": false }, { "key": "debt_recovery", "value": "50", "description": "Filter by debt recovery process ID.", "disabled": false }, { "key": "provider", "value": "200", "description": "Filter by provider (user) ID.", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter reminders issued on or after this date (YYYY-MM-DD). Applies to DATE_REMIND.", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter reminders issued on or before this date (YYYY-MM-DD). Applies to DATE_REMIND.", "disabled": false }, { "key": "order", "value": "1", "description": "Filter by reminder sequence number (1st, 2nd, etc.).", "disabled": false }, { "key": "year", "value": "2024", "description": "Filter by year extracted from DATE_REMIND.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/reminders?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&customer=345&batch=100&debt_recovery=50&provider=200&date_from=2024-01-01&date_to=2024-12-31&order=1&year=2024" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of reminders with computed financial data and line items.\n **At least one** of the following filters must be provided:\n `customer`, `batch`, `date_from`, `year`.\n Without a narrowing filter the endpoint returns HTTP 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1890188,\"RH_DOC_ID\":79198,\"USER_ID\":2839,\"DATE_REMIND\":\"2006-05-29\",\"NOTE\":0,\"CT\":43,\"SEND_NOTE\":null,\"RH_ORDER\":2,\"RH_AUTHOR\":481,\"RH_CREATED\":null,\"RH_FINAL_DATE\":null,\"RH_NOTE\":null,\"RH_RHB_ID\":null,\"RH_DATE_ACK\":null,\"RH_DR_ID\":null,\"RH_PROVIDER_USER_ID\":null,\"items\":[{\"ID\":4238640,\"ID_REMIND\":1890188,\"AMOUNT\":\"2045.3884\",\"MONTH\":\"12\",\"YEAR\":\"2021\",\"USER_SERVICE_ID\":1839,\"RB_PAID\":\"4426.6266\",\"RB_MATURITY\":null,\"RB_DELAY\":null,\"RB_ITD_ID\":35644,\"RB_ITD_ADVANCE_ID\":0,\"RB_SA_BASE_ID\":null}]},{\"ID\":1890189,\"RH_DOC_ID\":8317,\"USER_ID\":7018,\"DATE_REMIND\":\"2009-07-27\",\"NOTE\":0,\"CT\":38,\"SEND_NOTE\":null,\"RH_ORDER\":2,\"RH_AUTHOR\":94,\"RH_CREATED\":null,\"RH_FINAL_DATE\":null,\"RH_NOTE\":null,\"RH_RHB_ID\":null,\"RH_DATE_ACK\":null,\"RH_DR_ID\":null,\"RH_PROVIDER_USER_ID\":null,\"items\":[{\"ID\":4238641,\"ID_REMIND\":1890189,\"AMOUNT\":\"2384.8442\",\"MONTH\":\"02\",\"YEAR\":\"2020\",\"USER_SERVICE_ID\":5040,\"RB_PAID\":\"3688.2401\",\"RB_MATURITY\":null,\"RB_DELAY\":null,\"RB_ITD_ID\":20535,\"RB_ITD_ADVANCE_ID\":0,\"RB_SA_BASE_ID\":null}]}]}", "name": "" } ] }, { "name": "Get Reminder", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/reminders\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/reminders\/:id", "variable": [ { "id": "id", "key": "id", "value": "1732", "description": "The ID of the reminder." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single reminder by ID with computed financial data and line items." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1890190,\"RH_DOC_ID\":79198,\"USER_ID\":2839,\"DATE_REMIND\":\"2006-05-29\",\"NOTE\":0,\"CT\":43,\"SEND_NOTE\":null,\"RH_ORDER\":2,\"RH_AUTHOR\":481,\"RH_CREATED\":null,\"RH_FINAL_DATE\":null,\"RH_NOTE\":null,\"RH_RHB_ID\":null,\"RH_DATE_ACK\":null,\"RH_DR_ID\":null,\"RH_PROVIDER_USER_ID\":null,\"items\":[{\"ID\":4238642,\"ID_REMIND\":1890190,\"AMOUNT\":\"2045.3884\",\"MONTH\":\"12\",\"YEAR\":\"2021\",\"USER_SERVICE_ID\":1839,\"RB_PAID\":\"4426.6266\",\"RB_MATURITY\":null,\"RB_DELAY\":null,\"RB_ITD_ID\":35644,\"RB_ITD_ADVANCE_ID\":0,\"RB_SA_BASE_ID\":null}]}}", "name": "" } ] } ] }, { "name": "Right Definitions", "description": "", "item": [ { "name": "List Right Definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/rights-definitions", "query": [ { "key": "per_page", "value": "15", "description": "Number of results per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated right definition IDs.", "disabled": false }, { "key": "search", "value": "MODULE", "description": "Search in right name (RD_NAME).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/rights-definitions?per_page=15&page=1&ids=1%2C2%2C3&search=MODULE" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of all right definitions (global codelist).\nNo CT or partner scoping \u2014 this is a system-wide catalogue of available rights." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"RD_ID\":3719,\"RD_NAME\":\"adipisci-quidem-nostrum\",\"RD_LEVEL\":10,\"RD_ROLES_ACCESS\":1,\"RD_DISTINCT\":1,\"RD_TYPE\":\"MODULE\",\"RD_DOMAIN\":null,\"RD_SETTING\":0,\"RD_CATEGORY\":\"OTHER\"},{\"RD_ID\":3720,\"RD_NAME\":\"omnis-autem\",\"RD_LEVEL\":10,\"RD_ROLES_ACCESS\":1,\"RD_DISTINCT\":1,\"RD_TYPE\":\"SELECT\",\"RD_DOMAIN\":null,\"RD_SETTING\":0,\"RD_CATEGORY\":\"OTHER\"}]}", "name": "" } ] } ] }, { "name": "SIPO", "description": "", "item": [ { "name": "List SIPO Contracts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sipo-contracts", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated contract IDs.", "disabled": false }, { "key": "cts", "value": "12%2C14", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "collection_type", "value": "SIPO", "description": "Filter by collection type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/sipo-contracts?per_page=10&page=1&ids=1%2C2%2C3&cts=12%2C14&collection_type=SIPO" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of SIPO \/ INKASO collection contracts.\n Each contract includes its assigned business locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SCL_ID\":100,\"SCL_ORGNUM\":857680,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":948,\"SCL_LIMIT_DAY\":26,\"SCL_NOTE\":\"Qui commodi incidunt iure odit.\",\"SCL_CP_ID\":60,\"SCL_COLLECTION_TYPE\":\"SIPO\",\"SCL_MATURITY\":45,\"SCL_CREATED\":\"2026-03-27 21:23:39\",\"SCL_CREATE_L_ID\":247,\"locations\":[{\"SCLL_ID\":189,\"SCLL_SCL_ID\":100,\"SCLL_CT\":211,\"SCLL_PROVIDER_USER_ID\":null}]},{\"SCL_ID\":101,\"SCL_ORGNUM\":469606,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":1049,\"SCL_LIMIT_DAY\":16,\"SCL_NOTE\":\"Dolores enim non facere tempora.\",\"SCL_CP_ID\":118,\"SCL_COLLECTION_TYPE\":\"FETCH\",\"SCL_MATURITY\":51,\"SCL_CREATED\":\"2026-03-30 09:59:15\",\"SCL_CREATE_L_ID\":292,\"locations\":[{\"SCLL_ID\":190,\"SCLL_SCL_ID\":101,\"SCLL_CT\":44,\"SCLL_PROVIDER_USER_ID\":89143}]}]}", "name": "" } ] }, { "name": "Get SIPO Contract", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sipo-contracts\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/sipo-contracts\/:id", "variable": [ { "id": "id", "key": "id", "value": "13", "description": "The ID of the sipo contract." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single SIPO \/ INKASO collection contract by ID,\n including its assigned business locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SCL_ID\":102,\"SCL_ORGNUM\":857680,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":550,\"SCL_LIMIT_DAY\":26,\"SCL_NOTE\":\"Qui commodi incidunt iure odit.\",\"SCL_CP_ID\":5,\"SCL_COLLECTION_TYPE\":\"SIPO\",\"SCL_MATURITY\":45,\"SCL_CREATED\":\"2026-03-27 21:23:39\",\"SCL_CREATE_L_ID\":247,\"locations\":[{\"SCLL_ID\":191,\"SCLL_SCL_ID\":102,\"SCLL_CT\":101,\"SCLL_PROVIDER_USER_ID\":null}]}}", "name": "" } ] }, { "name": "List SIPO Lists", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sipo-lists", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "100%2C200", "description": "Filter by comma-separated SIPO list IDs.", "disabled": false }, { "key": "cts", "value": "12%2C14", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "contract", "value": "1", "description": "Filter by contract ID (SL_SCL_ID).", "disabled": false }, { "key": "year", "value": "2024", "description": "Filter by year.", "disabled": false }, { "key": "month", "value": "6", "description": "Filter by month (1\u201312).", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter lists on or after this date (YYYY-MM-DD).", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter lists on or before this date (YYYY-MM-DD).", "disabled": false }, { "key": "collection_type", "value": "SIPO", "description": "Filter by collection type.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/sipo-lists?per_page=10&page=1&ids=100%2C200&cts=12%2C14&contract=1&year=2024&month=6&date_from=2024-01-01&date_to=2024-12-31&collection_type=SIPO" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of generated SIPO \/ INKASO prescription lists." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SL_ID\":21660,\"SL_DATE\":\"1981-07-29\",\"SL_MONTH\":1,\"SL_YEAR\":2024,\"SL_CT\":556,\"SL_CREATION\":\"2026-03-31 20:58:33\",\"SL_AUTHOR\":5485,\"SL_TYPE\":\"FULL\",\"SL_SCL_ID\":null,\"SL_COLLECTION_TYPE\":\"SIPO\",\"SL_DUE_DATE\":null,\"SL_PA_ID\":1839,\"SL_DATE_M\":\"1971-11-16\",\"SL_PROVIDER_USER_ID\":null},{\"SL_ID\":21661,\"SL_DATE\":\"2018-07-27\",\"SL_MONTH\":7,\"SL_YEAR\":2021,\"SL_CT\":383,\"SL_CREATION\":\"2026-01-22 20:46:15\",\"SL_AUTHOR\":4639,\"SL_TYPE\":\"FULL\",\"SL_SCL_ID\":null,\"SL_COLLECTION_TYPE\":\"FETCH\",\"SL_DUE_DATE\":\"2020-03-13\",\"SL_PA_ID\":null,\"SL_DATE_M\":\"2023-08-06\",\"SL_PROVIDER_USER_ID\":79168}]}", "name": "" } ] }, { "name": "Get SIPO List", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sipo-lists\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/sipo-lists\/:id", "variable": [ { "id": "id", "key": "id", "value": "15", "description": "The ID of the sipo list." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a single SIPO \/ INKASO prescription list by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SL_ID\":21662,\"SL_DATE\":\"1981-07-29\",\"SL_MONTH\":1,\"SL_YEAR\":2024,\"SL_CT\":556,\"SL_CREATION\":\"2026-03-31 20:58:33\",\"SL_AUTHOR\":5485,\"SL_TYPE\":\"FULL\",\"SL_SCL_ID\":null,\"SL_COLLECTION_TYPE\":\"SIPO\",\"SL_DUE_DATE\":null,\"SL_PA_ID\":1839,\"SL_DATE_M\":\"1971-11-16\",\"SL_PROVIDER_USER_ID\":null}}", "name": "" } ] }, { "name": "List SIPO Items", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/sipo-items", "query": [ { "key": "per_page", "value": "10", "description": "Number of items per page.", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1000%2C2000", "description": "Filter by comma-separated item IDs.", "disabled": false }, { "key": "cts", "value": "12%2C14", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "sipo_list", "value": "100", "description": "Filter by SIPO list ID. **At least one** of `sipo_list` or `customer` is required.", "disabled": false }, { "key": "customer", "value": "345", "description": "Filter by customer (user) ID. **At least one** of `sipo_list` or `customer` is required.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/sipo-items?per_page=10&page=1&ids=1000%2C2000&cts=12%2C14&sipo_list=100&customer=345" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns a paginated list of SIPO \/ INKASO prescription line items.\n **At least one** of the following filters must be provided:\n `sipo_list`, `customer`.\n Without a narrowing filter the endpoint returns HTTP 422." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SD_ID\":10196795,\"SD_SL_ID\":5033,\"SD_USER_ID\":438908,\"SD_SIPO_NUM\":null,\"SD_SIPO_CODE\":\"wp\",\"SD_PRICE\":\"66203084.7019\",\"SD_EXPORT_TYPE\":\"Z\",\"SD_TYPE\":709,\"SD_TEXT\":null,\"SD_ACC_PRE_NUMBER\":null,\"SD_ACC_NUMBER\":null,\"SD_ACC_BANK\":null,\"SD_ACC_SPECSYM\":null,\"SD_MATURITY\":\"1989-10-07\",\"SD_EU\":null,\"SD_TAX\":null,\"SD_PAY\":null,\"SD_TAX_ACTUAL\":null,\"SD_FUNDS_IN_TRANSIT\":null,\"SD_OVERPAYMENT\":null},{\"SD_ID\":10196796,\"SD_SL_ID\":18631,\"SD_USER_ID\":339005,\"SD_SIPO_NUM\":3390204808,\"SD_SIPO_CODE\":\"cp\",\"SD_PRICE\":\"54565323.4621\",\"SD_EXPORT_TYPE\":\"N\",\"SD_TYPE\":null,\"SD_TEXT\":null,\"SD_ACC_PRE_NUMBER\":null,\"SD_ACC_NUMBER\":null,\"SD_ACC_BANK\":null,\"SD_ACC_SPECSYM\":null,\"SD_MATURITY\":\"2019-08-30\",\"SD_EU\":null,\"SD_TAX\":null,\"SD_PAY\":null,\"SD_TAX_ACTUAL\":null,\"SD_FUNDS_IN_TRANSIT\":null,\"SD_OVERPAYMENT\":null}]}", "name": "" } ] } ] }, { "name": "Service Definitions", "description": "", "item": [ { "name": "List Service Definitions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-definitions", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "disabled", "value": "true", "description": "Filter by disabled status. When true, return only disabled. When not set, return only enabled.", "disabled": false }, { "key": "class", "value": "5", "description": "Filter by service class ID", "disabled": false }, { "key": "kind", "value": "SCF_DATA%2CSCF_VOIP", "description": "Filter by service class flag(s) (comma-separated). Valid: SCF_DATA, SCF_TV_ANALOG, SCF_TV_DVB, SCF_TV_IPTV, SCF_VOIP, SCF_GSM, SCF_SMS, SCF_WHOLESALE, SCF_DATA_LINK, SCF_EMAIL, SCF_VPS, SCF_LOC, SCF_3S, SCF_LEASE, SCF_LOAN", "disabled": false }, { "key": "base_service", "value": "10", "description": "Filter definitions that can be dependent on the given base service ID", "disabled": false }, { "key": "search", "value": "internet", "description": "Search by service name (NAME) or end-user name (SN_EU_NAME)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/service-definitions?ids=1%2C2%2C3&cts=1%2C2%2C3&disabled=true&class=5&kind=SCF_DATA%2CSCF_VOIP&base_service=10&search=internet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of service definitions.\nBy default only enabled definitions are returned (SN_DISABLED=0).\nUse the `disabled` filter to include\/filter disabled definitions." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":188329,\"NAME\":\"nostrum qui commodi\",\"PRICE\":\"7404.2747\",\"SN_SUGGEST_PRICE\":\"0.0000\",\"CLASS\":\"03\",\"TYPE\":\"S\",\"SN_DEP_TYPE\":\"dependent\",\"NOTE\":null,\"CT\":\"027\",\"SWITCH_TYPE\":0,\"ACC_GROUP_ID\":\"0045\",\"SN_DISABLED\":0,\"SN_START_RESTRICTION\":\"NONE\",\"SN_END_RESTRICTION\":\"NONE\",\"SN_ACCOUNTFROM_RESTRICTION\":\"NONE\",\"SN_ACCOUNTTO_RESTRICTION\":\"NONE\",\"SN_ACCOUNTCHANGE_RESTRICTION\":\"NONE\",\"SN_TL_ID\":0,\"SN_TG_ID\":null,\"SN_WEB_ENABLE\":0,\"SN_PRICE_WO_VAT\":\"8852.3678\",\"SN_PRICE_VAT\":\"275.3415\",\"SN_PRICE_ROUND\":null,\"SN_VAR_PRICE_ENABLED\":0,\"SN_MIN_BOND\":0,\"SN_FIXED_MONTHS\":0,\"SN_PERIOD\":\"none\",\"SN_BP_ID\":\"000059\",\"SN_FIXED_BP\":0,\"SN_CODE\":null,\"SN_DISABLE_ATTACH_ALL\":0,\"SN_VAT_BOTTOMUP\":0,\"SN_EU_NAME\":null,\"SN_INV_VAR_PRICE\":null,\"SN_TYPE\":\"S\",\"SN_UNIT_PACK\":null,\"SN_BARCODE\":null,\"SN_WARRANTY_PERIOD\":null,\"SN_VAR_SYMBOL_TMPL\":null,\"SN_UNICREDIT_ASSIGN\":\"never\",\"SN_PROVISIONING\":0,\"SN_TRANSFER_SPLITTED\":0,\"SN_MOVE_SPLITTED\":0,\"SN_PRICE_CHANGE\":3,\"SN_POINTS_DISCOUNT\":null,\"SN_POINTS_DISCOUNT_VAT\":null,\"SN_POINTS_DISCOUNT_WO_VAT\":null,\"SN_POINTS_PRICE\":null,\"SN_POINTS_REWARD\":null,\"SN_UNICREDIT_TYPE\":null,\"SN_PRICE_CALC\":\"LOC_PRICE\",\"SN_TRANSPORT\":0,\"SN_FORCE_MOVE_ON_TRANSFER\":0,\"SN_DELIVERY\":null,\"SN_NAME_PART\":0,\"SN_PRICE_TOTAL_PERIOD\":0,\"SN_PENALTY\":null,\"SN_WAREHOUSE\":null,\"SN_SC_AVAIL_TYPE\":null,\"SN_SC_AVAIL_TO\":null,\"SN_PREMISE_AVAIL_TYPE\":null,\"SN_CACHE_WAREHOUSE_AVAILABLE\":0,\"SN_CREATED\":null,\"SN_CREATED_L_ID\":null,\"SN_CHANGED\":null,\"SN_CHANGED_L_ID\":null,\"SN_WORK\":0,\"SN_LAST_CHANGE\":null,\"ACC_GROUP_ID_OLD\":null,\"ACC_GROUP_ID_NEW\":null,\"params\":[{\"ID\":1909272,\"SERVICES_NAME_ID\":188329,\"CLASS_PAR_NAME\":\"speed_download\",\"SNC_PAR_INDEX\":null,\"CLASS_PAR_VALUE\":null,\"SNC_DOMAIN\":null,\"SNC_DOMAIN_EU\":null,\"SNC_VALID_FROM\":null,\"SNC_VALID_TO\":null,\"SNC_EU_VISIBLE\":1}]},{\"ID\":188330,\"NAME\":\"aut dolores enim\",\"PRICE\":\"7783.7442\",\"SN_SUGGEST_PRICE\":\"0.0000\",\"CLASS\":\"08\",\"TYPE\":\"S\",\"SN_DEP_TYPE\":\"none\",\"NOTE\":null,\"CT\":\"023\",\"SWITCH_TYPE\":0,\"ACC_GROUP_ID\":\"0091\",\"SN_DISABLED\":0,\"SN_START_RESTRICTION\":\"NONE\",\"SN_END_RESTRICTION\":\"NONE\",\"SN_ACCOUNTFROM_RESTRICTION\":\"NONE\",\"SN_ACCOUNTTO_RESTRICTION\":\"NONE\",\"SN_ACCOUNTCHANGE_RESTRICTION\":\"NONE\",\"SN_TL_ID\":0,\"SN_TG_ID\":null,\"SN_WEB_ENABLE\":0,\"SN_PRICE_WO_VAT\":\"8661.9358\",\"SN_PRICE_VAT\":\"7874.8594\",\"SN_PRICE_ROUND\":null,\"SN_VAR_PRICE_ENABLED\":0,\"SN_MIN_BOND\":0,\"SN_FIXED_MONTHS\":0,\"SN_PERIOD\":\"none\",\"SN_BP_ID\":\"000024\",\"SN_FIXED_BP\":0,\"SN_CODE\":null,\"SN_DISABLE_ATTACH_ALL\":0,\"SN_VAT_BOTTOMUP\":0,\"SN_EU_NAME\":null,\"SN_INV_VAR_PRICE\":null,\"SN_TYPE\":\"S\",\"SN_UNIT_PACK\":null,\"SN_BARCODE\":null,\"SN_WARRANTY_PERIOD\":null,\"SN_VAR_SYMBOL_TMPL\":null,\"SN_UNICREDIT_ASSIGN\":\"never\",\"SN_PROVISIONING\":0,\"SN_TRANSFER_SPLITTED\":0,\"SN_MOVE_SPLITTED\":0,\"SN_PRICE_CHANGE\":3,\"SN_POINTS_DISCOUNT\":null,\"SN_POINTS_DISCOUNT_VAT\":null,\"SN_POINTS_DISCOUNT_WO_VAT\":null,\"SN_POINTS_PRICE\":null,\"SN_POINTS_REWARD\":null,\"SN_UNICREDIT_TYPE\":null,\"SN_PRICE_CALC\":\"LOC_PRICE\",\"SN_TRANSPORT\":0,\"SN_FORCE_MOVE_ON_TRANSFER\":0,\"SN_DELIVERY\":null,\"SN_NAME_PART\":0,\"SN_PRICE_TOTAL_PERIOD\":0,\"SN_PENALTY\":null,\"SN_WAREHOUSE\":null,\"SN_SC_AVAIL_TYPE\":null,\"SN_SC_AVAIL_TO\":null,\"SN_PREMISE_AVAIL_TYPE\":null,\"SN_CACHE_WAREHOUSE_AVAILABLE\":0,\"SN_CREATED\":null,\"SN_CREATED_L_ID\":null,\"SN_CHANGED\":null,\"SN_CHANGED_L_ID\":null,\"SN_WORK\":0,\"SN_LAST_CHANGE\":null,\"ACC_GROUP_ID_OLD\":null,\"ACC_GROUP_ID_NEW\":null,\"params\":[{\"ID\":1909273,\"SERVICES_NAME_ID\":188330,\"CLASS_PAR_NAME\":\"speed_upload\",\"SNC_PAR_INDEX\":null,\"CLASS_PAR_VALUE\":null,\"SNC_DOMAIN\":null,\"SNC_DOMAIN_EU\":null,\"SNC_VALID_FROM\":null,\"SNC_VALID_TO\":null,\"SNC_EU_VISIBLE\":1}]}]}", "name": "" } ] }, { "name": "Get Service Definition", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-definitions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/service-definitions\/:id", "variable": [ { "id": "id", "key": "id", "value": "19", "description": "The ID of the service definition." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single service definition by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":188331,\"NAME\":\"incidunt iure odit\",\"PRICE\":\"1119.7570\",\"SN_SUGGEST_PRICE\":\"0.0000\",\"CLASS\":\"05\",\"TYPE\":\"S\",\"SN_DEP_TYPE\":\"dependent\",\"NOTE\":null,\"CT\":\"076\",\"SWITCH_TYPE\":0,\"ACC_GROUP_ID\":\"0066\",\"SN_DISABLED\":0,\"SN_START_RESTRICTION\":\"NONE\",\"SN_END_RESTRICTION\":\"NONE\",\"SN_ACCOUNTFROM_RESTRICTION\":\"NONE\",\"SN_ACCOUNTTO_RESTRICTION\":\"NONE\",\"SN_ACCOUNTCHANGE_RESTRICTION\":\"NONE\",\"SN_TL_ID\":0,\"SN_TG_ID\":null,\"SN_WEB_ENABLE\":0,\"SN_PRICE_WO_VAT\":\"5455.9867\",\"SN_PRICE_VAT\":\"5813.9895\",\"SN_PRICE_ROUND\":null,\"SN_VAR_PRICE_ENABLED\":0,\"SN_MIN_BOND\":0,\"SN_FIXED_MONTHS\":0,\"SN_PERIOD\":\"vyear\",\"SN_BP_ID\":\"000068\",\"SN_FIXED_BP\":0,\"SN_CODE\":null,\"SN_DISABLE_ATTACH_ALL\":0,\"SN_VAT_BOTTOMUP\":0,\"SN_EU_NAME\":null,\"SN_INV_VAR_PRICE\":null,\"SN_TYPE\":\"S\",\"SN_UNIT_PACK\":null,\"SN_BARCODE\":null,\"SN_WARRANTY_PERIOD\":null,\"SN_VAR_SYMBOL_TMPL\":null,\"SN_UNICREDIT_ASSIGN\":\"never\",\"SN_PROVISIONING\":0,\"SN_TRANSFER_SPLITTED\":0,\"SN_MOVE_SPLITTED\":0,\"SN_PRICE_CHANGE\":3,\"SN_POINTS_DISCOUNT\":null,\"SN_POINTS_DISCOUNT_VAT\":null,\"SN_POINTS_DISCOUNT_WO_VAT\":null,\"SN_POINTS_PRICE\":null,\"SN_POINTS_REWARD\":null,\"SN_UNICREDIT_TYPE\":null,\"SN_PRICE_CALC\":\"LOC_PRICE\",\"SN_TRANSPORT\":0,\"SN_FORCE_MOVE_ON_TRANSFER\":0,\"SN_DELIVERY\":null,\"SN_NAME_PART\":0,\"SN_PRICE_TOTAL_PERIOD\":0,\"SN_PENALTY\":null,\"SN_WAREHOUSE\":null,\"SN_SC_AVAIL_TYPE\":null,\"SN_SC_AVAIL_TO\":null,\"SN_PREMISE_AVAIL_TYPE\":null,\"SN_CACHE_WAREHOUSE_AVAILABLE\":0,\"SN_CREATED\":null,\"SN_CREATED_L_ID\":null,\"SN_CHANGED\":null,\"SN_CHANGED_L_ID\":null,\"SN_WORK\":0,\"SN_LAST_CHANGE\":null,\"ACC_GROUP_ID_OLD\":null,\"ACC_GROUP_ID_NEW\":null,\"params\":[{\"ID\":1909274,\"SERVICES_NAME_ID\":188331,\"CLASS_PAR_NAME\":\"speed_upload\",\"SNC_PAR_INDEX\":null,\"CLASS_PAR_VALUE\":\"non\",\"SNC_DOMAIN\":null,\"SNC_DOMAIN_EU\":null,\"SNC_VALID_FROM\":null,\"SNC_VALID_TO\":null,\"SNC_EU_VISIBLE\":1}]}}", "name": "" } ] } ] }, { "name": "Service Groups", "description": "", "item": [ { "name": "List Service Groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-groups", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status (true\/false). Default: only active groups are returned.", "disabled": false }, { "key": "type", "value": "SELFCARE%2CACCESS", "description": "Filter by comma-separated SGD_TYPE values (OTHER, NODE_AVAIL, SELFCARE, ACCESS, DELIVERY_SCHEDULE, STATISTICS)", "disabled": false }, { "key": "search", "value": "internet", "description": "Search by group name (partial match)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/service-groups?ids=1%2C2%2C3&active=true&type=SELFCARE%2CACCESS&search=internet" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of service groups." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SGD_ID\":127269,\"SGD_NAME\":\"aut adipisci\",\"SGD_CP_ID\":33,\"SGD_NOTE\":null,\"SGD_TYPE\":\"TREENODE\",\"SGD_PRIORITY\":50,\"SGD_CREATED\":null,\"SGD_ACTIVE\":1,\"SGD_CREATOR\":null,\"SGD_PARENT_ID\":null,\"SGD_ORDER\":100,\"SGD_FIRSTCLASS\":1,\"SGD_COLLECT\":0,\"SGD_MINPRICE_EXCLUDE\":0,\"SGD_CODE\":null,\"SGD_INFO\":\"\",\"SGD_PB_HIDE\":0,\"SGD_LAST_CHANGE\":null},{\"SGD_ID\":127270,\"SGD_NAME\":\"incidunt iure\",\"SGD_CP_ID\":null,\"SGD_NOTE\":\"Modi ipsum nostrum omnis autem et.\",\"SGD_TYPE\":\"SELFCARE\",\"SGD_PRIORITY\":50,\"SGD_CREATED\":null,\"SGD_ACTIVE\":1,\"SGD_CREATOR\":null,\"SGD_PARENT_ID\":null,\"SGD_ORDER\":100,\"SGD_FIRSTCLASS\":1,\"SGD_COLLECT\":0,\"SGD_MINPRICE_EXCLUDE\":0,\"SGD_CODE\":null,\"SGD_INFO\":\"\",\"SGD_PB_HIDE\":0,\"SGD_LAST_CHANGE\":null}]}", "name": "" } ] }, { "name": "Get Service Group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-groups\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/service-groups\/:id", "variable": [ { "id": "id", "key": "id", "value": "4", "description": "The ID of the service group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single service group by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"SGD_ID\":127271,\"SGD_NAME\":\"quidem nostrum\",\"SGD_CP_ID\":null,\"SGD_NOTE\":\"Iure odit et et modi ipsum nostrum omnis.\",\"SGD_TYPE\":\"NODE_AVAIL\",\"SGD_PRIORITY\":50,\"SGD_CREATED\":null,\"SGD_ACTIVE\":1,\"SGD_CREATOR\":null,\"SGD_PARENT_ID\":null,\"SGD_ORDER\":100,\"SGD_FIRSTCLASS\":1,\"SGD_COLLECT\":0,\"SGD_MINPRICE_EXCLUDE\":0,\"SGD_CODE\":null,\"SGD_INFO\":\"\",\"SGD_PB_HIDE\":0,\"SGD_LAST_CHANGE\":null}}", "name": "" } ] } ] }, { "name": "Service Periods", "description": "", "item": [ { "name": "List Service Periods", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-periods", "query": [ { "key": "ids", "value": "month%2Ccyear", "description": "Filter by comma-separated period IDs (string enum values, e.g. \"month,cyear\").", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status. Pass \"true\" for active only, \"false\" for inactive only. Default: no filtering (return all).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/service-periods?ids=month%2Ccyear&active=true" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of billing periods (monthly, quarterly, annual, etc.)\nwith their location availability and default maturity settings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":\"cquarter\",\"NAME\":\"\\u010dtvrtlet\\u00ed\",\"PP_FLOATING\":0,\"PP_MONTHS\":3,\"PP_ACTIVE\":1,\"PP_DISCOUNT\":\"quarter\",\"PP_NUMBER\":4,\"locations\":[{\"PPL_ID\":2,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":1},{\"PPL_ID\":10,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":3},{\"PPL_ID\":18,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":4},{\"PPL_ID\":26,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":5},{\"PPL_ID\":34,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":6},{\"PPL_ID\":42,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":7},{\"PPL_ID\":50,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":10},{\"PPL_ID\":58,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":13},{\"PPL_ID\":66,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":15},{\"PPL_ID\":74,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":39},{\"PPL_ID\":82,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":45},{\"PPL_ID\":90,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":46},{\"PPL_ID\":98,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":58},{\"PPL_ID\":106,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":59},{\"PPL_ID\":114,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":63},{\"PPL_ID\":122,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":65},{\"PPL_ID\":130,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":66},{\"PPL_ID\":138,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":67},{\"PPL_ID\":146,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":69},{\"PPL_ID\":154,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":70},{\"PPL_ID\":162,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":71},{\"PPL_ID\":170,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":72},{\"PPL_ID\":178,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":73},{\"PPL_ID\":186,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":75},{\"PPL_ID\":194,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":78},{\"PPL_ID\":202,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":82},{\"PPL_ID\":210,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":90},{\"PPL_ID\":218,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":98},{\"PPL_ID\":226,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":100},{\"PPL_ID\":234,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":105},{\"PPL_ID\":242,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":107},{\"PPL_ID\":250,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":108},{\"PPL_ID\":258,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":110},{\"PPL_ID\":266,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":111},{\"PPL_ID\":274,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":112},{\"PPL_ID\":282,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":113},{\"PPL_ID\":290,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":114},{\"PPL_ID\":298,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":119},{\"PPL_ID\":306,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":122},{\"PPL_ID\":314,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":123},{\"PPL_ID\":322,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":126},{\"PPL_ID\":330,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":129},{\"PPL_ID\":338,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":131},{\"PPL_ID\":346,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":133},{\"PPL_ID\":354,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":134},{\"PPL_ID\":362,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":139},{\"PPL_ID\":370,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":140},{\"PPL_ID\":378,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":141},{\"PPL_ID\":386,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":142},{\"PPL_ID\":394,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":145},{\"PPL_ID\":402,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":146},{\"PPL_ID\":410,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":147},{\"PPL_ID\":418,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":148},{\"PPL_ID\":426,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":151},{\"PPL_ID\":434,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":152},{\"PPL_ID\":442,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":153},{\"PPL_ID\":523,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":156},{\"PPL_ID\":529,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":157},{\"PPL_ID\":548,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":179},{\"PPL_ID\":572,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":182},{\"PPL_ID\":614,\"PPL_PP_ID\":\"cquarter\",\"PPL_CT\":null,\"PPL_CP\":188}],\"maturity_defaults\":[{\"PMD_ID\":\"cquarter\",\"PMD_MATURITY\":45,\"PMD_CT\":27}]},{\"ID\":\"vyears2\",\"NAME\":\"plovouc\\u00ed dva roky\",\"PP_FLOATING\":1,\"PP_MONTHS\":24,\"PP_ACTIVE\":1,\"PP_DISCOUNT\":\"years2\",\"PP_NUMBER\":1,\"locations\":[{\"PPL_ID\":520,\"PPL_PP_ID\":\"vyears2\",\"PPL_CT\":null,\"PPL_CP\":151},{\"PPL_ID\":526,\"PPL_PP_ID\":\"vyears2\",\"PPL_CT\":null,\"PPL_CP\":153},{\"PPL_ID\":591,\"PPL_PP_ID\":\"vyears2\",\"PPL_CT\":null,\"PPL_CP\":142},{\"PPL_ID\":627,\"PPL_PP_ID\":\"vyears2\",\"PPL_CT\":null,\"PPL_CP\":134}],\"maturity_defaults\":[]}]}", "name": "" } ] } ] }, { "name": "Service States", "description": "", "item": [ { "name": "List Service States", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/service-states", "query": [ { "key": "ids", "value": "1%2C2", "description": "Filter by comma-separated IDs.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/service-states?ids=1%2C2" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of service lifecycle states.\nThis is a small static codelist (4 rows): blocked, active, cancelled, not connected." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":80,\"NAME\":\"adipisci\",\"SS_EU_NAME\":\"quidem\"},{\"ID\":32,\"NAME\":\"qui\",\"SS_EU_NAME\":\"commodi\"}]}", "name": "" } ] } ] }, { "name": "Text Templates", "description": "", "item": [ { "name": "List Text Templates", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/templates", "query": [ { "key": "per_page", "value": "10", "description": "Number of templates to return per page (optional)", "disabled": false }, { "key": "page", "value": "1", "description": "Page number to return (optional)", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated template IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location (installation) IDs. Overrides X-CT header default.", "disabled": false }, { "key": "type", "value": "1%2C2", "description": "Filter by comma-separated template type IDs", "disabled": false }, { "key": "content_type", "value": "html", "description": "Filter by content type", "disabled": false }, { "key": "search", "value": "invoice", "description": "Search in template name and description", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/templates?per_page=10&page=1&ids=1%2C2%2C3&cts=1%2C2%2C3&type=1%2C2&content_type=html&search=invoice" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a paginated list of text templates.\nThe template body (TT_TEMPLATE) is excluded from the list response for performance.\nUse the detail endpoint to retrieve the full body." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"TT_ID\":13845,\"TT_CT\":20,\"TT_NAME\":\"TMPL_RRDMBERF\",\"TT_TEMPLATE\":\"Repudiandae quae quo excepturi non sed ut. Qui harum et cumque nesciunt et. Odio sit voluptatum quis perspiciatis et doloribus cupiditate. Magni quod iure alias.\",\"TT_DESCRIPTION\":\"Repudiandae dignissimos et.\",\"TT_CONTENT_TYPE\":\"html\",\"TT_TTT_ID\":104,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":187518,\"TTP_TT_ID\":13845,\"TTP_NAME\":\"AUT\",\"TTP_VALUE\":\"45\"}],\"type\":{\"TTT_ID\":104,\"TTT_TYPE\":\"doloremque\",\"TTT_TITLE\":\"Molestiae quia enim nulla.\",\"TTT_CONTENT_TYPE\":\"html\",\"TTT_USER_EDITABLE\":1,\"TTT_VAR_PREFIX\":\"{\",\"TTT_VAR_SUFFIX\":\"}\",\"TTT_AUTOSELECT\":\"ALWAYS\"}},{\"TT_ID\":13846,\"TT_CT\":33,\"TT_NAME\":\"TMPL_YYRSXEOQ\",\"TT_TEMPLATE\":\"Et nihil ducimus facilis ut. Ut voluptatem commodi omnis illo. Vero veritatis eos tempore nam. Excepturi vel laboriosam aut hic expedita.\",\"TT_DESCRIPTION\":\"Cum cum ut.\",\"TT_CONTENT_TYPE\":\"html\",\"TT_TTT_ID\":105,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":187519,\"TTP_TT_ID\":13846,\"TTP_NAME\":\"TOTAM\",\"TTP_VALUE\":\"38\"}],\"type\":{\"TTT_ID\":105,\"TTT_TYPE\":\"distinctio\",\"TTT_TITLE\":\"Est corrupti laborum.\",\"TTT_CONTENT_TYPE\":\"text,html,pdf\",\"TTT_USER_EDITABLE\":0,\"TTT_VAR_PREFIX\":\"{\",\"TTT_VAR_SUFFIX\":\"}\",\"TTT_AUTOSELECT\":\"DISABLE\"}}]}", "name": "" } ] }, { "name": "Get Text Template", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the template." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Returns a single text template by ID, including the full template body (TT_TEMPLATE)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TT_ID\":13847,\"TT_CT\":49,\"TT_NAME\":\"TMPL_WPWLVQWR\",\"TT_TEMPLATE\":\"Modi ipsum nostrum omnis autem et. Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis.\",\"TT_DESCRIPTION\":\"Alias tenetur ratione nemo voluptate accusamus.\",\"TT_CONTENT_TYPE\":\"text\",\"TT_TTT_ID\":106,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":187520,\"TTP_TT_ID\":13847,\"TTP_NAME\":\"AB\",\"TTP_VALUE\":\"17\"}],\"type\":{\"TTT_ID\":106,\"TTT_TYPE\":\"et\",\"TTT_TITLE\":\"Modi rerum ex repellendus.\",\"TTT_CONTENT_TYPE\":\"text\",\"TTT_USER_EDITABLE\":1,\"TTT_VAR_PREFIX\":\"{\",\"TTT_VAR_SUFFIX\":\"}\",\"TTT_AUTOSELECT\":\"DISABLE\"}}}", "name": "" } ] } ] }, { "name": "Time Tracking", "description": "", "item": [ { "name": "List Time Tracking Works", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/works", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "customer_id", "value": "10", "description": "Filter by bound customer (user) ID", "disabled": false }, { "key": "process_id", "value": "5", "description": "Filter by bound process (maintenance) ID", "disabled": false }, { "key": "activity_id", "value": "100", "description": "Filter by activity ID (reverse lookup via time_tracking_activities)", "disabled": false }, { "key": "state", "value": "ACTIVE", "description": "Filter by work status: ACTIVE, CLOSED, FINISHED", "disabled": false }, { "key": "created_from", "value": "2024-01-01", "description": "Filter works with TTW_START >= this date (YYYY-MM-DD)", "disabled": false }, { "key": "created_to", "value": "2024-12-31", "description": "Filter works with TTW_START ", "disabled": false }, { "key": "search", "value": "migrace", "description": "Search by work name (TTW_NAME). Case- and diacritics-insensitive.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/works?ids=1%2C2%2C3&customer_id=10&process_id=5&activity_id=100&state=ACTIVE&created_from=2024-01-01&created_to=2024-12-31&search=migrace" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint gets a list of time tracking works.\n The list can be filtered and sorted." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"TTW_ID\":33179,\"TTW_NAME\":\"et et modi\",\"TTW_MINUTES_PLANNED_ORIGIN\":431,\"TTW_MINUTES_PLANNED\":null,\"TTW_LIMIT_PLANNED\":null,\"TTW_REAL_MINUTES_PLANNED\":0,\"TTW_START\":null,\"TTW_FINISH\":null,\"TTW_L_ID\":776,\"TTW_SG_ID\":null,\"TTW_L_MAINTENANCE\":\"NONE\",\"TTW_ACTIVE\":\"CLOSED\",\"TTW_TYPE\":\"NORMAL\",\"TTW_PRICE\":\"2307.6926\",\"TTW_CP\":null,\"TTW_TTC_ID\":null,\"TTW_EXTRA_WORK\":0,\"TTW_EXTRA_WORK_DETAIL\":0,\"TTW_COUNT_STRATEGY\":\"MINS\",\"TTW_SN_ID\":null,\"TTW_VALID\":1,\"TTW_VALID_NOTE\":null,\"TTW_CREATOR_ID\":null,\"TTW_CACHE_FULLNAME\":null,\"TTW_MANDATORY_DESC\":null,\"bound_objects\":[{\"TTWBO_ID\":35111,\"TTWBO_TTW_ID\":33179,\"TTWBO_OBJECT_ID\":2327,\"TTWBO_OBJECT_TYPE\":\"maintenance_job\"}]},{\"TTW_ID\":33180,\"TTW_NAME\":\"ex voluptatem laboriosam\",\"TTW_MINUTES_PLANNED_ORIGIN\":217,\"TTW_MINUTES_PLANNED\":388,\"TTW_LIMIT_PLANNED\":null,\"TTW_REAL_MINUTES_PLANNED\":0,\"TTW_START\":null,\"TTW_FINISH\":null,\"TTW_L_ID\":132,\"TTW_SG_ID\":null,\"TTW_L_MAINTENANCE\":\"NONE\",\"TTW_ACTIVE\":\"FINISHED\",\"TTW_TYPE\":\"PRIVATE\",\"TTW_PRICE\":null,\"TTW_CP\":null,\"TTW_TTC_ID\":null,\"TTW_EXTRA_WORK\":0,\"TTW_EXTRA_WORK_DETAIL\":0,\"TTW_COUNT_STRATEGY\":\"MINS\",\"TTW_SN_ID\":null,\"TTW_VALID\":1,\"TTW_VALID_NOTE\":null,\"TTW_CREATOR_ID\":null,\"TTW_CACHE_FULLNAME\":null,\"TTW_MANDATORY_DESC\":null,\"bound_objects\":[{\"TTWBO_ID\":35112,\"TTWBO_TTW_ID\":33180,\"TTWBO_OBJECT_ID\":4781,\"TTWBO_OBJECT_TYPE\":\"users\"}]}]}", "name": "" } ] }, { "name": "Create Time Tracking Work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/works", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/works" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Server maintenance\",\"minutes_planned_origin\":120,\"minutes_planned\":120,\"limit_planned\":0,\"real_minutes_planned\":120,\"start\":\"2024-01-15 08:00:00\",\"finish\":\"2024-01-15 16:00:00\",\"l_id\":294,\"sg_id\":1,\"l_maintenance\":\"NONE\",\"active\":1,\"type\":\"NORMAL\",\"price\":500,\"ttc_id\":1,\"extra_work\":0,\"extra_work_detail\":0,\"count_strategy\":\"MINS\",\"sn_id\":16,\"mandatory_desc\":0,\"maintenances\":[16],\"users\":[16],\"orders_items\":[16],\"orders\":[16],\"maintenance_jobs\":[16]}" }, "description": " This endpoint creates a new time tracking work." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTW_ID\":33181,\"TTW_NAME\":\"eius et animi\",\"TTW_MINUTES_PLANNED_ORIGIN\":298,\"TTW_MINUTES_PLANNED\":null,\"TTW_LIMIT_PLANNED\":null,\"TTW_REAL_MINUTES_PLANNED\":0,\"TTW_START\":\"2026-04-09 03:43:00\",\"TTW_FINISH\":null,\"TTW_L_ID\":null,\"TTW_SG_ID\":null,\"TTW_L_MAINTENANCE\":\"NONE\",\"TTW_ACTIVE\":\"ACTIVE\",\"TTW_TYPE\":\"NORMAL\",\"TTW_PRICE\":\"5528.7323\",\"TTW_CP\":null,\"TTW_TTC_ID\":null,\"TTW_EXTRA_WORK\":0,\"TTW_EXTRA_WORK_DETAIL\":0,\"TTW_COUNT_STRATEGY\":\"MINS\",\"TTW_SN_ID\":null,\"TTW_VALID\":1,\"TTW_VALID_NOTE\":null,\"TTW_CREATOR_ID\":null,\"TTW_CACHE_FULLNAME\":null,\"TTW_MANDATORY_DESC\":null,\"bound_objects\":[{\"TTWBO_ID\":35113,\"TTWBO_TTW_ID\":33181,\"TTWBO_OBJECT_ID\":9199,\"TTWBO_OBJECT_TYPE\":\"orders_items\"}]}}", "name": "" } ] }, { "name": "Get Time Tracking Work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the work." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint retrieves a specific time tracking work by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTW_ID\":33182,\"TTW_NAME\":\"ipsum nostrum omnis\",\"TTW_MINUTES_PLANNED_ORIGIN\":340,\"TTW_MINUTES_PLANNED\":null,\"TTW_LIMIT_PLANNED\":null,\"TTW_REAL_MINUTES_PLANNED\":0,\"TTW_START\":null,\"TTW_FINISH\":null,\"TTW_L_ID\":null,\"TTW_SG_ID\":null,\"TTW_L_MAINTENANCE\":\"NONE\",\"TTW_ACTIVE\":\"ACTIVE\",\"TTW_TYPE\":\"SPECIAL\",\"TTW_PRICE\":null,\"TTW_CP\":null,\"TTW_TTC_ID\":null,\"TTW_EXTRA_WORK\":0,\"TTW_EXTRA_WORK_DETAIL\":0,\"TTW_COUNT_STRATEGY\":\"MINS\",\"TTW_SN_ID\":null,\"TTW_VALID\":1,\"TTW_VALID_NOTE\":null,\"TTW_CREATOR_ID\":null,\"TTW_CACHE_FULLNAME\":null,\"TTW_MANDATORY_DESC\":null,\"bound_objects\":[{\"TTWBO_ID\":35114,\"TTWBO_TTW_ID\":33182,\"TTWBO_OBJECT_ID\":5040,\"TTWBO_OBJECT_TYPE\":\"orders\"}]}}", "name": "" } ] }, { "name": "Update Time Tracking Work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the work." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Server maintenance\",\"minutes_planned_origin\":120,\"minutes_planned\":120,\"limit_planned\":0,\"real_minutes_planned\":120,\"start\":\"2024-01-15 08:00:00\",\"finish\":\"2024-01-15 16:00:00\",\"l_id\":294,\"sg_id\":1,\"l_maintenance\":\"NONE\",\"active\":1,\"type\":\"NORMAL\",\"price\":500,\"ttc_id\":1,\"extra_work\":0,\"extra_work_detail\":0,\"count_strategy\":\"MINS\",\"sn_id\":16,\"mandatory_desc\":0,\"maintenances\":[16],\"users\":[16],\"orders_items\":[16],\"orders\":[16],\"maintenance_jobs\":[16]}" }, "description": " This endpoint updates an existing time tracking work." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTW_ID\":33183,\"TTW_NAME\":\"quos velit et\",\"TTW_MINUTES_PLANNED_ORIGIN\":203,\"TTW_MINUTES_PLANNED\":null,\"TTW_LIMIT_PLANNED\":null,\"TTW_REAL_MINUTES_PLANNED\":0,\"TTW_START\":\"2026-05-11 21:44:03\",\"TTW_FINISH\":null,\"TTW_L_ID\":548,\"TTW_SG_ID\":null,\"TTW_L_MAINTENANCE\":\"NONE\",\"TTW_ACTIVE\":\"CLOSED\",\"TTW_TYPE\":\"NORMAL\",\"TTW_PRICE\":\"9161.8708\",\"TTW_CP\":null,\"TTW_TTC_ID\":null,\"TTW_EXTRA_WORK\":0,\"TTW_EXTRA_WORK_DETAIL\":0,\"TTW_COUNT_STRATEGY\":\"MINS\",\"TTW_SN_ID\":null,\"TTW_VALID\":1,\"TTW_VALID_NOTE\":null,\"TTW_CREATOR_ID\":null,\"TTW_CACHE_FULLNAME\":null,\"TTW_MANDATORY_DESC\":null,\"bound_objects\":[{\"TTWBO_ID\":35115,\"TTWBO_TTW_ID\":33183,\"TTWBO_OBJECT_ID\":8290,\"TTWBO_OBJECT_TYPE\":\"orders_items\"}]}}", "name": "" } ] }, { "name": "Delete Time Tracking Work", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/works\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/works\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the work." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint deletes a time tracking work." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List Time Tracking Activities", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/activities", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated IDs", "disabled": false }, { "key": "worker_id", "value": "294", "description": "Filter by worker\/operator login ID", "disabled": false }, { "key": "work_id", "value": "10", "description": "Filter by parent work ID", "disabled": false }, { "key": "date_from", "value": "2024-01-01", "description": "Filter activities with TTA_DATE >= this date (YYYY-MM-DD)", "disabled": false }, { "key": "date_to", "value": "2024-12-31", "description": "Filter activities with TTA_DATE ", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities?ids=1%2C2%2C3&worker_id=294&work_id=10&date_from=2024-01-01&date_to=2024-12-31" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint gets a list of time tracking activities.\n The list can be filtered and sorted.\n\n Business rules (enforced by stored procedures):\n - No overlapping activities per user per day\n - No future activities\n - Cannot add\/edit activities before last confirmed date\n - Only owner can edit unless user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right\n - Only one running activity (time_to IS NULL) per user at a time" }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"TTA_ID\":668888,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-05-29\",\"TTA_TIME_FROM\":\"21:47:12\",\"TTA_TIME_TO\":\"01:43:06\",\"TTA_TIME_TOTAL_MINS\":160,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null},{\"TTA_ID\":668889,\"TTA_TTW_ID\":765,\"TTA_L_ID\":633,\"TTA_DATE\":\"1973-08-20\",\"TTA_TIME_FROM\":\"11:24:12\",\"TTA_TIME_TO\":\"19:42:45\",\"TTA_TIME_TOTAL_MINS\":259,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null}]}", "name": "" } ] }, { "name": "Create Time Tracking Activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/activities", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"ttw_id\":10,\"l_id\":294,\"date\":\"2024-06-15\",\"time_from\":\"08:00:00\",\"time_to\":\"10:30:00\",\"time_total\":\"02:30:00\",\"approved\":false,\"description\":\"Server maintenance work\",\"time_accounted\":\"02:30:00\"}" }, "description": " This endpoint creates a new time tracking activity.\n\n Time input: provide either `time_from` + `time_to` OR `time_total`. Minimum 1 minute.\n Description is required if the parent work has mandatory description enabled." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTA_ID\":668890,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-05-29\",\"TTA_TIME_FROM\":\"21:47:12\",\"TTA_TIME_TO\":\"01:43:06\",\"TTA_TIME_TOTAL_MINS\":160,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null}}", "name": "" } ] }, { "name": "Get Time Tracking Activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/activities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the activity." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint retrieves a specific time tracking activity by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTA_ID\":668891,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-05-29\",\"TTA_TIME_FROM\":\"21:47:12\",\"TTA_TIME_TO\":\"01:43:06\",\"TTA_TIME_TOTAL_MINS\":160,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null}}", "name": "" } ] }, { "name": "Update Time Tracking Activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/activities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the activity." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"ttw_id\":10,\"l_id\":294,\"date\":\"2024-06-15\",\"time_from\":\"08:00:00\",\"time_to\":\"10:30:00\",\"time_total\":\"02:30:00\",\"approved\":false,\"description\":\"Updated description\",\"time_accounted\":\"02:30:00\"}" }, "description": " This endpoint updates an existing time tracking activity.\n\n Only the activity owner can edit unless the user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"TTA_ID\":668892,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-05-29\",\"TTA_TIME_FROM\":\"21:47:12\",\"TTA_TIME_TO\":\"01:43:06\",\"TTA_TIME_TOTAL_MINS\":160,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null}}", "name": "" } ] }, { "name": "Delete Time Tracking Activity", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/time-tracking\/activities\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the activity." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " This endpoint deletes a time tracking activity.\n\n Only the activity owner can delete unless the user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Token Management", "description": "", "item": [ { "name": "List Location Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/locations\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v3\/locations\/tokens" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns location tokens visible to the current login within allowed CT scope." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":2904,\"name\":\"aut\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-08-12T14:54:46.000000Z\",\"ct\":129,\"ct_name\":\"IGN\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5855,\"FIRST_NAME\":\"Noah\",\"SURNAME\":\"Cronin\",\"LOGIN\":\"emelie.baumbach\",\"L_LEVEL\":10,\"MAIL\":\"ferne52@example.com\",\"PHONE\":null,\"NOTE\":\"Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia.\",\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":\"0484\",\"L_CREATED\":\"2026-05-21 17:24:16\",\"L_L_ID\":82,\"L_ACTIVE\":0,\"L_PASS_EXPIRE\":-19,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"COOPERATION\",\"L_SIGNATURE\":\"Aut quis ut dolores omnis et earum. Asperiores est vel id aut officiis eos. Et qui unde et.\",\"L_SELFCARE\":1,\"L_CACHE_INITIALS\":\"ew\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":1}},{\"id\":2905,\"name\":\"molestiae\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-08-12T14:54:46.000000Z\",\"ct\":129,\"ct_name\":\"IGN\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5856,\"FIRST_NAME\":\"Nina\",\"SURNAME\":\"Wisoky\",\"LOGIN\":\"jazmyne.heathcote\",\"L_LEVEL\":3,\"MAIL\":\"zstoltenberg@example.org\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":1,\"L_SMS_ENABLE\":1,\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-05-04 15:09:36\",\"L_L_ID\":95,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"COOPERATION\",\"L_SIGNATURE\":null,\"L_SELFCARE\":0,\"L_CACHE_INITIALS\":\"ix\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":1}}]}", "name": "List of location personal access tokens" } ] }, { "name": "Create Location Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/locations\/:location_ID\/tokens", "query": [], "raw": "{{baseUrl}}\/api\/v3\/locations\/:location_ID\/tokens", "variable": [ { "id": "location_ID", "key": "location_ID", "value": "001", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Mobile app token\",\"abilities\":[\"all\"],\"expires_at\":\"2026-12-31T23:59:59Z\"}" }, "description": " Creates a personal access token for a specific location.\n This operation is allowed only for administrator logins (L_CP_ID is null)." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"plain_text_token\":null,\"token\":null}}", "name": "Location token created successfully" } ] }, { "name": "Revoke Location Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/locations\/:location_ID\/tokens\/:tokenId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/locations\/:location_ID\/tokens\/:tokenId", "variable": [ { "id": "location_ID", "key": "location_ID", "value": "001", "description": "" }, { "id": "tokenId", "key": "tokenId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Revokes a personal access token for a specific location within current scope." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] }, { "name": "List Login Tokens", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/tokens\/login", "query": [], "raw": "{{baseUrl}}\/api\/v3\/tokens\/login" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Returns personal access tokens for the currently authenticated login.\n Tokens created through the login endpoint are excluded from this list." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":2907,\"name\":\"quidem\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-08-12T14:54:46.000000Z\",\"ct\":129,\"ct_name\":\"IGN\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5858,\"FIRST_NAME\":\"Theo\",\"SURNAME\":\"Hauck\",\"LOGIN\":\"leo34\",\"L_LEVEL\":5,\"MAIL\":\"pfritsch@example.com\",\"PHONE\":7909150667,\"NOTE\":null,\"SALESMAN\":1,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":\"0044\",\"L_CREATED\":\"2026-01-23 21:40:28\",\"L_L_ID\":28,\"L_ACTIVE\":0,\"L_PASS_EXPIRE\":89,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"MACHINE\",\"L_SIGNATURE\":null,\"L_SELFCARE\":1,\"L_CACHE_INITIALS\":\"pw\",\"L_INITIALS\":\"be\",\"L_STATISTICS_ENABLE\":0}},{\"id\":2908,\"name\":\"dolorem\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-08-12T14:54:46.000000Z\",\"ct\":129,\"ct_name\":\"IGN\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5859,\"FIRST_NAME\":\"Cynthia\",\"SURNAME\":\"Fahey\",\"LOGIN\":\"balistreri.josiane\",\"L_LEVEL\":6,\"MAIL\":\"lward@example.com\",\"PHONE\":null,\"NOTE\":\"Qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.\",\"SALESMAN\":0,\"L_SMS_ENABLE\":1,\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-02-01 10:34:48\",\"L_L_ID\":52,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":-357,\"L_PASS_CHANGE\":\"2026-07-01 02:16:15\",\"L_TYPE\":\"PERSON\",\"L_SIGNATURE\":null,\"L_SELFCARE\":1,\"L_CACHE_INITIALS\":\"qz\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0}}]}", "name": "List of login personal access tokens" } ] }, { "name": "Create Login Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/tokens\/login", "query": [], "raw": "{{baseUrl}}\/api\/v3\/tokens\/login" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"Mobile app token\",\"abilities\":[\"all\"],\"expires_at\":\"2026-12-31T23:59:59Z\",\"ct\":129}" }, "description": " Creates a new personal access token for the currently authenticated login.\n The plain text token is returned only once in the response." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"plain_text_token\":null,\"token\":null}}", "name": "Login token created successfully" } ] }, { "name": "Revoke Login Token", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/tokens\/login\/:tokenId", "query": [], "raw": "{{baseUrl}}\/api\/v3\/tokens\/login\/:tokenId", "variable": [ { "id": "tokenId", "key": "tokenId", "value": "0", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": " Revokes a personal access token owned by the currently authenticated login." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] }, { "name": "Webhook Call History", "description": "", "item": [ { "name": "List webhook call history", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/call-history", "query": [ { "key": "order", "value": "WCH_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: WCH_ID, WCH_STARTED_AT, WCH_FINISHED_AT, WCH_HTTP_STATUS, WCH_CREATED_AT.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated call history IDs (WCH_ID).", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (CT) IDs. Narrows within the user's allowed CTs.", "disabled": false }, { "key": "cp_id", "value": "3", "description": "Filter by CIBS partner ID (WCH_CP_ID) \u2014 exact match.", "disabled": false }, { "key": "wc_ids", "value": "5%2C10", "description": "Filter by comma-separated webhook configuration IDs (WCH_WC_ID).", "disabled": false }, { "key": "obj_type", "value": "WORK", "description": "Filter by object type (WCH_OBJ_TYPE).", "disabled": false }, { "key": "obj_action", "value": "CREATE", "description": "Filter by object action (WCH_OBJ_ACTION).", "disabled": false }, { "key": "obj_id", "value": "42", "description": "Filter by object ID (WCH_OBJ_IDS) \u2014 exact match.", "disabled": false }, { "key": "success", "value": "false", "description": "Filter by success flag (WCH_SUCCESS). When omitted, both successful and failed rows are returned. NULL (skipped) rows are excluded when filtering.", "disabled": false }, { "key": "skipped", "value": "false", "description": "Filter by skipped flag (WCH_SKIPPED).", "disabled": false }, { "key": "sync", "value": "false", "description": "Filter by synchronous delivery flag (WCH_SYNC).", "disabled": false }, { "key": "http_status", "value": "200", "description": "Filter by HTTP response status code (WCH_HTTP_STATUS) \u2014 exact match.", "disabled": false }, { "key": "started_from", "value": "2026-01-01T00%3A00%3A00", "description": "Filter by start time lower bound (WCH_STARTED_AT >=). ISO 8601 datetime.", "disabled": false }, { "key": "started_to", "value": "2026-12-31T23%3A59%3A59", "description": "Filter by start time upper bound (WCH_STARTED_AT ", "disabled": false }, { "key": "url", "value": "example.com", "description": "Substring search on webhook target URL (WCH_URL).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/webhook\/call-history?order=WCH_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&cts=11%2C12&cp_id=3&wc_ids=5%2C10&obj_type=WORK&obj_action=CREATE&obj_id=42&success=false&skipped=false&sync=false&http_status=200&started_from=2026-01-01T00%3A00%3A00&started_to=2026-12-31T23%3A59%3A59&url=example.com" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of webhook delivery attempts visible to the current operator." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"WCH_ID\":9915,\"WCH_WC_ID\":null,\"WCH_NAME\":\"Make: quidem nostrum\",\"WCH_ES_ID\":null,\"WCH_OBJ_TYPE\":\"ACTIVITY\",\"WCH_OBJ_ACTION\":\"CREATE\",\"WCH_OBJ_IDS\":\"3940\",\"WCH_CT\":null,\"WCH_CP_ID\":null,\"WCH_URL\":\"https:\\\/\\\/example.com\\\/odit-et-et-modi\",\"WCH_CONTENT_TYPE\":\"form-encoded\",\"WCH_SKIPPED\":0,\"WCH_SYNC\":0,\"WCH_HTTP_STATUS\":200,\"WCH_SUCCESS\":1,\"WCH_STARTED_AT\":\"2026-07-24T05:09:24.000000Z\",\"WCH_FINISHED_AT\":\"2026-07-24T05:09:26.000000Z\",\"WCH_CREATED_AT\":\"2026-07-24T05:09:24.000000Z\"},{\"WCH_ID\":9916,\"WCH_WC_ID\":null,\"WCH_NAME\":\"Make: autem et\",\"WCH_ES_ID\":null,\"WCH_OBJ_TYPE\":\"ACTIVITY\",\"WCH_OBJ_ACTION\":\"CREATE\",\"WCH_OBJ_IDS\":\"4639\",\"WCH_CT\":null,\"WCH_CP_ID\":null,\"WCH_URL\":\"https:\\\/\\\/example.com\\\/non-facere-tempora-ex-voluptatem-laboriosam-praesentium\",\"WCH_CONTENT_TYPE\":\"json\",\"WCH_SKIPPED\":0,\"WCH_SYNC\":0,\"WCH_HTTP_STATUS\":200,\"WCH_SUCCESS\":1,\"WCH_STARTED_AT\":\"2026-07-28T09:36:57.000000Z\",\"WCH_FINISHED_AT\":\"2026-07-28T09:36:57.000000Z\",\"WCH_CREATED_AT\":\"2026-07-28T09:36:57.000000Z\"}]}", "name": "" } ] }, { "name": "Get webhook call history entry", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/call-history\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/webhook\/call-history\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the call history." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a single webhook delivery attempt by ID, including full payload, response body, and error message." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"WCH_ID\":9917,\"WCH_WC_ID\":null,\"WCH_NAME\":\"Make: quidem nostrum\",\"WCH_ES_ID\":null,\"WCH_OBJ_TYPE\":\"ACTIVITY\",\"WCH_OBJ_ACTION\":\"CREATE\",\"WCH_OBJ_IDS\":\"3940\",\"WCH_CT\":null,\"WCH_CP_ID\":null,\"WCH_URL\":\"https:\\\/\\\/example.com\\\/odit-et-et-modi\",\"WCH_CONTENT_TYPE\":\"form-encoded\",\"WCH_PAYLOAD\":null,\"WCH_SKIPPED\":0,\"WCH_SYNC\":0,\"WCH_HTTP_STATUS\":200,\"WCH_RESPONSE_BODY\":null,\"WCH_ERROR_MESSAGE\":null,\"WCH_SUCCESS\":1,\"WCH_STARTED_AT\":\"2026-07-24T05:09:24.000000Z\",\"WCH_FINISHED_AT\":\"2026-07-24T05:09:26.000000Z\",\"WCH_CREATED_AT\":\"2026-07-24T05:09:24.000000Z\"}}", "name": "" } ] } ] }, { "name": "Webhook Configuration", "description": "", "item": [ { "name": "List webhook configurations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/config", "query": [ { "key": "order", "value": "WC_ID%3Adesc", "description": "Sort by one or more \"column:direction\" pairs (direction = asc|desc), comma-separated. Sortable columns: WC_ID, WC_CT, WC_CP_ID, WC_TRIGGER_OBJ_TYPE, WC_URL, WC_ACTIVE, WC_CREATED_AT, WC_MODIFIED_AT.", "disabled": false }, { "key": "per_page", "value": "15", "description": "Number of items per page (max 100).", "disabled": false }, { "key": "page", "value": "1", "description": "Page number.", "disabled": false }, { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated webhook configuration IDs (WC_ID).", "disabled": false }, { "key": "cts", "value": "11%2C12", "description": "Filter by comma-separated location (CT) IDs. Narrows within the user's allowed CTs.", "disabled": false }, { "key": "cp_id", "value": "3", "description": "Filter by CIBS partner ID (WC_CP_ID) \u2014 exact match.", "disabled": false }, { "key": "trigger_obj_type", "value": "WORK", "description": "Filter by trigger object type (WC_TRIGGER_OBJ_TYPE).", "disabled": false }, { "key": "trigger_action", "value": "CREATE", "description": "Filter by trigger action (WC_TRIGGER_ACTION).", "disabled": false }, { "key": "active", "value": "true", "description": "Filter by active status (WC_ACTIVE). When omitted, both active and inactive rows are returned.", "disabled": false }, { "key": "sync", "value": "false", "description": "Filter by synchronous flag (WC_SYNC). When omitted, both sync and async rows are returned.", "disabled": false }, { "key": "content_type", "value": "json", "description": "Filter by webhook content type (WC_CONTENT_TYPE).", "disabled": false }, { "key": "url", "value": "example.com", "description": "Substring search on webhook URL (WC_URL).", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/webhook\/config?order=WC_ID%3Adesc&per_page=15&page=1&ids=1%2C2%2C3&cts=11%2C12&cp_id=3&trigger_obj_type=WORK&trigger_action=CREATE&active=true&sync=false&content_type=json&url=example.com" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a paginated list of webhook configurations visible to the current operator." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"WC_ID\":105,\"WC_CT\":null,\"WC_CP_ID\":null,\"WC_TRIGGER_OBJ_TYPE\":\"ACTIVITY\",\"WC_TRIGGER_ACTION\":null,\"WC_URL\":\"https:\\\/\\\/example.com\\\/tenetur-impedit-repellat-natus-dolorum-omnis-sit-esse-aut\",\"WC_SIGNATURE_SECRET\":\"kQ8r-2Zp7Nx4mV9wL5tY1bC6dF0sG3hJ-eW8uI2oA_nPqRz\",\"WC_CONTENT_TYPE\":\"json\",\"WC_SYNC\":0,\"WC_ACTIVE\":1,\"WC_NAME\":\"Make: nemo dignissimos\",\"WC_DESC\":\"Et praesentium dolores reiciendis unde ad incidunt molestiae sed.\",\"WC_CREATED_BY\":null,\"WC_MODIFIED_BY\":null,\"WC_DELETED_BY\":null,\"WC_CREATED_AT\":null,\"WC_MODIFIED_AT\":null,\"WC_DELETED_AT\":null},{\"WC_ID\":106,\"WC_CT\":null,\"WC_CP_ID\":null,\"WC_TRIGGER_OBJ_TYPE\":\"WORK\",\"WC_TRIGGER_ACTION\":null,\"WC_URL\":\"https:\\\/\\\/example.com\\\/fuga-ut-voluptatem-aperiam-delectus\",\"WC_SIGNATURE_SECRET\":\"kQ8r-2Zp7Nx4mV9wL5tY1bC6dF0sG3hJ-eW8uI2oA_nPqRz\",\"WC_CONTENT_TYPE\":\"form-encoded\",\"WC_SYNC\":0,\"WC_ACTIVE\":1,\"WC_NAME\":\"Make: est quia\",\"WC_DESC\":\"Ipsum molestias alias debitis et repudiandae id voluptas.\",\"WC_CREATED_BY\":null,\"WC_MODIFIED_BY\":null,\"WC_DELETED_BY\":null,\"WC_CREATED_AT\":null,\"WC_MODIFIED_AT\":null,\"WC_DELETED_AT\":null}]}", "name": "" } ] }, { "name": "Create webhook configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/config", "query": [], "raw": "{{baseUrl}}\/api\/v3\/webhook\/config" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"ct\":11,\"cp_id\":3,\"trigger_obj_type\":\"WORK\",\"trigger_action\":\"CREATE\",\"url\":\"https:\\\/\\\/example.com\\\/hooks\\\/work\",\"content_type\":\"json\",\"sync\":0,\"active\":1,\"name\":\"Make: New work order \u2192 fulfilment\",\"description\":\"Notifies the fulfilment scenario in Make whenever a work order is created.\"}" }, "description": "Create a new webhook configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"WC_ID\":107,\"WC_CT\":null,\"WC_CP_ID\":null,\"WC_TRIGGER_OBJ_TYPE\":\"WORK\",\"WC_TRIGGER_ACTION\":null,\"WC_URL\":\"https:\\\/\\\/example.com\\\/quidem-nostrum-qui-commodi-incidunt-iure-odit\",\"WC_SIGNATURE_SECRET\":\"kQ8r-2Zp7Nx4mV9wL5tY1bC6dF0sG3hJ-eW8uI2oA_nPqRz\",\"WC_CONTENT_TYPE\":\"form-encoded\",\"WC_SYNC\":0,\"WC_ACTIVE\":1,\"WC_NAME\":\"Make: et modi\",\"WC_DESC\":\"Nostrum omnis autem et consequatur aut.\",\"WC_CREATED_BY\":null,\"WC_MODIFIED_BY\":null,\"WC_DELETED_BY\":null,\"WC_CREATED_AT\":null,\"WC_MODIFIED_AT\":null,\"WC_DELETED_AT\":null}}", "name": "" } ] }, { "name": "Get webhook configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/config\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/webhook\/config\/:id", "variable": [ { "id": "id", "key": "id", "value": "000002", "description": "The ID of the config." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Retrieve a single webhook configuration by ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"WC_ID\":108,\"WC_CT\":null,\"WC_CP_ID\":null,\"WC_TRIGGER_OBJ_TYPE\":\"WORK\",\"WC_TRIGGER_ACTION\":null,\"WC_URL\":\"https:\\\/\\\/example.com\\\/et-modi-ipsum-nostrum-omnis-autem-et-consequatur\",\"WC_SIGNATURE_SECRET\":\"kQ8r-2Zp7Nx4mV9wL5tY1bC6dF0sG3hJ-eW8uI2oA_nPqRz\",\"WC_CONTENT_TYPE\":\"json\",\"WC_SYNC\":0,\"WC_ACTIVE\":1,\"WC_NAME\":\"Make: dolores enim\",\"WC_DESC\":\"Facere tempora ex voluptatem laboriosam.\",\"WC_CREATED_BY\":null,\"WC_MODIFIED_BY\":null,\"WC_DELETED_BY\":null,\"WC_CREATED_AT\":null,\"WC_MODIFIED_AT\":null,\"WC_DELETED_AT\":null}}", "name": "" } ] }, { "name": "Update webhook configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/config\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/webhook\/config\/:id", "variable": [ { "id": "id", "key": "id", "value": "000002", "description": "The ID of the config." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": { "mode": "raw", "raw": "{\"ct\":11,\"cp_id\":3,\"trigger_obj_type\":\"WORK\",\"trigger_action\":\"CREATE\",\"url\":\"https:\\\/\\\/example.com\\\/hooks\\\/work\",\"content_type\":\"json\",\"sync\":0,\"active\":1,\"name\":\"Make: New work order \u2192 fulfilment\",\"description\":\"Notifies the fulfilment scenario in Make whenever a work order is created.\"}" }, "description": "Update an existing webhook configuration. Partial input accepted; the service reads the current row and merges before calling the underlying full-state edit procedure." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"WC_ID\":109,\"WC_CT\":null,\"WC_CP_ID\":null,\"WC_TRIGGER_OBJ_TYPE\":\"WORK\",\"WC_TRIGGER_ACTION\":null,\"WC_URL\":\"https:\\\/\\\/example.com\\\/dolores-enim-non-facere-tempora\",\"WC_SIGNATURE_SECRET\":\"kQ8r-2Zp7Nx4mV9wL5tY1bC6dF0sG3hJ-eW8uI2oA_nPqRz\",\"WC_CONTENT_TYPE\":\"json\",\"WC_SYNC\":0,\"WC_ACTIVE\":1,\"WC_NAME\":\"Make: voluptatem laboriosam\",\"WC_DESC\":\"Quis adipisci molestias fugit deleniti distinctio eum.\",\"WC_CREATED_BY\":null,\"WC_MODIFIED_BY\":null,\"WC_DELETED_BY\":null,\"WC_CREATED_AT\":null,\"WC_MODIFIED_AT\":null,\"WC_DELETED_AT\":null}}", "name": "" } ] }, { "name": "Delete webhook configuration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/webhook\/config\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v3\/webhook\/config\/:id", "variable": [ { "id": "id", "key": "id", "value": "000002", "description": "The ID of the config." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "X-CT", "value": "{{ct}}" }, { "key": "X-Login-Id", "value": "{{loginId}}" } ], "body": null, "description": "Soft-delete a webhook configuration (sets WC_DELETED_AT)." }, "response": [ { "header": [], "code": 204, "body": null, "name": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }