{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/apiv3-test.devel.ogsoftdev.com" } ], "info": { "name": "Laravel API Documentation", "_postman_id": "d4a99d12-77a7-4c83-be43-4a8ffa62433a", "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\":2217,\"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\":37164,\"AGN_AG_ID\":2217,\"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\":2218,\"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\":37165,\"AGN_AG_ID\":2218,\"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\":2219,\"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\":37166,\"AGN_AG_ID\":2219,\"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.\n Includes global types (AT_CT = NULL) available to all locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"AT_ID\":460,\"AT_CP\":null,\"AT_CT\":21,\"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\":461,\"AT_CP\":null,\"AT_CT\":2,\"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.\n By default, only valid agreements (A_VALID = 1) are returned.\n Use `valid=0` to see only invalid, or `valid=all` to see both." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"A_ID\":348918,\"A_AT_ID\":457,\"A_USER_ID\":383,\"A_CT\":57,\"A_NUMBER\":\"857680\",\"A_NOTE\":\"Quidem nostrum qui commodi incidunt iure odit.\",\"A_CONCLUSION_DATE\":\"1977-08-15\",\"A_CREATED\":\"2026-01-04 19:19:02\",\"A_L_ID\":2685,\"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\":577398,\"AS_A_ID\":348918,\"AS_SA_ID\":3981545}],\"type\":{\"AT_ID\":457,\"AT_CP\":null,\"AT_CT\":214,\"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\":348919,\"A_AT_ID\":458,\"A_USER_ID\":14086,\"A_CT\":102,\"A_NUMBER\":\"187043\",\"A_NOTE\":\"Laboriosam praesentium quis adipisci molestias fugit deleniti distinctio.\",\"A_CONCLUSION_DATE\":\"2013-02-14\",\"A_CREATED\":\"2026-02-05 10:17:14\",\"A_L_ID\":1818,\"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\":577399,\"AS_A_ID\":348919,\"AS_SA_ID\":3950069}],\"type\":{\"AT_ID\":458,\"AT_CP\":null,\"AT_CT\":154,\"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\":348920,\"A_AT_ID\":459,\"A_USER_ID\":467385,\"A_CT\":33,\"A_NUMBER\":\"333724\",\"A_NOTE\":\"Nostrum qui commodi incidunt iure.\",\"A_CONCLUSION_DATE\":\"1990-02-03\",\"A_CREATED\":\"2026-03-05 06:45:06\",\"A_L_ID\":2066,\"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\":577400,\"AS_A_ID\":348920,\"AS_SA_ID\":2961403}],\"type\":{\"AT_ID\":459,\"AT_CP\":null,\"AT_CT\":5,\"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.\n Note: PDF rendering is not yet implemented (returns 503)." }, "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\":5550,\"LOGIN\":\"idickens\",\"IS_SUPER_ADMIN\":true}}", "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\":5551,\"LOGIN\":\"dare.emelie\",\"IS_SUPER_ADMIN\":true}}", "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).\n By default, disabled plans are excluded. Use `disabled=all` to include them.\n CT scoping returns global plans (BP_CT IS NULL) plus plans specific to the user's locations." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"BP_ID\":1075,\"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\":1076,\"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": "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).\n Contacts are scoped by CT through the parent customer." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"UC_ID\":20906,\"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\":20907,\"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": "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\":20908,\"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": "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.\n By default, only active groups (G_ACTIVE=1) are returned.\n Pass `active=all` to include inactive groups." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":2660,\"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\":2661,\"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\":2662,\"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\":1367146,\"GROUP_ID\":2662,\"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.\n By default, only enabled definitions (UPD_DISABLED=0) are returned.\n Pass `disabled=all` to include disabled definitions.\n Global definitions (UPD_CT IS NULL) are always included alongside\n location-specific ones." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"UPD_ID\":1034,\"UPD_CT\":181,\"UPD_TARGET\":\"user\",\"UPD_NAME\":\"QUIDEM\",\"UPD_DISPLAY\":\"nostrum qui\",\"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\":709,\"UPD_CREATED\":\"2026-03-13 12:50:02\",\"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\":1035,\"UPD_CT\":180,\"UPD_TARGET\":\"user\",\"UPD_NAME\":\"ET\",\"UPD_DISPLAY\":\"modi ipsum\",\"UPD_DEFAULT_VALUE\":\"\",\"UPD_TYPE\":\"NUM\",\"UPD_INDEXED\":0,\"UPD_DOMAIN\":null,\"UPD_NOTNULL\":0,\"UPD_TIME_RESOLUTION\":0,\"UPD_DISABLED\":0,\"UPD_PUBLIC\":0,\"UPD_L_ID\":646,\"UPD_CREATED\":\"2026-01-15 09:47:06\",\"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 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.\n Filterable by customer, service, discount definition, status, and more.\n CT scoping is indirect \u2014 resolved via the customer's location." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"SAD_ID\":309330,\"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-02-08 13:34:45\",\"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\":309331,\"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-02-24 13:30:25\",\"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\":309332,\"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-02-08 13:34:45\",\"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.\n This is a global codelist \u2014 no CT scoping is applied." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":4,\"NAME\":\"Pozn\\u00e1mka\",\"SET_PRICE_AFFECT\":0,\"SET_ATTACHMENT\":0,\"SET_MT_NAME\":null,\"SET_CAN_DELETE\":1,\"SET_CAN_EDIT\":1,\"SET_EU_SHOW\":0,\"SET_PDC_ERASE\":1},{\"ID\":63,\"NAME\":\"Storno objedn\\u00e1vky\",\"SET_PRICE_AFFECT\":1,\"SET_ATTACHMENT\":0,\"SET_MT_NAME\":null,\"SET_CAN_DELETE\":0,\"SET_CAN_EDIT\":0,\"SET_EU_SHOW\":0,\"SET_PDC_ERASE\":1}]}", "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.\n At least one identifying filter (customer, service_id, customer_service, or event_type) is required." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":779343307,\"USER_ID\":641,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-01-28 02:36:52\",\"CHANGE_TIME\":\"1994-12-16\",\"EVENT_TYPE\":10,\"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\":20456534,\"SHP_SH_ID\":779343307,\"SHP_NAME\":\"cupiditate\",\"SHP_VALUE\":\"Nemo deleniti repellat atque minima.\"}]},{\"ID\":779343308,\"USER_ID\":583,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-02-16 22:27:47\",\"CHANGE_TIME\":\"2019-03-31\",\"EVENT_TYPE\":1,\"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\":20456535,\"SHP_SH_ID\":779343308,\"SHP_NAME\":\"repudiandae\",\"SHP_VALUE\":\"Id dolor aut hic at at.\"}]}]}", "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\":779343309,\"USER_ID\":2878,\"SERVICE_ID\":0,\"USER_SERVICE_ID\":0,\"TIME\":\"2026-02-03 00:20:21\",\"CHANGE_TIME\":\"2006-09-25\",\"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\":20456536,\"SHP_SH_ID\":779343309,\"SHP_NAME\":\"qui\",\"SHP_VALUE\":\"Incidunt iure odit et et modi ipsum.\"}]}}", "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. Default: excludes cancelled (02)", "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.\n By default, cancelled services (state 02) are excluded." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":4591613,\"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-12-14\",\"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-04-15 14:55:09\",\"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\":\"0003567104\",\"SP_SRV_ID\":4591613,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1973-12-17\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"ipsum\",\"SP_CREATED\":\"2026-02-24 13:31:05\",\"SP_L_ID\":\"007018\"}],\"discounts\":[{\"SAD_ID\":309324,\"SAD_U_ID\":4486,\"SAD_SA_ID\":4591613,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"points\",\"SAD_VALUE\":\"72.9772\",\"SAD_START\":\"1997-06-20\",\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-02-23 08:05:41\",\"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\":4591614,\"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-05-01\",\"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-04-15 14:55:09\",\"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\":\"0003567105\",\"SP_SRV_ID\":4591614,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1976-09-02\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"officia\",\"SP_CREATED\":\"2026-04-02 21:12:33\",\"SP_L_ID\":\"008925\"}],\"discounts\":[{\"SAD_ID\":309325,\"SAD_U_ID\":2531,\"SAD_SA_ID\":4591614,\"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-06 19:00:09\",\"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\":4591615,\"USER_ID\":\"02938\",\"SERVICE_ID\":\"4027\",\"PRICE\":\"6356.1332\",\"DATE_START\":\"1973-04-15\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2020-08-07\",\"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-04-15 14:55:09\",\"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\":\"0003567106\",\"SP_SRV_ID\":4591615,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1981-11-24\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"adipisci\",\"SP_CREATED\":\"2026-03-19 17:08:29\",\"SP_L_ID\":\"002617\"}],\"discounts\":[{\"SAD_ID\":309326,\"SAD_U_ID\":8015,\"SAD_SA_ID\":4591615,\"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-03-05 06:52:54\",\"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\":4591616,\"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-12-14\",\"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-04-15 14:55:09\",\"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\":\"0003567107\",\"SP_SRV_ID\":4591616,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1973-12-17\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"ipsum\",\"SP_CREATED\":\"2026-02-24 13:31:05\",\"SP_L_ID\":\"007018\"}],\"discounts\":[{\"SAD_ID\":309327,\"SAD_U_ID\":4486,\"SAD_SA_ID\":4591616,\"SAD_SD_ID\":50,\"SAD_DEP_SA_IDS\":null,\"SAD_TYPE\":\"points\",\"SAD_VALUE\":\"72.9772\",\"SAD_START\":\"1997-06-20\",\"SAD_STOP\":null,\"SAD_CREATED\":\"2026-02-23 08:05:41\",\"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}],\"dependent_services\":[{\"SAL_ID\":\"00000197980\",\"SAL_TYPE\":\"fixed\",\"SAL_SA_ID\":4591616,\"SAL_LINKED_SA_ID\":7048,\"SAL_VALID_FROM\":null,\"SAL_VALID_TO\":null,\"SAL_SAD_ID\":null,\"SAL_CREATED\":\"2026-01-11 18:42:26\",\"SAL_CREATOR_ID\":\"007602\"}]}}", "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\":4591617,\"USER_ID\":\"02938\",\"SERVICE_ID\":\"4027\",\"PRICE\":\"6356.1332\",\"DATE_START\":\"1973-04-15\",\"DATE_END\":null,\"STATE\":\"01\",\"PAYMENT_DEPRECATED\":null,\"ACCOUNT_FROM\":\"2020-08-07\",\"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-04-15 14:55:09\",\"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\":\"0003567108\",\"SP_SRV_ID\":4591617,\"SP_NAME\":\"msisdn\",\"SP_VALID_FROM\":\"1981-11-24\",\"SP_VALID_TO\":null,\"SP_VALUE\":\"adipisci\",\"SP_CREATED\":\"2026-03-19 17:08:29\",\"SP_L_ID\":\"002617\"}],\"discounts\":[{\"SAD_ID\":309328,\"SAD_U_ID\":8015,\"SAD_SA_ID\":4591617,\"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-03-05 06:52:54\",\"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": null, "description": " Cancels (deactivates) a customer service. This is a soft cancel, not a hard delete." }, "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": "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\":1792676,\"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\":301268718,\"NODE_ID\":1792676,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_flat_number\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2148176,\"NS_N_ID\":1792676,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-03-24 18:46:05\",\"NS_L_ID\":1,\"NS_NEEDS_UPDATE\":0}]},{\"ID\":1792677,\"NAME\":\"UNIT-snrwtu\",\"NOTE\":\"Quis adipisci molestias fugit deleniti distinctio eum.\",\"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\":74,\"N_CREATED\":null,\"N_L_ID\":535,\"N_GPS_LATITUDE\":null,\"N_GPS_LONGITUDE\":null,\"N_UCP_ID\":null,\"N_US_ID\":null,\"N_UA_ID\":null,\"N_CACHE_NAME\":\"aut\",\"N_CACHE_LAST_WS_ID\":null,\"N_DELETED\":null,\"params\":[{\"ID\":301268719,\"NODE_ID\":1792677,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_connection_type\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2148177,\"NS_N_ID\":1792677,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-01-15 01:05:56\",\"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\":1792678,\"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\":301268720,\"NODE_ID\":1792678,\"NI_NPI_ID\":0,\"PAR_NAME\":\"blkdevice_connection_type\",\"PAR_INDEX\":0,\"VALUE\":null,\"CONTENT\":null,\"TEXT_CONTENT\":null}],\"customer_service_devices\":[{\"NS_ID\":2148178,\"NS_N_ID\":1792678,\"NS_U_ID\":1038,\"NS_SA_ID\":null,\"NS_TIME\":\"2026-02-11 22:12:44\",\"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\":1977197,\"LOGIN\":\"price.amber\",\"PASSWORD\":\"= 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\":1722,\"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-02-08 13:41:06\",\"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\":1723,\"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-01-08 14:18:49\",\"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\":1724,\"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-02-08 13:34:45\",\"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": "Endpoints", "description": "", "item": [ { "name": "GET api\/s-cloud\/tickets", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/s-cloud\/tickets", "query": [ { "key": "myScloudUserId", "value": "123", "description": "ID of the SCloud user", "disabled": false }, { "key": "zombieDays", "value": "30", "description": "Number of days to consider a maintenance as zombie", "disabled": false }, { "key": "iAmReferee", "value": "1", "description": "Indicates if the user is a referee", "disabled": false }, { "key": "iAmSupervisor", "value": "", "description": "Indicates if the user is a supervisor", "disabled": false }, { "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": "typeId", "value": "448%2C463%2C479", "description": "Filter by type ID of the maintenance list", "disabled": false }, { "key": "types", "value": "type1%2Ctype2", "description": "Filter by types of the maintenance list", "disabled": false }, { "key": "machineIds", "value": "1%2C2%2C3", "description": "Filter by machine IDs of the maintenance list", "disabled": false }, { "key": "lastActivityFrom", "value": "2023-01-01", "description": "Filter by last activity date from (optional)", "disabled": false }, { "key": "order", "value": "name%3Aasc%2Ccreated_at%3Adesc", "description": "Order by column and direction", "disabled": false } ], "raw": "{{baseUrl}}\/api\/s-cloud\/tickets?myScloudUserId=123&zombieDays=30&iAmReferee=1&iAmSupervisor=&per_page=10&page=1&typeId=448%2C463%2C479&types=type1%2Ctype2&machineIds=1%2C2%2C3&lastActivityFrom=2023-01-01&order=name%3Aasc%2Ccreated_at%3Adesc" }, "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": "{\"myScloudUserId\":16,\"zombieDays\":39,\"iAmReferee\":true,\"iAmSupervisor\":true}" }, "description": "" }, "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": "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": { "mode": "raw", "raw": "{\"user_id\":16,\"transport_service_id\":16,\"billing_plan_id\":16,\"transport_premise_id\":16,\"order_date\":\"2026-04-15T14:55:08\",\"note\":\"architecto\",\"delivery_date\":\"2026-04-15T14:55:08\"}" }, "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\",\"note\":\"architecto\",\"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}" }, "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\":33143616,\"USER_ID\":2878,\"NUMBER_RECORD\":\"26824\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"2006-09-25\",\"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\":37211350,\"ID_INVOICE\":33143616,\"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\":33143617,\"USER_ID\":1462,\"NUMBER_RECORD\":\"48309\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"1975-05-01\",\"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\":37211351,\"ID_INVOICE\":33143617,\"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\":33143618,\"USER_ID\":2878,\"NUMBER_RECORD\":\"89349\",\"ACCORD\":\"\",\"INVOICE_ORDER\":\"\",\"DATE_S\":\"2015-01-19\",\"DATE_U\":null,\"DATE_V\":\"2010-09-17\",\"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\":37211352,\"ID_INVOICE\":33143618,\"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": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated location IDs", "disabled": false }, { "key": "cts", "value": "1%2C2%2C3", "description": "Filter by comma-separated location IDs (overrides X-CT header)", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/locations?ids=1%2C2%2C3&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." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":\"280\",\"NAME\":\"aut adipisci quidem\",\"DESCRIPTION\":\"Commodi incidunt iure odit et et modi.\",\"LOCATION\":null,\"START_DATE\":\"2026-02-24\",\"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\":\"281\",\"NAME\":\"eos esse pariatur\",\"DESCRIPTION\":null,\"LOCATION\":\"Tillmanville\",\"START_DATE\":\"2026-03-26\",\"SIPO_KODOZ\":\"hn\",\"SIPO_CISORG\":null,\"INFO_EMAIL\":\"elyssa.wintheiser@example.org\",\"HIDDEN\":0,\"PATH\":\"path-tzxzsenw\",\"I_COMPANY_ID\":43,\"I_CP_ID\":1,\"I_MAP_ID\":null,\"I_NOTE\":\"Perspiciatis atque sit impedit architecto non laborum. Voluptatem ex laboriosam et tempore dolorem nihil quasi. Quae sit harum ut. Rerum sint inventore eveniet optio. Suscipit atque officiis accusantium ut ab quisquam quo.\",\"I_MAP_CENTER_LAT\":63.148369,\"I_MAP_CENTER_LON\":-179.461746,\"I_MAP_ZOOM\":14,\"I_MAP_ID_NAME\":\"MAPNAME-gwfz\",\"I_CL_ID\":1}]}", "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.\n Partner-bound users see roles of their CIBS partner + global roles (LR_CP_ID IS NULL)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"LR_ID\":677,\"LR_CP_ID\":null,\"LR_NAME\":\"aut adipisci quidem\",\"LR_LEVEL\":7,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-03-08 11:34:47\",\"LR_L_ID\":1,\"rights\":[{\"ID\":650395,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":677,\"NAME\":\"incidunt-iure-odit\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-03-05 06:51:36\",\"UR_CREATOR_L_ID\":1}]},{\"LR_ID\":678,\"LR_CP_ID\":null,\"LR_NAME\":\"et modi ipsum\",\"LR_LEVEL\":1,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-01-22 06:19:47\",\"LR_L_ID\":1,\"rights\":[{\"ID\":650396,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":678,\"NAME\":\"et-consequatur\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-02-09 00:43:22\",\"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\":679,\"LR_CP_ID\":null,\"LR_NAME\":\"aut adipisci quidem\",\"LR_LEVEL\":7,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-03-08 11:34:47\",\"LR_L_ID\":1,\"rights\":[{\"ID\":650397,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":679,\"NAME\":\"et-modi-ipsum\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-02-24 13:30:35\",\"UR_CREATOR_L_ID\":1}],\"operators\":[{\"ID\":5563,\"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-03-03 02:01: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\":679,\"LRC_L_ID\":5563}}]}}", "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).\n By default only active operators are returned (L_ACTIVE=1).\n Use the `active` filter to include\/filter inactive operators.\n Partner-bound users only see operators of their CIBS partner.\n Use `include_internal=true` to also see internal operators (with limited fields)." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":5560,\"FIRST_NAME\":\"Morgan\",\"SURNAME\":\"Hirthe\",\"LOGIN\":\"alayna44\",\"L_LEVEL\":1,\"MAIL\":\"vraynor@example.com\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"LOG_LEVEL\":\"NOTICE\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-03-18 04:07:19\",\"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\":674,\"LR_CP_ID\":null,\"LR_NAME\":\"deleniti distinctio eum\",\"LR_LEVEL\":2,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-04-08 02:32:10\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5560,\"LRC_LR_ID\":674}}],\"effective_rights\":[{\"ID\":316410656,\"USER_ID\":5560,\"NAME\":\"aliquam-veniam-corporis\",\"OPTIONS\":\"\"}],\"own_rights\":[]},{\"ID\":5561,\"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-03-03 05:12:59\",\"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\":675,\"LR_CP_ID\":null,\"LR_NAME\":\"modi rerum ex\",\"LR_LEVEL\":4,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-04-13 15:46:31\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5561,\"LRC_LR_ID\":675}}],\"effective_rights\":[{\"ID\":316410657,\"USER_ID\":5561,\"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),\n effective rights, and own rights." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":5562,\"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-18 04:07:19\",\"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\":676,\"LR_CP_ID\":null,\"LR_NAME\":\"deleniti distinctio eum\",\"LR_LEVEL\":2,\"LR_NOTE\":null,\"LR_CREATED\":\"2026-04-08 02:32:10\",\"LR_L_ID\":1,\"pivot\":{\"LRC_L_ID\":5562,\"LRC_LR_ID\":676},\"rights\":[{\"ID\":650393,\"UR_TYPE\":\"ROLE\",\"USER_ID\":1,\"UR_LR_ID\":676,\"NAME\":\"libero-aliquam-veniam\",\"OPTIONS\":\"\",\"CIBS_VERSION\":null,\"UR_CREATED\":\"2026-02-26 03:42:08\",\"UR_CREATOR_L_ID\":1}]}],\"effective_rights\":[{\"ID\":316410658,\"USER_ID\":5562,\"NAME\":\"deleniti-nemo\",\"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\":1530,\"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-08 11:29:09\",\"locations\":[{\"PAL_ID\":1556,\"PAL_PA_ID\":1530,\"PAL_CT\":10,\"PAL_PROVIDER_USER_ID\":null,\"PAL_DEFAULT\":0}]},{\"PA_ID\":1531,\"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-01-04 19:34:58\",\"locations\":[{\"PAL_ID\":1557,\"PAL_PA_ID\":1531,\"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\":1532,\"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-08 11:29:09\",\"locations\":[{\"PAL_ID\":1558,\"PAL_PA_ID\":1532,\"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\":24869000,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1981-11-24\",\"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-04-15 16:55:13\",\"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\":24869001,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1990-02-03\",\"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-04-15 16:55:13\",\"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\":24869002,\"PL_PA_ID\":null,\"PAYMENT_DATE\":\"1981-11-24\",\"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-04-15 16:55:13\",\"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": "Process Jobs", "description": "", "item": [ { "name": "List Process Jobs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v3\/processes\/:process\/jobs", "query": [ { "key": "ids", "value": "1%2C2%2C3", "description": "Filter by comma-separated job IDs", "disabled": false }, { "key": "state", "value": "PLANNED", "description": "Filter by job state: PLANNED, DONE, CANCELED", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v3\/processes\/:process\/jobs?ids=1%2C2%2C3&state=PLANNED", "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 Jobs are always scoped to the parent process." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"MJ_ID\":3424700,\"MJ_ML_ID\":1460747,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"NONE\",\"MJ_MJT_ID\":\"050\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-08 11:40:25\",\"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\":\"005556\",\"MJ_CREATED\":\"2026-03-05 06:52:02\",\"MJ_EDITED\":\"2026-04-15 16:55:11\",\"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\":1668348,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3424700,\"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\":3424701,\"MJ_ML_ID\":1460748,\"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\":\"005557\",\"MJ_CREATED\":\"2026-04-12 20:56:23\",\"MJ_EDITED\":\"2026-04-15 16:55:11\",\"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\":1668349,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3424701,\"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\":[\"architecto\"],\"notifications\":[\"architecto\"],\"private\":0,\"service_active_ids\":\"architecto\",\"auto_done\":1,\"auto_done_moment\":\"ON_CREATE\",\"auto_done_action\":\"architecto\",\"customer_coop\":1,\"insert_payment\":16,\"ga_id\":16,\"ucp_id\":16,\"us_id\":16,\"ua_id\":16,\"street\":\"n\",\"house_id\":\"gzmiyv\",\"zip\":\"d\",\"city\":\"l\",\"delay_accepted\":16,\"expedice\":0,\"prev_started\":16,\"prev_finished\":16,\"final_states\":\"architecto\",\"planning\":true}" }, "description": " Creates a new job for a process via maintenance_jobs_job_create stored procedure.\n Required fields depend on planning_policy." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"MJ_ID\":3424702,\"MJ_ML_ID\":1460749,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK\",\"MJ_MJT_ID\":\"066\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-29 23:08:04\",\"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\":\"005558\",\"MJ_CREATED\":\"2026-01-02 12:14:18\",\"MJ_EDITED\":\"2026-04-15 16:55:11\",\"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\":1668350,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3424702,\"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": "{\"l_id\":16,\"sg_id\":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,\"recurrence\":\"architecto\",\"recurrence_hr\":\"architecto\",\"recurrence_data\":\"architecto\",\"recurrence_exceptions\":\"architecto\",\"description\":\"Eius et animi quos velit et.\",\"note\":\"architecto\",\"attendees\":[\"architecto\"],\"notifications\":[\"architecto\"],\"private\":0,\"state\":\"DONE\",\"action\":\"architecto\",\"task_note\":\"architecto\",\"real_finish_time\":\"architecto\",\"ga_id\":16,\"ucp_id\":16,\"us_id\":16,\"ua_id\":16,\"street\":\"n\",\"house_id\":\"gzmiyv\",\"zip\":\"d\",\"city\":\"l\",\"work_time\":16,\"ml_order\":16,\"duration\":16,\"expedice\":0,\"prev_started\":16,\"prev_finished\":16,\"final_states\":\"architecto\"}" }, "description": " Updates an existing job via maintenance_jobs_job_edit stored procedure.\n State changes (DONE, CANCELLED) are performed via the state parameter." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"MJ_ID\":3424703,\"MJ_ML_ID\":1460750,\"MJ_ML_ORDER\":null,\"MJ_PLANNING_POLICY\":\"TIMEBLOCK\",\"MJ_MJT_ID\":\"066\",\"MJ_MJK_ID\":null,\"MJ_START\":\"2026-03-29 23:08:04\",\"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\":\"005559\",\"MJ_CREATED\":\"2026-01-02 12:14:18\",\"MJ_EDITED\":\"2026-04-15 16:55:11\",\"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\":1668351,\"MJA_JOIN_TYPE\":\"JOB\",\"MJA_OBJ_ID\":3424703,\"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": "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 Rights are checked via SQL function (maintenance_right_check_full_data).\n Add ?time_tracking=true to include time tracking computed attributes." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":1460742,\"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-02-08 13:47: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-02-23 07:51:37\",\"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\":14753306,\"MP_ML_ID\":1460742,\"MP_NAME\":\"JOB_START_TIME\",\"MP_VALUE\":\"Voluptatem laboriosam praesentium quis adipisci.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-18 04:10:27\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":539222,\"FA_DOC_ID\":1460742,\"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-04-11 04:23:29\",\"FA_CREATE_L_ID\":null,\"FA_MODIFIED\":null,\"FA_MODIFY_L_ID\":null}]},{\"ID\":1460743,\"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-06 18:45:45\",\"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-03-21 15:02:10\",\"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\":14753307,\"MP_ML_ID\":1460743,\"MP_NAME\":\"TERM\",\"MP_VALUE\":\"Assumenda et tenetur ab reiciendis quia.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-04-05 15:41:57\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":539223,\"FA_DOC_ID\":1460743,\"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-02-08 19:46:26\",\"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\":[{\"name\":\"architecto\",\"value\":\"architecto\"}]}" }, "description": " Creates a new maintenance process via maintenance_task_create stored procedure." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"ID\":1460744,\"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-03-29 23:08:04\",\"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-01-05 15:30:24\",\"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\":14753308,\"MP_ML_ID\":1460744,\"MP_NAME\":\"SALESMAN\",\"MP_VALUE\":\"Qui commodi incidunt iure odit.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-05 06:52:02\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":539224,\"FA_DOC_ID\":1460744,\"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-02-26 18:13: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." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1460745,\"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-02-08 13:47: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-02-23 07:51:37\",\"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\":14753309,\"MP_ML_ID\":1460745,\"MP_NAME\":\"JOB_START_TIME\",\"MP_VALUE\":\"Voluptatem laboriosam praesentium quis adipisci.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-18 04:10:27\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":539225,\"FA_DOC_ID\":1460745,\"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-04-11 04:23:29\",\"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\":[{\"name\":\"architecto\",\"value\":\"architecto\"}]}" }, "description": " Updates an existing maintenance process via maintenance_task_edit stored procedure." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"ID\":1460746,\"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-03-29 23:08:04\",\"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-01-05 15:30:24\",\"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\":14753310,\"MP_ML_ID\":1460746,\"MP_NAME\":\"SALESMAN\",\"MP_VALUE\":\"Qui commodi incidunt iure odit.\",\"MP_INDEX\":null,\"MP_VALUE_UTF8\":null,\"MP_UPDATED\":\"2026-03-05 06:52:02\",\"MP_L_ID\":null}],\"attachments\":[{\"FA_ID\":539226,\"FA_DOC_ID\":1460746,\"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-02-26 18:13: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.\n Requires 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": "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\":491669,\"DR_U_ID\":299,\"DR_START\":\"2025-08-27 07:36:41\",\"DR_STATE\":\"REMINDER_ACK\",\"DR_ORDER\":4,\"DR_PROVISIONING\":1,\"DR_END\":null,\"DR_SUSPENDED_TO\":null,\"DR_UNBLOCK_FEE\":0,\"DR_CHANGED\":null,\"DR_L_ID\":null},{\"DR_ID\":491670,\"DR_U_ID\":8082,\"DR_START\":\"2025-01-17 17:03:54\",\"DR_STATE\":\"BLOCKED\",\"DR_ORDER\":2,\"DR_PROVISIONING\":0,\"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\":491671,\"DR_U_ID\":2878,\"DR_START\":\"2024-08-04 05:50:08\",\"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\":5516,\"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\":5517,\"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\":5518,\"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\":1839459,\"RH_DOC_ID\":80304,\"USER_ID\":2617,\"DATE_REMIND\":\"2010-09-17\",\"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\":5518,\"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\":1839460,\"RH_DOC_ID\":79198,\"USER_ID\":2839,\"DATE_REMIND\":\"2006-09-25\",\"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\":4109519,\"ID_REMIND\":1839460,\"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\":1839461,\"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\":4109520,\"ID_REMIND\":1839461,\"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\":1839462,\"RH_DOC_ID\":79198,\"USER_ID\":2839,\"DATE_REMIND\":\"2006-09-25\",\"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\":4109521,\"ID_REMIND\":1839462,\"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).\n No CT or partner scoping \u2014 this is a system-wide catalogue of available rights." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"RD_ID\":3694,\"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\":3695,\"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\":73,\"SCL_ORGNUM\":857680,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":599,\"SCL_LIMIT_DAY\":26,\"SCL_NOTE\":\"Qui commodi incidunt iure odit.\",\"SCL_CP_ID\":64,\"SCL_COLLECTION_TYPE\":\"SIPO\",\"SCL_MATURITY\":45,\"SCL_CREATED\":\"2026-02-04 07:48:07\",\"SCL_CREATE_L_ID\":247,\"locations\":[{\"SCLL_ID\":159,\"SCLL_SCL_ID\":73,\"SCLL_CT\":66,\"SCLL_PROVIDER_USER_ID\":null}]},{\"SCL_ID\":74,\"SCL_ORGNUM\":469606,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":994,\"SCL_LIMIT_DAY\":16,\"SCL_NOTE\":\"Dolores enim non facere tempora.\",\"SCL_CP_ID\":173,\"SCL_COLLECTION_TYPE\":\"FETCH\",\"SCL_MATURITY\":51,\"SCL_CREATED\":\"2026-02-09 05:42:05\",\"SCL_CREATE_L_ID\":292,\"locations\":[{\"SCLL_ID\":160,\"SCLL_SCL_ID\":74,\"SCLL_CT\":29,\"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\":75,\"SCL_ORGNUM\":857680,\"SCL_EXPORT_TYPE\":\"FULL\",\"SCL_PA_ID\":997,\"SCL_LIMIT_DAY\":26,\"SCL_NOTE\":\"Qui commodi incidunt iure odit.\",\"SCL_CP_ID\":82,\"SCL_COLLECTION_TYPE\":\"SIPO\",\"SCL_MATURITY\":45,\"SCL_CREATED\":\"2026-02-04 07:48:07\",\"SCL_CREATE_L_ID\":247,\"locations\":[{\"SCLL_ID\":161,\"SCLL_SCL_ID\":75,\"SCLL_CT\":97,\"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\":20859,\"SL_DATE\":\"1981-11-24\",\"SL_MONTH\":1,\"SL_YEAR\":2024,\"SL_CT\":556,\"SL_CREATION\":\"2026-03-08 11:29:09\",\"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\":20860,\"SL_DATE\":\"2018-11-23\",\"SL_MONTH\":7,\"SL_YEAR\":2021,\"SL_CT\":383,\"SL_CREATION\":\"2026-02-09 00:40:29\",\"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\":20861,\"SL_DATE\":\"1981-11-24\",\"SL_MONTH\":1,\"SL_YEAR\":2024,\"SL_CT\":556,\"SL_CREATION\":\"2026-03-08 11:29:09\",\"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\":10028765,\"SD_SL_ID\":4609,\"SD_USER_ID\":419465,\"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\":\"1990-02-03\",\"SD_EU\":null,\"SD_TAX\":null,\"SD_PAY\":null,\"SD_TAX_ACTUAL\":null,\"SD_FUNDS_IN_TRANSIT\":null,\"SD_OVERPAYMENT\":null},{\"SD_ID\":10028766,\"SD_SL_ID\":20054,\"SD_USER_ID\":492863,\"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.\n By default only enabled definitions are returned (SN_DISABLED=0).\n Use the `disabled` filter to include\/filter disabled definitions." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":185286,\"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\":1867326,\"SERVICES_NAME_ID\":185286,\"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\":185287,\"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\":1867327,\"SERVICES_NAME_ID\":185287,\"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\":185288,\"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\":1867328,\"SERVICES_NAME_ID\":185288,\"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\":126932,\"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\":126933,\"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\":126934,\"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.)\n with their location availability and default maturity settings." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"ID\":\"chalfyear\",\"NAME\":\"pololet\\u00ed\",\"PP_FLOATING\":0,\"PP_MONTHS\":6,\"PP_ACTIVE\":1,\"PP_DISCOUNT\":\"halfyear\",\"PP_NUMBER\":2,\"locations\":[{\"PPL_ID\":1,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":1},{\"PPL_ID\":9,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":3},{\"PPL_ID\":17,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":4},{\"PPL_ID\":25,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":5},{\"PPL_ID\":33,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":6},{\"PPL_ID\":41,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":7},{\"PPL_ID\":49,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":10},{\"PPL_ID\":57,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":13},{\"PPL_ID\":65,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":15},{\"PPL_ID\":73,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":39},{\"PPL_ID\":81,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":45},{\"PPL_ID\":89,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":46},{\"PPL_ID\":97,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":58},{\"PPL_ID\":105,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":59},{\"PPL_ID\":113,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":63},{\"PPL_ID\":121,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":65},{\"PPL_ID\":129,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":66},{\"PPL_ID\":137,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":67},{\"PPL_ID\":145,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":69},{\"PPL_ID\":153,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":70},{\"PPL_ID\":161,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":71},{\"PPL_ID\":169,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":72},{\"PPL_ID\":177,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":73},{\"PPL_ID\":185,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":75},{\"PPL_ID\":193,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":78},{\"PPL_ID\":201,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":82},{\"PPL_ID\":209,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":90},{\"PPL_ID\":217,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":98},{\"PPL_ID\":225,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":100},{\"PPL_ID\":233,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":105},{\"PPL_ID\":241,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":107},{\"PPL_ID\":249,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":108},{\"PPL_ID\":257,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":110},{\"PPL_ID\":265,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":111},{\"PPL_ID\":273,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":112},{\"PPL_ID\":281,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":113},{\"PPL_ID\":289,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":114},{\"PPL_ID\":297,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":119},{\"PPL_ID\":305,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":122},{\"PPL_ID\":313,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":123},{\"PPL_ID\":321,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":126},{\"PPL_ID\":329,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":129},{\"PPL_ID\":337,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":131},{\"PPL_ID\":345,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":133},{\"PPL_ID\":353,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":134},{\"PPL_ID\":361,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":139},{\"PPL_ID\":369,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":140},{\"PPL_ID\":377,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":141},{\"PPL_ID\":385,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":142},{\"PPL_ID\":393,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":145},{\"PPL_ID\":401,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":146},{\"PPL_ID\":409,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":147},{\"PPL_ID\":417,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":148},{\"PPL_ID\":425,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":151},{\"PPL_ID\":433,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":152},{\"PPL_ID\":524,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":156},{\"PPL_ID\":530,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":157},{\"PPL_ID\":551,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":179},{\"PPL_ID\":569,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":182},{\"PPL_ID\":617,\"PPL_PP_ID\":\"chalfyear\",\"PPL_CT\":null,\"PPL_CP\":188}],\"maturity_defaults\":[{\"PMD_ID\":\"chalfyear\",\"PMD_MATURITY\":45,\"PMD_CT\":27}]},{\"ID\":\"cyears3\",\"NAME\":\"t\\u0159i roky\",\"PP_FLOATING\":0,\"PP_MONTHS\":36,\"PP_ACTIVE\":1,\"PP_DISCOUNT\":\"years3\",\"PP_NUMBER\":1,\"locations\":[],\"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.\n This 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.\n The template body (TT_TEMPLATE) is excluded from the list response for performance.\n Use the detail endpoint to retrieve the full body." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"TT_ID\":13748,\"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\":77,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":183041,\"TTP_TT_ID\":13748,\"TTP_NAME\":\"AB\",\"TTP_VALUE\":\"17\"}],\"type\":{\"TTT_ID\":77,\"TTT_TYPE\":\"recusandae\",\"TTT_TITLE\":\"Rerum ex repellendus.\",\"TTT_CONTENT_TYPE\":\"text\",\"TTT_USER_EDITABLE\":1,\"TTT_VAR_PREFIX\":\"{\",\"TTT_VAR_SUFFIX\":\"}\",\"TTT_AUTOSELECT\":\"DISABLE\"}},{\"TT_ID\":13749,\"TT_CT\":8,\"TT_NAME\":\"TMPL_TWBKMKFT\",\"TT_TEMPLATE\":\"Doloribus repellat officiis corporis nesciunt ut ratione iure. Molestiae ut rem est esse. Aut molestiae sunt suscipit doloribus fugiat. Aut deserunt et error neque recusandae et. Dolorem et ut dicta.\",\"TT_DESCRIPTION\":\"Id a consectetur assumenda eaque neque.\",\"TT_CONTENT_TYPE\":\"text\",\"TT_TTT_ID\":78,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":183042,\"TTP_TT_ID\":13749,\"TTP_NAME\":\"DOLOREM\",\"TTP_VALUE\":\"33\"}],\"type\":{\"TTT_ID\":78,\"TTT_TYPE\":\"sunt\",\"TTT_TITLE\":\"Accusantium odit.\",\"TTT_CONTENT_TYPE\":\"html\",\"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\":13750,\"TT_CT\":49,\"TT_NAME\":\"TMPL_SITCPSCQ\",\"TT_TEMPLATE\":\"Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci. Fugit deleniti distinctio eum doloremque id aut libero. Veniam corporis dolorem mollitia.\",\"TT_DESCRIPTION\":\"Modi rerum ex repellendus assumenda.\",\"TT_CONTENT_TYPE\":\"text\",\"TT_TTT_ID\":79,\"TT_FORMAT\":null,\"params\":[{\"TTP_ID\":183043,\"TTP_TT_ID\":13750,\"TTP_NAME\":\"DOLORES\",\"TTP_VALUE\":\"44\"}],\"type\":{\"TTT_ID\":79,\"TTT_TYPE\":\"tenetur\",\"TTT_TITLE\":\"Reiciendis quia perspiciatis deserunt.\",\"TTT_CONTENT_TYPE\":\"text,html,pdf\",\"TTT_USER_EDITABLE\":0,\"TTT_VAR_PREFIX\":\"{\",\"TTT_VAR_SUFFIX\":\"}\",\"TTT_AUTOSELECT\":\"ENABLE\"}}}", "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 } ], "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" }, "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\":32137,\"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\":34099,\"TTWBO_TTW_ID\":32137,\"TTWBO_OBJECT_ID\":2327,\"TTWBO_OBJECT_TYPE\":\"maintenance_job\"}]},{\"TTW_ID\":32138,\"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\":34100,\"TTWBO_TTW_ID\":32138,\"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,\"cp\":0,\"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\":32139,\"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-02-22 23:30:33\",\"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\":34101,\"TTWBO_TTW_ID\":32139,\"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\":32140,\"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\":34102,\"TTWBO_TTW_ID\":32140,\"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,\"cp\":0,\"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\":32141,\"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-02-24 10:58:15\",\"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\":34103,\"TTWBO_TTW_ID\":32141,\"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 } ], "raw": "{{baseUrl}}\/api\/v3\/time-tracking\/activities?ids=1%2C2%2C3&worker_id=294&work_id=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": " 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\":632516,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-09-25\",\"TTA_TIME_FROM\":\"20:47:12\",\"TTA_TIME_TO\":\"23:42:49\",\"TTA_TIME_TOTAL_MINS\":160,\"TTA_APPROVED\":0,\"TTA_DESCRIPTION\":null,\"TTA_TIME_ACCOUNTED_MINS\":null},{\"TTA_ID\":632517,\"TTA_TTW_ID\":765,\"TTA_L_ID\":633,\"TTA_DATE\":\"1973-12-17\",\"TTA_TIME_FROM\":\"10:24:12\",\"TTA_TIME_TO\":\"18: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\":632518,\"TTA_TTW_ID\":899,\"TTA_L_ID\":778,\"TTA_DATE\":\"2007-02-06\",\"TTA_TIME_FROM\":\"04:54:01\",\"TTA_TIME_TO\":\"02:42:34\",\"TTA_TIME_TOTAL_MINS\":383,\"TTA_APPROVED\":1,\"TTA_DESCRIPTION\":\"Provident perspiciatis quo omnis nostrum aut adipisci quidem.\",\"TTA_TIME_ACCOUNTED_MINS\":362}}", "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\":632519,\"TTA_TTW_ID\":592,\"TTA_L_ID\":751,\"TTA_DATE\":\"2006-09-25\",\"TTA_TIME_FROM\":\"20:47:12\",\"TTA_TIME_TO\":\"23:42:48\",\"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\":632520,\"TTA_TTW_ID\":899,\"TTA_L_ID\":778,\"TTA_DATE\":\"2007-02-06\",\"TTA_TIME_FROM\":\"04:54:01\",\"TTA_TIME_TO\":\"02:42:34\",\"TTA_TIME_TOTAL_MINS\":383,\"TTA_APPROVED\":1,\"TTA_DESCRIPTION\":\"Provident perspiciatis quo omnis nostrum aut adipisci quidem.\",\"TTA_TIME_ACCOUNTED_MINS\":362}}", "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\":32,\"name\":\"aut\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-04-15T14:55:08.000000Z\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5552,\"FIRST_NAME\":\"Noah\",\"SURNAME\":\"Cronin\",\"LOGIN\":\"emelie.baumbach\",\"PASSWORD\":\"random_password\",\"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,\"L_PIN\":null,\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":\"0484\",\"L_CREATED\":\"2026-03-03 05:14:19\",\"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_PASS_CODE\":\"847820\",\"L_PASS_CODE_CREATED\":null,\"L_CACHE_INITIALS\":\"ew\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":1}},{\"id\":33,\"name\":\"molestiae\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-04-15T14:55:08.000000Z\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5553,\"FIRST_NAME\":\"Nina\",\"SURNAME\":\"Wisoky\",\"LOGIN\":\"jazmyne.heathcote\",\"PASSWORD\":\"random_password\",\"L_LEVEL\":3,\"MAIL\":\"zstoltenberg@example.org\",\"PHONE\":null,\"NOTE\":null,\"SALESMAN\":1,\"L_SMS_ENABLE\":1,\"L_PIN\":\"3735\",\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-04-10 14:43:30\",\"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_PASS_CODE\":null,\"L_PASS_CODE_CREATED\":\"2026-01-30 07:43:25\",\"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\":34,\"name\":\"adipisci\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-04-15T14:55:08.000000Z\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5554,\"FIRST_NAME\":\"Amber\",\"SURNAME\":\"Dare\",\"LOGIN\":\"wleuschke\",\"PASSWORD\":\"random_password\",\"L_LEVEL\":10,\"MAIL\":\"carey67@example.com\",\"PHONE\":6431064321,\"NOTE\":\"Voluptatem laboriosam praesentium quis adipisci. Fugit deleniti distinctio eum doloremque id aut libero. Veniam corporis dolorem mollitia.\",\"SALESMAN\":1,\"L_SMS_ENABLE\":0,\"L_PIN\":\"5182\",\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":null,\"L_CREATED\":\"2026-04-11 05:41:21\",\"L_L_ID\":39,\"L_ACTIVE\":1,\"L_PASS_EXPIRE\":null,\"L_PASS_CHANGE\":null,\"L_TYPE\":\"PERSON\",\"L_SIGNATURE\":null,\"L_SELFCARE\":1,\"L_PASS_CODE\":null,\"L_PASS_CODE_CREATED\":null,\"L_CACHE_INITIALS\":\"kf\",\"L_INITIALS\":null,\"L_STATISTICS_ENABLE\":0}},{\"id\":35,\"name\":\"odit\",\"abilities\":[\"all\"],\"last_used_at\":null,\"expires_at\":null,\"created_at\":\"2026-04-15T14:55:08.000000Z\",\"tokenable_type\":\"App\\\\Models\\\\Login\",\"tokenable\":{\"ID\":5555,\"FIRST_NAME\":\"Walker\",\"SURNAME\":\"Bernhard\",\"LOGIN\":\"nkreiger\",\"PASSWORD\":\"random_password\",\"L_LEVEL\":2,\"MAIL\":\"tressa41@example.com\",\"PHONE\":null,\"NOTE\":\"Molestiae sunt suscipit doloribus fugiat ut aut. Et error neque recusandae et. Dolorem et ut dicta. Consequatur ut et sunt quisquam sit repellendus ut. Alias ratione dolores sed rem. Ut aut deserunt sint quis in quod id aspernatur.\",\"SALESMAN\":0,\"L_SMS_ENABLE\":0,\"L_PIN\":\"5425\",\"LOG_LEVEL\":\"INFO\",\"L_CP_ID\":\"0436\",\"L_CREATED\":\"2026-04-07 06:02:09\",\"L_L_ID\":2,\"L_ACTIVE\":0,\"L_PASS_EXPIRE\":-273,\"L_PASS_CHANGE\":\"2026-01-23 18:19:27\",\"L_TYPE\":\"COOPERATION\",\"L_SIGNATURE\":\"Aut ex quo iure eos explicabo accusamus. Et qui ipsa itaque autem mollitia.\",\"L_SELFCARE\":0,\"L_PASS_CODE\":null,\"L_PASS_CODE_CREATED\":null,\"L_CACHE_INITIALS\":\"kz\",\"L_INITIALS\":\"aw\",\"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\"}" }, "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": "" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }