{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "http:\/\/localhost" } ], "info": { "name": "EPIC", "_postman_id": "34a2b77b-bc88-4825-b354-82e6b2c5968f", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Admin Dashboard", "description": "All other endpoints", "item": [ { "name": "Retrieve various metrics for the admin dashboard (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/dashboard", "query": [], "raw": "{{baseUrl}}\/api\/v1\/dashboard" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Crudy Endpoints", "description": "All Crudy endpoints", "item": [ { "name": "Salary warning", "description": "", "item": [ { "name": "Fetch a Salary warning by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-warnings\/:salaryWarningId", "query": [ { "key": "include", "value": "employee%2CsalaryRule", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/salary-warnings\/:salaryWarningId?include=employee%2CsalaryRule", "variable": [ { "id": "salaryWarningId", "key": "salaryWarningId", "value": "hic", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"SalaryWarning [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Salary warnings with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-warnings", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "employee%2CsalaryRule", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/salary-warnings?page=1&pageSize=15&withSoftDeletes=1&include=employee%2CsalaryRule" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Salary warnings based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-warnings\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "employee%2CsalaryRule", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/salary-warnings\/search?page=1&pageSize=15&withSoftDeletes=1&include=employee%2CsalaryRule" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"confirmedBy\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"salaryRuleId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"employeeId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"salaryPeriod\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Company integration", "description": "", "item": [ { "name": "Create a new Company integration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalIntegrationId\":\"eos\",\"companyId\":\"sit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Company integrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"externalIntegrationId\":\"id\",\"companyId\":\"laborum\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Company integration by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/:companyIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/:companyIntegrationId?include=", "variable": [ { "id": "companyIntegrationId", "key": "companyIntegrationId", "value": "iusto", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Company integrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Update a Company integration by its ID (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/:companyIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/:companyIntegrationId?include=", "variable": [ { "id": "companyIntegrationId", "key": "companyIntegrationId", "value": "voluptates", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Company integrations by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"sunt\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Company integration by its ID (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/:companyIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/:companyIntegrationId?include=", "variable": [ { "id": "companyIntegrationId", "key": "companyIntegrationId", "value": "voluptatibus", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Company integrations with pagination (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Company integrations based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"externalIntegrationId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Integration type", "description": "", "item": [ { "name": "Fetch a list of Integration types with pagination (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integration-types", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/integration-types?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Integration types based on the provided filters, scopes, sorting and pagination (Stability Score: 0.5)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/integration-types\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/integration-types\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"name\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "User", "description": "", "item": [ { "name": "Fetch a list of Users with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/users?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Users based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/users\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Notification", "description": "", "item": [ { "name": "Fetch a list of Notifications with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/notifications?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Notifications based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/notifications\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"readAt\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Employee field", "description": "", "item": [ { "name": "Create a new Employee field", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employee-fields", "query": [ { "key": "include", "value": "combinedFields", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/employee-fields?include=combinedFields" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":false,\"salarySensitive\":true,\"sensitive\":false,\"allowNewValue\":true,\"observe\":true,\"importExcluded\":true,\"manualInput\":false,\"fieldType\":\"number\",\"dataType\":\"date\",\"maxInput\":96,\"minInput\":5.262827656,\"maxLength\":4857812.8,\"minLength\":439003.0755778,\"fieldName\":\"fczchmxmqlrpvf\",\"combinedFieldIds\":[\"animi\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a Employee field by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employee-fields\/:employeeFieldId", "query": [ { "key": "include", "value": "combinedFields", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/employee-fields\/:employeeFieldId?include=combinedFields", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "est", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmployeeField [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Update a Employee field by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employee-fields\/:employeeFieldId", "query": [ { "key": "include", "value": "combinedFields", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/employee-fields\/:employeeFieldId?include=combinedFields", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "iure", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":true,\"sensitive\":true,\"allowNewValue\":false,\"observe\":false,\"importExcluded\":true,\"manualInput\":true,\"fieldType\":\"checkbox\",\"dataType\":\"string\",\"maxInput\":6239,\"minInput\":87812023,\"maxLength\":4819160.833784439,\"minLength\":308791.909123419,\"combinedFieldIds\":[\"consequatur\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmployeeField [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Delete a Employee field by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employee-fields\/:employeeFieldId", "query": [ { "key": "include", "value": "combinedFields", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/employee-fields\/:employeeFieldId?include=combinedFields", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "voluptas", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmployeeField [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Employee fields with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employee-fields", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "combinedFields", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/employee-fields?page=1&pageSize=15&withSoftDeletes=1&include=combinedFields" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Log entity", "description": "", "item": [ { "name": "Fetch a list of Log entities with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/log-entities", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/log-entities?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Log entities based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/log-entities\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/log-entities\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"entity\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"entityId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"action\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"createdBy\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"createdAt\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Variable type", "description": "", "item": [ { "name": "Create a new Variable type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Eius maiores quod et dolor qui occaecati.\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Variable types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"description\":\"Voluptas et sed consectetur itaque placeat sed id.\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Variable type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/:variableTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/:variableTypeId?include=", "variable": [ { "id": "variableTypeId", "key": "variableTypeId", "value": "quo", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"VariableType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Variable types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"description\":\"Molestiae voluptas accusamus inventore id.\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Variable type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/:variableTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/:variableTypeId?include=", "variable": [ { "id": "variableTypeId", "key": "variableTypeId", "value": "perspiciatis", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Non repellendus quas autem dolore omnis.\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"VariableType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Variable types by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"et\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Variable type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/:variableTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/:variableTypeId?include=", "variable": [ { "id": "variableTypeId", "key": "variableTypeId", "value": "quis", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"VariableType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Variable types with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Variable types based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/variable-types\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/variable-types\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Salary rule", "description": "", "item": [ { "name": "Create a new Salary rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"fuga\",\"warning\":\"quae\",\"solutionDescription\":\"molestiae\",\"ruleExpression\":[{\"type\":\"logical_operator\",\"payCodeIds\":[13],\"previous_periods\":1,\"diff_type\":\"real\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a Salary rule by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules\/:salaryRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules\/:salaryRuleId?include=", "variable": [ { "id": "salaryRuleId", "key": "salaryRuleId", "value": "veniam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"SalaryRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Update a Salary rule by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules\/:salaryRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules\/:salaryRuleId?include=", "variable": [ { "id": "salaryRuleId", "key": "salaryRuleId", "value": "omnis", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"warning\":\"quia\",\"solutionDescription\":\"necessitatibus\",\"ruleExpression\":[{\"type\":\"logical_operator\",\"payCodeIds\":[\"earum\"],\"previous_periods\":1,\"diff_type\":\"real\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"SalaryRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Delete a Salary rule by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules\/:salaryRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules\/:salaryRuleId?include=", "variable": [ { "id": "salaryRuleId", "key": "salaryRuleId", "value": "architecto", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"SalaryRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Salary rules with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Salary rules based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-rules\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/salary-rules\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Org integrations mapping", "description": "", "item": [ { "name": "Create a new Org integrations mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings?include=externalIntegration%2Corganization" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalIntegrationId\":\"labore\",\"organizationId\":\"unde\",\"notes\":\"deserunt\",\"status\":\"inactive\"}" }, "description": "" }, "response": [] }, { "name": "Batch create new Org integrations mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/batch", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/batch?include=externalIntegration%2Corganization" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"externalIntegrationId\":\"quasi\",\"organizationId\":\"aut\",\"notes\":\"quia\",\"status\":\"active\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Org integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId?include=externalIntegration%2Corganization", "variable": [ { "id": "orgIntegrationsMappingId", "key": "orgIntegrationsMappingId", "value": "ea", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch update Org integrations mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/batch", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/batch?include=externalIntegration%2Corganization" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"notes\":\"sit\",\"status\":\"inactive\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Org integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId?include=externalIntegration%2Corganization", "variable": [ { "id": "orgIntegrationsMappingId", "key": "orgIntegrationsMappingId", "value": "rerum", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notes\":\"magnam\",\"status\":\"inactive\"}" }, "description": "" }, "response": [] }, { "name": "Batch delete Org integrations mappings by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/batch", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/batch?include=externalIntegration%2Corganization" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"eum\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Org integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId", "query": [ { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/:orgIntegrationsMappingId?include=externalIntegration%2Corganization", "variable": [ { "id": "orgIntegrationsMappingId", "key": "orgIntegrationsMappingId", "value": "culpa", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetch a list of Org integrations mappings with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration%2Corganization" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Org integrations mappings based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/org-integrations-mappings\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "externalIntegration%2Corganization", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/org-integrations-mappings\/search?page=1&pageSize=15&withSoftDeletes=1&include=externalIntegration%2Corganization" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"externalIntegrationId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"organizationId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"status\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [] } ] }, { "name": "Field value matrix", "description": "", "item": [ { "name": "Create a new Field value matrix", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"cupiditate\",\"description\":\"Ut sed eius dolores rerum reprehenderit doloribus mollitia.\",\"keyFieldValue\":\"est\",\"keyFieldId\":\"est\",\"matrixFields\":[{\"fieldId\":\"ab\",\"fieldValue\":\"aut\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Field value matrices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"quae\",\"description\":\"Quo repellat eveniet pariatur quod perferendis et.\",\"keyFieldValue\":\"ut\",\"keyFieldId\":\"labore\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Field value matrix by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/:fieldValueMatrixId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/:fieldValueMatrixId?include=", "variable": [ { "id": "fieldValueMatrixId", "key": "fieldValueMatrixId", "value": "praesentium", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"FieldValueMatrix [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Field value matrices", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"ipsa\",\"description\":\"Quo qui est quidem aspernatur non repudiandae.\",\"keyFieldValue\":\"at\",\"keyFieldId\":\"eligendi\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Field value matrix by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/:fieldValueMatrixId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/:fieldValueMatrixId?include=", "variable": [ { "id": "fieldValueMatrixId", "key": "fieldValueMatrixId", "value": "quae", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"consectetur\",\"description\":\"Repellendus at illo eos ut pariatur atque.\",\"keyFieldValue\":\"excepturi\",\"keyFieldId\":\"omnis\",\"matrixFields\":[{\"fieldId\":\"vero\",\"fieldValue\":\"blanditiis\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"FieldValueMatrix [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Field value matrices by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"totam\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Field value matrix by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/:fieldValueMatrixId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/:fieldValueMatrixId?include=", "variable": [ { "id": "fieldValueMatrixId", "key": "fieldValueMatrixId", "value": "possimus", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"FieldValueMatrix [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Field value matrices with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Field value matrices based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-value-matrices\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/field-value-matrices\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"name\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"keyFieldValue\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"keyFieldId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Organization", "description": "", "item": [ { "name": "Create a new Organization", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations?include=companies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"quod\",\"orgNumber\":\"sed\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Organizations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/batch", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/batch?include=companies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"unde\",\"orgNumber\":\"minus\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Organization by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/:organizationId", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/:organizationId?include=companies", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "ut", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Organization [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Organizations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/batch", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/batch?include=companies" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"et\",\"orgNumber\":\"ut\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Organization by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/:organizationId", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/:organizationId?include=companies", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "ipsum", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"quis\",\"orgNumber\":\"sit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Organization [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Organizations by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/batch", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/batch?include=companies" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"vitae\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Organization by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/:organizationId", "query": [ { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/:organizationId?include=companies", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "ut", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Organization [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Organizations with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations?page=1&pageSize=15&withSoftDeletes=1&include=companies" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Organizations based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organizations\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "companies", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/organizations\/search?page=1&pageSize=15&withSoftDeletes=1&include=companies" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"name\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"orgNumber\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Menu", "description": "", "item": [ { "name": "Create a new Menu", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus?include=parent" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"jarclvkqmggqqlhtjfq\",\"icon\":\"vflz\",\"url\":\"http:\\\/\\\/yundt.com\\\/magni-excepturi-voluptas-voluptatem-omnis\",\"parentId\":\"maxime\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Menus", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/batch", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/batch?include=parent" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"lhbnysmjmrmviydachmhjdo\",\"icon\":\"gnpvp\",\"url\":\"http:\\\/\\\/www.smitham.com\\\/voluptatem-expedita-maxime-et-officiis-non\",\"parentId\":\"quasi\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Menu by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/:menuId", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/:menuId?include=parent", "variable": [ { "id": "menuId", "key": "menuId", "value": "non", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Menu [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Menus", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/batch", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/batch?include=parent" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"qobtdzfkkgdkmlmfpxxrywrs\",\"icon\":\"zkokdkyeraiccuilgewzhfde\",\"url\":\"https:\\\/\\\/rippin.com\\\/quod-consequatur-voluptatem-omnis-totam-unde-fugiat.html\",\"parentId\":\"beatae\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Menu by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/:menuId", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/:menuId?include=parent", "variable": [ { "id": "menuId", "key": "menuId", "value": "necessitatibus", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"tcdcckhilvxhvas\",\"icon\":\"ssyav\",\"url\":\"http:\\\/\\\/goyette.biz\\\/laboriosam-eum-velit-aut-sint-et-eligendi\",\"parentId\":\"quo\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Menu [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Menus by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/batch", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/batch?include=parent" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"repellat\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Menu by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/:menuId", "query": [ { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/:menuId?include=parent", "variable": [ { "id": "menuId", "key": "menuId", "value": "et", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Menu [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Menus with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus?page=1&pageSize=15&withSoftDeletes=1&include=parent" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Menus based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/menus\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "parent", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/menus\/search?page=1&pageSize=15&withSoftDeletes=1&include=parent" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"name\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"icon\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"url\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"parentId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Company field map", "description": "", "item": [ { "name": "Create a new Company field map", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalCompanyFieldId\":\"nemo\",\"companyFieldId\":\"amet\",\"companyId\":\"incidunt\",\"externalIntegrationId\":\"hic\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Company field maps", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/batch?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"externalCompanyFieldId\":\"similique\",\"companyFieldId\":\"dignissimos\",\"companyId\":\"architecto\",\"externalIntegrationId\":\"ut\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Company field map by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/:companyFieldMapId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/:companyFieldMapId?include=company", "variable": [ { "id": "companyFieldMapId", "key": "companyFieldMapId", "value": "quia", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyFieldMap [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Company field maps", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/batch?include=company" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"externalCompanyFieldId\":\"deserunt\",\"companyFieldId\":\"quasi\",\"companyId\":\"omnis\",\"externalIntegrationId\":\"blanditiis\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Company field map by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/:companyFieldMapId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/:companyFieldMapId?include=company", "variable": [ { "id": "companyFieldMapId", "key": "companyFieldMapId", "value": "minima", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalCompanyFieldId\":\"sint\",\"companyFieldId\":\"aut\",\"companyId\":\"unde\",\"externalIntegrationId\":\"consequatur\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyFieldMap [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Company field maps by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/batch?include=company" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"quidem\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Company field map by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/:companyFieldMapId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/:companyFieldMapId?include=company", "variable": [ { "id": "companyFieldMapId", "key": "companyFieldMapId", "value": "tempore", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanyFieldMap [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Company field maps with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Company field maps based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-field-maps\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-field-maps\/search?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Pay code variable", "description": "", "item": [ { "name": "Create a new Pay code variable", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables?include=variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"variableTypeId\":\"quas\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Pay code variables", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/batch", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/batch?include=variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"variableTypeId\":\"quaerat\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Pay code variable by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/:payCodeVariableId", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/:payCodeVariableId?include=variableType", "variable": [ { "id": "payCodeVariableId", "key": "payCodeVariableId", "value": "nobis", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeVariable [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Pay code variables", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/batch", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/batch?include=variableType" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Update a Pay code variable by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/:payCodeVariableId", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/:payCodeVariableId?include=variableType", "variable": [ { "id": "payCodeVariableId", "key": "payCodeVariableId", "value": "placeat", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeVariable [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Pay code variables by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/batch", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/batch?include=variableType" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"fugit\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Pay code variable by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/:payCodeVariableId", "query": [ { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/:payCodeVariableId?include=variableType", "variable": [ { "id": "payCodeVariableId", "key": "payCodeVariableId", "value": "omnis", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeVariable [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Pay code variables with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables?page=1&pageSize=15&withSoftDeletes=1&include=variableType" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Pay code variables based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-variables\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-variables\/search?page=1&pageSize=15&withSoftDeletes=1&include=variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"variableTypeId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Pay code type", "description": "", "item": [ { "name": "Create a new Pay code type", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payCodeTypeNumber\":2094130.7694592583}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Pay code types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"payCodeTypeNumber\":432167161.360392}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Pay code type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/:payCodeTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/:payCodeTypeId?include=", "variable": [ { "id": "payCodeTypeId", "key": "payCodeTypeId", "value": "ea", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Pay code types", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"payCodeTypeNumber\":568836.377564563}]}" }, "description": "" }, "response": [] }, { "name": "Update a Pay code type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/:payCodeTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/:payCodeTypeId?include=", "variable": [ { "id": "payCodeTypeId", "key": "payCodeTypeId", "value": "pariatur", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payCodeTypeNumber\":301.16458}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Pay code types by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"totam\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Pay code type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/:payCodeTypeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/:payCodeTypeId?include=", "variable": [ { "id": "payCodeTypeId", "key": "payCodeTypeId", "value": "soluta", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Pay code types with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Pay code types based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-types\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-types\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"payCodeTypeNumber\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Pay code mapping", "description": "", "item": [ { "name": "Create a new Pay code mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"nisi\",\"organizationId\":\"laboriosam\",\"isGlobal\":true,\"isGroup\":true,\"notes\":\"velit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Pay code mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/batch?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"companyId\":\"pariatur\",\"organizationId\":\"ea\",\"isGlobal\":true,\"isGroup\":true,\"mappings\":[],\"notes\":\"sint\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Pay code mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/:payCodeMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/:payCodeMappingId?include=company", "variable": [ { "id": "payCodeMappingId", "key": "payCodeMappingId", "value": "autem", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeMapping [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Pay code mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/batch?include=company" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"isGlobal\":false,\"isGroup\":false,\"notes\":\"et\",\"status\":\"active\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Pay code mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/:payCodeMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/:payCodeMappingId?include=company", "variable": [ { "id": "payCodeMappingId", "key": "payCodeMappingId", "value": "culpa", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":false,\"isGroup\":false,\"notes\":\"laboriosam\",\"status\":\"inactive\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeMapping [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Pay code mappings by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/batch?include=company" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"voluptatem\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Pay code mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/:payCodeMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/:payCodeMappingId?include=company", "variable": [ { "id": "payCodeMappingId", "key": "payCodeMappingId", "value": "rerum", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeMapping [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Pay code mappings with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Pay code mappings based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/search?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"isGlobal\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"isGroup\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"status\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"whiteListedPayCodeIds\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Company", "description": "", "item": [ { "name": "Create a new Company", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies?include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/batch", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/batch?include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Fetch a Company by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:companyId", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/:companyId?include=companies%2CfieldMaps%2CcompanyIntegration", "variable": [ { "id": "companyId", "key": "companyId", "value": "harum", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Company [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Companies", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/batch", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/batch?include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Update a Company by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:companyId", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/:companyId?include=companies%2CfieldMaps%2CcompanyIntegration", "variable": [ { "id": "companyId", "key": "companyId", "value": "praesentium", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Company [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Companies by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/batch", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/batch?include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"accusamus\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Company by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:companyId", "query": [ { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/:companyId?include=companies%2CfieldMaps%2CcompanyIntegration", "variable": [ { "id": "companyId", "key": "companyId", "value": "eligendi", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Company [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Companies with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies?page=1&pageSize=15&withSoftDeletes=1&include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Companies based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "companies%2CfieldMaps%2CcompanyIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/search?page=1&pageSize=15&withSoftDeletes=1&include=companies%2CfieldMaps%2CcompanyIntegration" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"companyName\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"organisationNumber\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"externalId\",\"direction\":\"asc\"},{\"field\":\"companyId\",\"direction\":\"asc\"},{\"field\":\"companyName\",\"direction\":\"asc\"},{\"field\":\"organisationNumber\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Company integrations mapping", "description": "", "item": [ { "name": "Create a new Company integrations mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalIntegrationId\":\"qui\",\"companyId\":\"nesciunt\",\"notes\":\"molestiae\",\"status\":\"inactive\"}" }, "description": "" }, "response": [] }, { "name": "Batch create new Company integrations mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/batch?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"externalIntegrationId\":\"exercitationem\",\"companyId\":\"quo\",\"notes\":\"magnam\",\"status\":\"active\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Company integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId?include=company", "variable": [ { "id": "companyIntegrationsMappingId", "key": "companyIntegrationsMappingId", "value": "voluptates", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch update Company integrations mappings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/batch?include=company" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"notes\":\"placeat\",\"status\":\"inactive\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Company integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId?include=company", "variable": [ { "id": "companyIntegrationsMappingId", "key": "companyIntegrationsMappingId", "value": "rerum", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"notes\":\"vitae\",\"status\":\"inactive\"}" }, "description": "" }, "response": [] }, { "name": "Batch delete Company integrations mappings by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/batch?include=company" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"et\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Company integrations mapping by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/:companyIntegrationsMappingId?include=company", "variable": [ { "id": "companyIntegrationsMappingId", "key": "companyIntegrationsMappingId", "value": "totam", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetch a list of Company integrations mappings with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Company integrations mappings based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-integrations-mappings\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-integrations-mappings\/search?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [] } ] }, { "name": "Company settings", "description": "", "item": [ { "name": "Create a new Company settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"defaultLocale\":\"es_PE\",\"defaultProfile\":\"tempora\",\"activeProfile\":\"voluptatem\",\"companyId\":\"molestiae\",\"organizationId\":\"non\",\"organisationNumber\":\"nisi\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Company settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/batch?include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"defaultLocale\":\"dz_BT\",\"defaultProfile\":\"maiores\",\"activeProfile\":\"officia\",\"companyId\":\"numquam\",\"organizationId\":\"ipsum\",\"organisationNumber\":\"modi\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Company settings by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/:companySettingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/:companySettingId?include=company", "variable": [ { "id": "companySettingId", "key": "companySettingId", "value": "illo", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanySettings [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Company settings", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/batch?include=company" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"defaultLocale\":\"uk_UA\",\"defaultProfile\":\"aliquid\",\"activeProfile\":\"qui\",\"organisationNumber\":\"et\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Company settings by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/:companySettingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/:companySettingId?include=company", "variable": [ { "id": "companySettingId", "key": "companySettingId", "value": "eius", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"defaultLocale\":\"to_TO\",\"defaultProfile\":\"quae\",\"activeProfile\":\"et\",\"organisationNumber\":\"sit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanySettings [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Company settings by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/batch", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/batch?include=company" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"dignissimos\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Company settings by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/:companySettingId", "query": [ { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/:companySettingId?include=company", "variable": [ { "id": "companySettingId", "key": "companySettingId", "value": "recusandae", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"deserunt\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"CompanySettings [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Company settings with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Company settings based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company-settings\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/company-settings\/search?page=1&pageSize=15&withSoftDeletes=1&include=company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"organisationId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Pay code group", "description": "", "item": [ { "name": "Create a new Pay code group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups?include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payCodeGroupNumber\":172568.8,\"payCodeVariableIds\":[\"quo\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Pay code groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/batch", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/batch?include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"payCodeGroupNumber\":1886.1,\"payCodeVariableIds\":[]}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Pay code group by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/:payCodeGroupId", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/:payCodeGroupId?include=payCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeGroupId", "key": "payCodeGroupId", "value": "doloribus", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeGroup [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Pay code groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/batch", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/batch?include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"payCodeGroupNumber\":1820}]}" }, "description": "" }, "response": [] }, { "name": "Update a Pay code group by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/:payCodeGroupId", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/:payCodeGroupId?include=payCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeGroupId", "key": "payCodeGroupId", "value": "veniam", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payCodeGroupNumber\":650692960.91821,\"payCodeVariableIds\":[\"quia\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeGroup [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Pay code groups by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/batch", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/batch?include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"recusandae\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Pay code group by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/:payCodeGroupId", "query": [ { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/:payCodeGroupId?include=payCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeGroupId", "key": "payCodeGroupId", "value": "autem", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCodeGroup [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Pay code groups with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups?page=1&pageSize=15&withSoftDeletes=1&include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Pay code groups based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-groups\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "payCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-code-groups\/search?page=1&pageSize=15&withSoftDeletes=1&include=payCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"payCodeGroupNumber\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeVariableIds\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "External integration", "description": "", "item": [ { "name": "Create a new External integration", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"integrationName\":\"nemo\",\"description\":\"Molestiae illum officia rerum cumque iusto voluptatum enim voluptatem.\",\"status\":\"inactive\",\"integrationTypeId\":\"et\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new External integrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"integrationName\":\"culpa\",\"description\":\"Laudantium veritatis incidunt ex deserunt facilis.\",\"status\":\"inactive\",\"integrationTypeId\":\"in\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a External integration by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/:externalIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/:externalIntegrationId?include=", "variable": [ { "id": "externalIntegrationId", "key": "externalIntegrationId", "value": "corrupti", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"ExternalIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update External integrations", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"description\":\"Deleniti et voluptas voluptatem voluptatem.\",\"status\":\"inactive\",\"integrationTypeId\":\"pariatur\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a External integration by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/:externalIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/:externalIntegrationId?include=", "variable": [ { "id": "externalIntegrationId", "key": "externalIntegrationId", "value": "cum", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"description\":\"Nisi sed natus nulla dolores veritatis.\",\"status\":\"inactive\",\"integrationTypeId\":\"suscipit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"ExternalIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete External integrations by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"iste\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a External integration by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/:externalIntegrationId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/:externalIntegrationId?include=", "variable": [ { "id": "externalIntegrationId", "key": "externalIntegrationId", "value": "ad", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"ExternalIntegration [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of External integrations with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of External integrations based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integrations\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/external-integrations\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"integrationName\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"status\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Pay code", "description": "", "item": [ { "name": "Create a new Pay code", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"adipisci\",\"integrationId\":\"molestiae\",\"organizationId\":\"autem\",\"payCodeNumber\":163,\"payCodeGroupId\":\"est\",\"payCodeTypeId\":\"porro\",\"payCodeVariableIds\":[\"enim\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Pay codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/batch", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"companyId\":\"dicta\",\"integrationId\":\"quod\",\"organizationId\":\"qui\",\"payCodeNumber\":52173309.2462472,\"payCodeGroupId\":\"aut\",\"payCodeTypeId\":\"beatae\",\"payCodeVariableIds\":[]}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Pay code by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/:payCodeId", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/:payCodeId?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeId", "key": "payCodeId", "value": "iure", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCode [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Pay codes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/batch", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"payCodeNumber\":351.1508298,\"payCodeGroupId\":\"voluptas\",\"payCodeTypeId\":\"ullam\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Pay code by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/:payCodeId", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/:payCodeId?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeId", "key": "payCodeId", "value": "eligendi", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"payCodeNumber\":1526.6751,\"payCodeGroupId\":\"repellendus\",\"payCodeTypeId\":\"est\",\"payCodeVariableIds\":[\"numquam\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCode [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Pay codes by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/batch", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/batch?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"dolorum\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Pay code by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/:payCodeId", "query": [ { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/:payCodeId?include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "variable": [ { "id": "payCodeId", "key": "payCodeId", "value": "omnis", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PayCode [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Pay codes with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes?page=1&pageSize=15&withSoftDeletes=1&include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Pay codes based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-codes\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/pay-codes\/search?page=1&pageSize=15&withSoftDeletes=1&include=payCodeGroup%2CpayCodeType%2CpayCodeVariables%2CpayCodeVariables.variableType" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"organizationId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"integrationId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeNumber\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeGroupId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeTypeId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeVariableIds\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"payCodeNumber\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Personal card profile", "description": "", "item": [ { "name": "Create a new Personal card profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"omnis\",\"tabs\":[{\"order\":654283.881,\"personalCardProfileTabId\":\"at\",\"grids\":[{\"order\":1,\"personalCardProfileTabGridId\":\"aut\",\"fieldGroupId\":\"qui\",\"fields\":[{\"order\":1791.1527595,\"fieldId\":\"qui\"}]}]}],\"description\":\"Qui labore fugit eveniet et distinctio.\",\"isGlobal\":\"eligendi\",\"companyId\":\"deserunt\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Personal card profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"name\":\"harum\",\"description\":\"Voluptatem nam et dolores.\",\"isGlobal\":\"iste\",\"companyId\":\"voluptatem\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Personal card profile by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/:personalCardProfileId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/:personalCardProfileId?include=", "variable": [ { "id": "personalCardProfileId", "key": "personalCardProfileId", "value": "quibusdam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":\"a\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfile [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Personal card profiles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"debitis\",\"description\":\"Sunt qui itaque voluptates necessitatibus.\",\"tabs\":[{\"order\":4489190.5,\"personalCardProfileTabId\":\"ullam\",\"grids\":[{\"order\":120.5959,\"personalCardProfileTabGridId\":\"occaecati\",\"fieldGroupId\":\"et\",\"fields\":[{\"order\":5.7453899,\"fieldId\":\"est\"}]}]}],\"isGlobal\":\"nisi\",\"companyId\":\"enim\"}" }, "description": "" }, "response": [] }, { "name": "Update a Personal card profile by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/:personalCardProfileId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/:personalCardProfileId?include=", "variable": [ { "id": "personalCardProfileId", "key": "personalCardProfileId", "value": "dolor", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"aliquam\",\"description\":\"Corporis et consequuntur excepturi voluptate.\",\"tabs\":[{\"order\":463006583.02,\"personalCardProfileTabId\":\"suscipit\",\"grids\":[{\"order\":40.8,\"personalCardProfileTabGridId\":\"quo\",\"fieldGroupId\":\"nesciunt\",\"fields\":[{\"order\":53.52108,\"fieldId\":\"excepturi\"}]}]}],\"isGlobal\":\"fuga\",\"companyId\":\"expedita\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfile [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Personal card profiles by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":\"voluptas\"}" }, "description": "" }, "response": [] }, { "name": "Delete a Personal card profile by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/:personalCardProfileId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/:personalCardProfileId?include=", "variable": [ { "id": "personalCardProfileId", "key": "personalCardProfileId", "value": "nemo", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":\"dolor\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfile [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Personal card profiles with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":\"debitis\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Personal card profiles based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"isGlobal\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"name\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Personal card profile tab grid", "description": "", "item": [ { "name": "Create a new Personal card profile tab grid", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"tabId\":\"esse\",\"isGlobal\":false,\"description\":\"In qui totam sequi aliquam non.\",\"fieldGroupId\":\"velit\",\"fields\":[{\"globalFieldId\":\"sunt\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Personal card profile tab grids", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"tabId\":\"dolores\",\"isGlobal\":false,\"description\":\"Molestias repellat rerum porro debitis accusantium et culpa.\",\"fieldGroupId\":\"aut\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Personal card profile tab grid by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId?include=", "variable": [ { "id": "personalCardProfileTabGridId", "key": "personalCardProfileTabGridId", "value": "id", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTabGrid [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Personal card profile tab grids", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"isGlobal\":true,\"description\":\"Quaerat illo sunt dolor impedit.\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Personal card profile tab grid by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId?include=", "variable": [ { "id": "personalCardProfileTabGridId", "key": "personalCardProfileTabGridId", "value": "reprehenderit", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":false,\"description\":\"Sapiente earum et qui eligendi.\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTabGrid [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Personal card profile tab grids by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"voluptas\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Personal card profile tab grid by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/:personalCardProfileTabGridId?include=", "variable": [ { "id": "personalCardProfileTabGridId", "key": "personalCardProfileTabGridId", "value": "est", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTabGrid [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Personal card profile tab grids with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Personal card profile tab grids based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tab-grids\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tab-grids\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"isGlobal\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Personal card profile tab", "description": "", "item": [ { "name": "Create a new Personal card profile tab", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":false,\"description\":\"Impedit alias debitis voluptatum quibusdam est.\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Personal card profile tabs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"isGlobal\":true,\"description\":\"Tempora quae saepe sit rerum.\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Personal card profile tab by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId?include=", "variable": [ { "id": "personalCardProfileTabId", "key": "personalCardProfileTabId", "value": "ut", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTab [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Personal card profile tabs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"isGlobal\":true,\"description\":\"Exercitationem quisquam iste deserunt dolorem modi eaque quo.\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Personal card profile tab by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId?include=", "variable": [ { "id": "personalCardProfileTabId", "key": "personalCardProfileTabId", "value": "et", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isGlobal\":false,\"description\":\"Cum ea minima aut praesentium a.\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTab [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Personal card profile tabs by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"error\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Personal card profile tab by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/:personalCardProfileTabId?include=", "variable": [ { "id": "personalCardProfileTabId", "key": "personalCardProfileTabId", "value": "beatae", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"PersonalCardProfileTab [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Personal card profile tabs with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Personal card profile tabs based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profile-tabs\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profile-tabs\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"isGlobal\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"description\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Locale", "description": "", "item": [ { "name": "Create a new Locale", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"dignissimos\",\"code\":\"pariatur\",\"enabled\":true}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Locales", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"title\":\"minus\",\"code\":\"sit\",\"enabled\":false}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Locale by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/:localeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/:localeId?include=", "variable": [ { "id": "localeId", "key": "localeId", "value": "voluptatem", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Locale [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Locales", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"title\":\"laboriosam\",\"code\":\"ut\",\"enabled\":true}]}" }, "description": "" }, "response": [] }, { "name": "Update a Locale by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/:localeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/:localeId?include=", "variable": [ { "id": "localeId", "key": "localeId", "value": "non", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"dolores\",\"code\":\"error\",\"enabled\":false}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Locale [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Locales by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"pariatur\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Locale by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/:localeId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/:localeId?include=", "variable": [ { "id": "localeId", "key": "localeId", "value": "doloremque", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"Locale [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Locales with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Locales based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/locales\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/locales\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"code\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"title\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"enabled\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "External salary type", "description": "", "item": [ { "name": "Fetch a External salary type by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-salary-types\/:externalSalaryTypeId", "query": [ { "key": "include", "value": "company%2CexternalIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/external-salary-types\/:externalSalaryTypeId?include=company%2CexternalIntegration", "variable": [ { "id": "externalSalaryTypeId", "key": "externalSalaryTypeId", "value": "sit", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"ExternalSalaryType [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of External salary types with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-salary-types", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company%2CexternalIntegration", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/external-salary-types?page=1&pageSize=15&withSoftDeletes=1&include=company%2CexternalIntegration" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Emp permission", "description": "", "item": [ { "name": "Create a new Emp permission", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"glue\":\"AND\",\"rules\":[\"odio\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Emp permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"glue\":\"AND\",\"rules\":[]}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Emp permission by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/:personnelPermissionId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/:personnelPermissionId?include=", "variable": [ { "id": "personnelPermissionId", "key": "personnelPermissionId", "value": "eveniet", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermission [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Emp permissions", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"glue\":\"OR\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Emp permission by its ID (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/:personnelPermissionId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/:personnelPermissionId?include=", "variable": [ { "id": "personnelPermissionId", "key": "personnelPermissionId", "value": "et", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"glue\":\"AND\",\"rules\":[\"debitis\"]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermission [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Emp permissions by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"sit\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Emp permission by its ID (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/:personnelPermissionId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/:personnelPermissionId?include=", "variable": [ { "id": "personnelPermissionId", "key": "personnelPermissionId", "value": "iure", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermission [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Emp permissions with pagination (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Emp permissions based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permissions\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permissions\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"empPermissionId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Emp permission rule", "description": "", "item": [ { "name": "Create a new Emp permission rule", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"employeeFieldId\":\"veritatis\",\"operator\":\"=\",\"value\":\"necessitatibus\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Batch create new Emp permission rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/batch?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"employeeFieldId\":\"quae\",\"operator\":\"=\",\"value\":\"rerum\"}]}" }, "description": "" }, "response": [] }, { "name": "Fetch a Emp permission rule by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId?include=", "variable": [ { "id": "personnelPermissionRuleId", "key": "personnelPermissionRuleId", "value": "et", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermissionRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch update Emp permission rules", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/batch?include=" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[{\"employeeFieldId\":\"in\",\"operator\":\"=\",\"value\":\"ut\"}]}" }, "description": "" }, "response": [] }, { "name": "Update a Emp permission rule by its ID (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId?include=", "variable": [ { "id": "personnelPermissionRuleId", "key": "personnelPermissionRuleId", "value": "veniam", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"employeeFieldId\":\"et\",\"operator\":\"=\",\"value\":\"velit\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermissionRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Batch delete Emp permission rules by their IDs", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/batch", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/batch?include=" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[\"dolor\"]}" }, "description": "" }, "response": [] }, { "name": "Delete a Emp permission rule by its ID (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/:personnelPermissionRuleId?include=", "variable": [ { "id": "personnelPermissionRuleId", "key": "personnelPermissionRuleId", "value": "debitis", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 404, "body": "{\"data\":[],\"message\":\"EmpPermissionRule [id] does not exist.\",\"status\":404}", "name": "" } ] }, { "name": "Fetch a list of Emp permission rules with pagination (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Emp permission rules based on the provided filters, scopes, sorting and pagination (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personnel-permission-rules\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personnel-permission-rules\/search?page=1&pageSize=15&withSoftDeletes=1&include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"empPermissionRuleId\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Transaction", "description": "", "item": [ { "name": "Fetch a list of Transactions with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company%2Cemployee%2CpayCode", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/transactions?page=1&pageSize=15&withSoftDeletes=1&include=company%2Cemployee%2CpayCode" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"provident\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a list of Transactions based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "company%2Cemployee%2CpayCode", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/transactions\/search?page=1&pageSize=15&withSoftDeletes=1&include=company%2Cemployee%2CpayCode" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"companyId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"employeeId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"payCodeId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"salaryPeriod\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"externalId\",\"direction\":\"asc\"}],\"companyId\":\"fuga\"}" }, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Employee", "description": "", "item": [ { "name": "Fetch a list of Employees with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:companyId\/employees", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/:companyId\/employees?page=1&pageSize=15&withSoftDeletes=1&include=", "variable": [ { "id": "companyId", "key": "companyId", "value": "illum", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" }, { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new Employee", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/companies\/:companyId\/employees", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/companies\/:companyId\/employees?include=", "variable": [ { "id": "companyId", "key": "companyId", "value": "excepturi", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "App\\ http\\ resources\\ api\\ v1\\ employee field change resource", "description": "", "item": [ { "name": "Fetch a list of App\\ http\\ resources\\ api\\ v1\\ employee field change resources based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/search-custom", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/search-custom?page=1&pageSize=15&withSoftDeletes=1&include=", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "et", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"fieldName\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"changeId\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"effectiveDate\",\"operator\":\"=\",\"value\":\"value\"},{\"field\":\"status\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [] } ] }, { "name": "Employee field change", "description": "", "item": [ { "name": "Fetch a list of Employee field changes based on the provided filters, scopes, sorting and pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/search", "query": [ { "key": "page", "value": "1", "description": "Page number for pagination, defaults to 1, minimum 1", "disabled": false }, { "key": "pageSize", "value": "15", "description": "Number of items per page, defaults to 15, minimum 1", "disabled": false }, { "key": "withSoftDeletes", "value": "1", "description": "Include soft deleted items in the response", "disabled": false }, { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/search?page=1&pageSize=15&withSoftDeletes=1&include=", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "ut", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"filters\":[{\"field\":\"effectiveDate\",\"operator\":\"=\",\"value\":\"value\"}],\"sort\":[{\"field\":\"createdAt\",\"direction\":\"asc\"},{\"field\":\"updatedAt\",\"direction\":\"asc\"}]}" }, "description": "" }, "response": [] } ] } ] }, { "name": "Custom Endpoints", "description": "All other endpoints", "item": [ { "name": "Authentication", "description": "", "item": [ { "name": "Authenticate (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/authenticate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/authenticate" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"http:\\\/\\\/www.bashirian.com\\\/\",\"companyId\":\"accusamus\",\"roleId\":5,\"access_token\":\"qui\",\"sensitive\":true}" }, "description": "This endpoint lets you authenticate.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 422, "body": "{\"message\":\"Company accusamus does not exist. (and 1 more error)\",\"errors\":{\"companyId\":[\"Company accusamus does not exist.\"],\"roleId\":[\"The selected role id is invalid.\"]},\"status\":422}", "name": "" } ] }, { "name": "Logout", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/logout", "query": [], "raw": "{{baseUrl}}\/api\/v1\/logout" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you logout." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "User", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you get the authenticated user." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "SalaryWarning", "description": "", "item": [ { "name": "Confirm a salary rule warning (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-warnings\/:salaryWarningId\/confirm", "query": [ { "key": "include", "value": "employee%2CsalaryRule", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/salary-warnings\/:salaryWarningId\/confirm?include=employee%2CsalaryRule", "variable": [ { "id": "salaryWarningId", "key": "salaryWarningId", "value": "quidem", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Remove confirmation from a salary rule warning (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/salary-warnings\/:salaryWarningId\/unconfirm", "query": [ { "key": "include", "value": "employee%2CsalaryRule", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": false } ], "raw": "{{baseUrl}}\/api\/v1\/salary-warnings\/:salaryWarningId\/unconfirm?include=employee%2CsalaryRule", "variable": [ { "id": "salaryWarningId", "key": "salaryWarningId", "value": "et", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Evaluate salary rules for a given period (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/execute-salary-rules", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/execute-salary-rules?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Notification", "description": "", "item": [ { "name": "Mark all notifications as read", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/read-all", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/notifications\/read-all?include=" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you mark all notifications as read." }, "response": [] }, { "name": "Mark a notification as read by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:notificationId\/read", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:notificationId\/read?include=", "variable": [ { "id": "notificationId", "key": "notificationId", "value": "laborum", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you mark a notification as read." }, "response": [] }, { "name": "Mark a notification as not read by its ID (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/notifications\/:notificationId\/unread", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/notifications\/:notificationId\/unread?include=", "variable": [ { "id": "notificationId", "key": "notificationId", "value": "pariatur", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you mark a notification as not read." }, "response": [] } ] }, { "name": "PayCode Mapping", "description": "", "item": [ { "name": "Duplicate a payCode mapping", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/pay-code-mappings\/:mappingId\/duplicate", "query": [], "raw": "{{baseUrl}}\/api\/v1\/pay-code-mappings\/:mappingId\/duplicate", "variable": [ { "id": "mappingId", "key": "mappingId", "value": "asperiores", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"autem\"}" }, "description": "" }, "response": [] } ] }, { "name": "Statistics", "description": "", "item": [ { "name": "Transaction Statistics", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/transactions\/statistics", "query": [], "raw": "{{baseUrl}}\/api\/v1\/transactions\/statistics" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"includeChildren\":false,\"organizationId\":\"fugiat\",\"companyId\":\"ab\"}" }, "description": "This endpoint lets you get transaction statistics." }, "response": [] } ] }, { "name": "Personal Card Profile", "description": "", "item": [ { "name": "Duplicate a personal card profile", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/personal-card-profiles\/:personalCardProfileId\/duplicate", "query": [ { "key": "include", "value": "", "description": "Include related resources. Use comma-separated values for multiple includes.", "disabled": true } ], "raw": "{{baseUrl}}\/api\/v1\/personal-card-profiles\/:personalCardProfileId\/duplicate?include=", "variable": [ { "id": "personalCardProfileId", "key": "personalCardProfileId", "value": "dolorem", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"animi\",\"description\":\"Ratione rerum ut magni voluptas ipsum.\",\"isGlobal\":\"vel\",\"companyId\":\"sed\"}" }, "description": "" }, "response": [] } ] }, { "name": "Storage Structure", "description": "", "item": [ { "name": "Create a new storage structure", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/storage-structure", "query": [], "raw": "{{baseUrl}}\/api\/v1\/storage-structure" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"directoryName\":\"inventore\",\"directoryParentId\":\"porro\"}" }, "description": "" }, "response": [] }, { "name": "Fetch a list of storage structures with pagination", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/storage-structure", "query": [], "raw": "{{baseUrl}}\/api\/v1\/storage-structure" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a storage structure by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/storage-structure\/:storageStructureId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/storage-structure\/:storageStructureId", "variable": [ { "id": "storageStructureId", "key": "storageStructureId", "value": "nihil", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a storage structure by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/storage-structure\/:storageStructureId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/storage-structure\/:storageStructureId", "variable": [ { "id": "storageStructureId", "key": "storageStructureId", "value": "ex", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"directoryName\":\"reprehenderit\",\"directoryParentId\":\"hic\"}" }, "description": "" }, "response": [] }, { "name": "Delete a storage structure by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/storage-structure\/:storageStructureId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/storage-structure\/:storageStructureId", "variable": [ { "id": "storageStructureId", "key": "storageStructureId", "value": "inventore", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Employee", "description": "", "item": [ { "name": "Transfer Changes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/change-transfer", "query": [], "raw": "{{baseUrl}}\/api\/v1\/change-transfer" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "This endpoint lets you transfer changes." }, "response": [] } ] }, { "name": "Relatives", "description": "", "item": [ { "name": "Create a new relative", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "nam", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"firstName\":\"temporibus\",\"lastName\":\"fugiat\",\"emailAddress\":\"fanny.jenkins@example.org\",\"telephone\":\"-{5,}\",\"mobilePhone\":\"+{5,}\",\"relationship\":\"fugit\",\"comment\":\"sint\"}" }, "description": "" }, "response": [] } ] }, { "name": "Relative Changes", "description": "", "item": [ { "name": "Get changes for a particular relative.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/field-changes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/field-changes", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "laborum", "description": "" }, { "id": "relativeId", "key": "relativeId", "value": "esse", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Employee Relative Field Changes", "description": "", "item": [ { "name": "Approve a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/approve-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/approve-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "ut", "description": "" }, { "id": "relativeId", "key": "relativeId", "value": "repellat", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"mollitia\",\"recordId\":\"voluptatem\"}" }, "description": "" }, "response": [] }, { "name": "Approve multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/approve-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/approve-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "officia", "description": "" }, { "id": "relativeId", "key": "relativeId", "value": "ut", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"velit\",\"recordId\":\"quam\"}" }, "description": "" }, "response": [] }, { "name": "Deny a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/deny-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/deny-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "autem", "description": "" }, { "id": "relativeId", "key": "relativeId", "value": "nam", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"esse\",\"recordId\":\"voluptatem\"}" }, "description": "" }, "response": [] }, { "name": "Deny multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/deny-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/employee-relatives\/:relativeId\/deny-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "et", "description": "" }, { "id": "relativeId", "key": "relativeId", "value": "possimus", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"deserunt\",\"recordId\":\"sit\"}" }, "description": "" }, "response": [] } ] }, { "name": "Employee Future Changes", "description": "", "item": [ { "name": "List all changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/future-changes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/future-changes", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "nesciunt", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Employees", "description": "", "item": [ { "name": "Get all unique effective dates for an employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/unique-effective-dates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/unique-effective-dates", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "et", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new employee change", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "quia", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":0,\"changeId\":\"repellendus\",\"changeType\":\"delete\",\"fieldName\":\"aliquid\",\"oldValue\":\"illum\",\"comment\":\"veritatis\"}" }, "description": "" }, "response": [] }, { "name": "Create multiple employee changes", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "magni", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":0,\"changeId\":\"quo\",\"changeType\":\"delete\",\"fieldName\":\"vitae\",\"oldValue\":\"impedit\",\"comment\":\"tempora\"}" }, "description": "" }, "response": [] } ] }, { "name": "Employment Changes", "description": "", "item": [ { "name": "List all changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "ipsa", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new change request for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "minus", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":0,\"changeId\":\"aliquid\",\"changeType\":\"delete\",\"fieldName\":\"voluptates\",\"oldValue\":\"dolorem\",\"comment\":\"officia\"}" }, "description": "" }, "response": [] }, { "name": "Create multiple change requests for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "quibusdam", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":1,\"changeId\":\"odio\",\"changeType\":\"delete\",\"fieldName\":\"reprehenderit\",\"oldValue\":\"voluptatum\",\"comment\":\"maxime\"}" }, "description": "" }, "response": [] }, { "name": "Approve a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment\/approve-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment\/approve-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "qui", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"quam\",\"recordId\":\"corporis\"}" }, "description": "" }, "response": [] }, { "name": "Approve multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment\/approve-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment\/approve-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "non", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"qui\",\"recordId\":\"odit\"}" }, "description": "" }, "response": [] }, { "name": "Deny a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment\/deny-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment\/deny-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "praesentium", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"magnam\",\"recordId\":\"in\"}" }, "description": "" }, "response": [] }, { "name": "Deny multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/employment\/deny-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/employment\/deny-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "qui", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"quod\",\"recordId\":\"repellendus\"}" }, "description": "" }, "response": [] } ] }, { "name": "Pay Code Changes", "description": "", "item": [ { "name": "Get all pay code changes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "ipsam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new pay code change.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "perferendis", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":0,\"changeId\":\"expedita\",\"changeType\":\"delete\",\"fieldName\":\"qui\",\"comment\":\"dolorem\"}" }, "description": "" }, "response": [] }, { "name": "Create multiple pay code changes.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "qui", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"effectiveDate\":1,\"changeId\":\"ullam\",\"changeType\":\"delete\",\"fieldName\":\"sit\",\"comment\":\"nihil\"}" }, "description": "" }, "response": [] }, { "name": "Approve a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/approve-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/approve-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "amet", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"in\",\"recordId\":\"debitis\"}" }, "description": "" }, "response": [] }, { "name": "Approve multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/approve-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/approve-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "velit", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"ea\",\"recordId\":\"at\"}" }, "description": "" }, "response": [] }, { "name": "Deny a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/deny-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/deny-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "ut", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"labore\",\"recordId\":\"autem\"}" }, "description": "" }, "response": [] }, { "name": "Deny multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/deny-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/field-changes\/pay-code\/deny-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "aut", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"ut\",\"recordId\":\"et\"}" }, "description": "" }, "response": [] } ] }, { "name": "Employee Field Changes", "description": "", "item": [ { "name": "Approve a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/approve-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/approve-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "recusandae", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"alias\",\"recordId\":\"vero\"}" }, "description": "" }, "response": [] }, { "name": "Approve multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/approve-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/approve-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "minima", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"autem\",\"recordId\":\"totam\"}" }, "description": "" }, "response": [] }, { "name": "Deny a field change for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/deny-field-change", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/deny-field-change", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "temporibus", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"harum\",\"recordId\":\"officiis\"}" }, "description": "" }, "response": [] }, { "name": "Deny multiple field changes for a particular employee.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/employees\/:employeeId\/deny-field-change\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/employees\/:employeeId\/deny-field-change\/batch", "variable": [ { "id": "employeeId", "key": "employeeId", "value": "dolorem", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"changeId\":\"ea\",\"recordId\":\"labore\"}" }, "description": "" }, "response": [] } ] }, { "name": "Employee Field Mappings", "description": "", "item": [ { "name": "Create a new employee field mapping.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-mappings", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-mappings" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalEmployeeFieldId\":\"harum\",\"employeeFieldId\":\"qui\",\"externalIntegrationId\":\"quam\"}" }, "description": "" }, "response": [] }, { "name": "Create multiple employee field mappings.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-mappings\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-mappings\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalEmployeeFieldId\":\"id\",\"employeeFieldId\":\"voluptates\",\"externalIntegrationId\":\"est\"}" }, "description": "" }, "response": [] }, { "name": "Update an employee field mapping.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-mappings\/:mappingId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-mappings\/:mappingId", "variable": [ { "id": "mappingId", "key": "mappingId", "value": "impedit", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"externalEmployeeFieldId\":\"harum\",\"employeeFieldId\":\"delectus\",\"externalIntegrationId\":\"sed\"}" }, "description": "" }, "response": [] }, { "name": "Delete an employee field mapping.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-mappings\/:mappingId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-mappings\/:mappingId", "variable": [ { "id": "mappingId", "key": "mappingId", "value": "provident", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Employee Fields", "description": "", "item": [ { "name": "Get fields for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/employee-fields", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/employee-fields", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "animi", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":true,\"sensitive\":true,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":false,\"manualInput\":false,\"fieldType\":\"select\",\"dataType\":\"string\",\"maxInput\":9781421.795177348,\"minInput\":39550010.758808}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Customize an existing global employee field for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "et", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "natus", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":false,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":true,\"manualInput\":false,\"fieldType\":\"number\",\"dataType\":\"date\",\"maxInput\":17716.2,\"minInput\":7574.82138}" }, "description": "" }, "response": [] }, { "name": "Get an extended employee field for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "quas", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "optio", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":true,\"allowNewValue\":false,\"observe\":true,\"importExcluded\":false,\"manualInput\":false,\"fieldType\":\"email\",\"dataType\":\"date\",\"maxInput\":172.457,\"minInput\":3522263.42255176}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Revert an extended employee field for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/employee-fields\/:fieldId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "eos", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "nisi", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":true,\"salarySensitive\":true,\"sensitive\":false,\"allowNewValue\":false,\"observe\":false,\"importExcluded\":false,\"manualInput\":true,\"fieldType\":\"password\",\"dataType\":\"boolean\",\"maxInput\":6.15836529,\"minInput\":1147495.1267429474}" }, "description": "" }, "response": [] }, { "name": "Get fields for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/employee-fields", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/employee-fields", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "in", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":false,\"salarySensitive\":true,\"sensitive\":true,\"allowNewValue\":false,\"observe\":false,\"importExcluded\":false,\"manualInput\":true,\"fieldType\":\"date\",\"dataType\":\"string\",\"maxInput\":35.8457,\"minInput\":980.00662708}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Customize an existing global employee field for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "rerum", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "consequatur", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":false,\"salarySensitive\":false,\"sensitive\":false,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":true,\"manualInput\":false,\"fieldType\":\"email\",\"dataType\":\"date\",\"maxInput\":14734.955942,\"minInput\":768375.2478}" }, "description": "" }, "response": [] }, { "name": "Show an extended employee field for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "est", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "quibusdam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":true,\"allowNewValue\":true,\"observe\":true,\"importExcluded\":true,\"manualInput\":true,\"fieldType\":\"textarea\",\"dataType\":\"date\",\"maxInput\":229939055.15218,\"minInput\":4.9546598}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Revert an extended employee field for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/employee-fields\/:fieldId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "sed", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "sed", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":true,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":false,\"manualInput\":true,\"fieldType\":\"email\",\"dataType\":\"number\",\"maxInput\":16822.811836268,\"minInput\":312246.9004489}" }, "description": "" }, "response": [] }, { "name": "Customize an existing global employee field for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "variable": [ { "id": "companyId", "key": "companyId", "value": "cumque", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "et", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":false,\"allowNewValue\":false,\"observe\":true,\"importExcluded\":false,\"manualInput\":false,\"fieldType\":\"textarea\",\"dataType\":\"boolean\",\"maxInput\":92184.9766246,\"minInput\":122229087.09757656}" }, "description": "" }, "response": [] }, { "name": "Revert an extended employee field for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/:fieldId\/revert", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/:fieldId\/revert", "variable": [ { "id": "companyId", "key": "companyId", "value": "perspiciatis", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "quos", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":false,\"salarySensitive\":false,\"sensitive\":false,\"allowNewValue\":false,\"observe\":true,\"importExcluded\":true,\"manualInput\":true,\"fieldType\":\"email\",\"dataType\":\"date\",\"maxInput\":6236.8791,\"minInput\":431304.64}" }, "description": "" }, "response": [] }, { "name": "Revert extended employee fields and custom fields for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/revert-all", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/revert-all", "variable": [ { "id": "companyId", "key": "companyId", "value": "omnis", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":true,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":false,\"manualInput\":true,\"fieldType\":\"password\",\"dataType\":\"number\",\"maxInput\":467809963.5234,\"minInput\":27140.42}" }, "description": "" }, "response": [] }, { "name": "Get an extended employee field for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "variable": [ { "id": "companyId", "key": "companyId", "value": "quia", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "consequuntur", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":false,\"isMandatory\":true,\"salarySensitive\":false,\"sensitive\":true,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":false,\"manualInput\":true,\"fieldType\":\"date\",\"dataType\":\"date\",\"maxInput\":1.662889,\"minInput\":209382.67085644}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get employee fields for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields", "variable": [ { "id": "companyId", "key": "companyId", "value": "autem", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":true,\"salarySensitive\":true,\"sensitive\":false,\"allowNewValue\":true,\"observe\":false,\"importExcluded\":false,\"manualInput\":false,\"fieldType\":\"textarea\",\"dataType\":\"number\",\"maxInput\":5035837.37593388,\"minInput\":516398.17847}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get employee fields for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields", "variable": [ { "id": "companyId", "key": "companyId", "value": "eum", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":false,\"salarySensitive\":true,\"sensitive\":false,\"allowNewValue\":true,\"observe\":true,\"importExcluded\":true,\"manualInput\":true,\"fieldType\":\"password\",\"dataType\":\"number\",\"maxInput\":6.697714444,\"minInput\":0,\"maxLength\":159.415,\"minLength\":23756247.3,\"fieldName\":\"gi\",\"combinedFieldIds\":[\"excepturi\"]}" }, "description": "" }, "response": [] }, { "name": "Update an employee field for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "variable": [ { "id": "companyId", "key": "companyId", "value": "eum", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "facilis", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"isShow\":true,\"isMandatory\":false,\"salarySensitive\":true,\"sensitive\":false,\"allowNewValue\":false,\"observe\":false,\"importExcluded\":true,\"manualInput\":true,\"fieldType\":\"text\",\"dataType\":\"boolean\",\"maxInput\":9480.989652629,\"minInput\":791.6792,\"maxLength\":2.23,\"minLength\":0.1,\"combinedFieldIds\":[\"magnam\"]}" }, "description": "" }, "response": [] }, { "name": "Delete an employee field for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/employee-fields\/:fieldId", "variable": [ { "id": "companyId", "key": "companyId", "value": "optio", "description": "" }, { "id": "fieldId", "key": "fieldId", "value": "quod", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Field Groups", "description": "", "item": [ { "name": "Create a global field group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"quo\"}" }, "description": "" }, "response": [] }, { "name": "Fetch all global field groups", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Fetch a global field group by its ID", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:groupId", "variable": [ { "id": "groupId", "key": "groupId", "value": "consequatur", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a global field group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:groupId", "variable": [ { "id": "groupId", "key": "groupId", "value": "expedita", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"aut\"}" }, "description": "" }, "response": [] }, { "name": "Delete a global field group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:groupId", "variable": [ { "id": "groupId", "key": "groupId", "value": "hic", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Add a field to a global field group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:employeeFieldId\/add-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:employeeFieldId\/add-field", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "eaque", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"vel\"}" }, "description": "" }, "response": [] }, { "name": "Move a field from one global field group to another", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:employeeFieldId\/move-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:employeeFieldId\/move-field", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "veritatis", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"oldGroupId\":\"autem\",\"newGroupId\":\"libero\"}" }, "description": "" }, "response": [] }, { "name": "Remove a field from a global field group", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/field-groups\/:employeeFieldId\/remove-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/field-groups\/:employeeFieldId\/remove-field", "variable": [ { "id": "employeeFieldId", "key": "employeeFieldId", "value": "autem", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"enim\"}" }, "description": "" }, "response": [] }, { "name": "Get fields groups for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "temporibus", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"et\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Customize an existing global field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "repellat", "description": "" }, { "id": "groupId", "key": "groupId", "value": "quia", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"repellendus\"}" }, "description": "" }, "response": [] }, { "name": "Get a particular field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "harum", "description": "" }, { "id": "groupId", "key": "groupId", "value": "inventore", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"qui\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Revert a customized global field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:groupId", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "tempora", "description": "" }, { "id": "groupId", "key": "groupId", "value": "sint", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"voluptas\"}" }, "description": "" }, "response": [] }, { "name": "Add a field to a particular field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/add-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/add-field", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "quis", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "et", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"est\"}" }, "description": "" }, "response": [] }, { "name": "Move a field from a field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/move-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/move-field", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "ipsa", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "qui", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"oldGroupId\":\"similique\",\"newGroupId\":\"mollitia\"}" }, "description": "" }, "response": [] }, { "name": "Remove a field from a field group for a particular integration.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/remove-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/external-integration\/:integrationId\/field-groups\/:employeeFieldId\/remove-field", "variable": [ { "id": "integrationId", "key": "integrationId", "value": "maxime", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "dolore", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"maxime\"}" }, "description": "" }, "response": [] }, { "name": "Get fields groups for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "sit", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"ipsa\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Customize an existing global field group for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "iusto", "description": "" }, { "id": "groupId", "key": "groupId", "value": "amet", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"ad\"}" }, "description": "" }, "response": [] }, { "name": "Get a particular field group for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "sit", "description": "" }, { "id": "groupId", "key": "groupId", "value": "non", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"numquam\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Revert a customized field group for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:groupId", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "sit", "description": "" }, { "id": "groupId", "key": "groupId", "value": "sunt", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"fugiat\"}" }, "description": "" }, "response": [] }, { "name": "Add a field to a particular field group for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/add-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/add-field", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "ratione", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "corporis", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"vitae\"}" }, "description": "" }, "response": [] }, { "name": "Move a field from one field group to another for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/move-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/move-field", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "quis", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "aut", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"oldGroupId\":\"aspernatur\",\"newGroupId\":\"similique\"}" }, "description": "" }, "response": [] }, { "name": "Remove a field from a particular field group for a particular organization.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/remove-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/organization\/:organizationId\/field-groups\/:employeeFieldId\/remove-field", "variable": [ { "id": "organizationId", "key": "organizationId", "value": "eius", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "quia", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"laboriosam\"}" }, "description": "" }, "response": [] }, { "name": "Get fields groups for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups", "variable": [ { "id": "companyId", "key": "companyId", "value": "molestias", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"non\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Customize an existing global field group for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:groupId", "variable": [ { "id": "companyId", "key": "companyId", "value": "quia", "description": "" }, { "id": "groupId", "key": "groupId", "value": "aut", "description": "" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"alias\"}" }, "description": "" }, "response": [] }, { "name": "Show a customized global field group for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:groupId", "variable": [ { "id": "companyId", "key": "companyId", "value": "ipsa", "description": "" }, { "id": "groupId", "key": "groupId", "value": "quam", "description": "" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"necessitatibus\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Revert a customized global field group for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:groupId", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:groupId", "variable": [ { "id": "companyId", "key": "companyId", "value": "dolor", "description": "" }, { "id": "groupId", "key": "groupId", "value": "nostrum", "description": "" } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupName\":\"et\"}" }, "description": "" }, "response": [] }, { "name": "Add a field to a field group for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/add-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/add-field", "variable": [ { "id": "companyId", "key": "companyId", "value": "corporis", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "rerum", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"dolores\"}" }, "description": "" }, "response": [] }, { "name": "Move a field from one field group to another for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/move-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/move-field", "variable": [ { "id": "companyId", "key": "companyId", "value": "blanditiis", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "veniam", "description": "" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"oldGroupId\":\"cum\",\"newGroupId\":\"illo\"}" }, "description": "" }, "response": [] }, { "name": "Remove a field from a field group for a particular company.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/remove-field", "query": [], "raw": "{{baseUrl}}\/api\/v1\/company\/:companyId\/field-groups\/:employeeFieldId\/remove-field", "variable": [ { "id": "companyId", "key": "companyId", "value": "rerum", "description": "" }, { "id": "employeeFieldId", "key": "employeeFieldId", "value": "aut", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"groupId\":\"eveniet\"}" }, "description": "" }, "response": [] } ] }, { "name": "Import", "description": "", "item": [ { "name": "Import company details (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/import\/company", "query": [], "raw": "{{baseUrl}}\/api\/v1\/import\/company" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"laboriosam\",\"companyIntegrationId\":\"nihil\",\"async\":true}" }, "description": "" }, "response": [] }, { "name": "Import employees (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/import\/employees", "query": [], "raw": "{{baseUrl}}\/api\/v1\/import\/employees" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"aliquid\",\"companyIntegrationId\":\"voluptas\",\"async\":false}" }, "description": "" }, "response": [] }, { "name": "Import transactions. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/import\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/import\/transactions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"iure\",\"companyIntegrationId\":\"ipsa\",\"period\":\"4957040\"}" }, "description": "" }, "response": [] }, { "name": "Import salary types.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/import\/salary-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/import\/salary-types" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"companyId\":\"temporibus\"}" }, "description": "" }, "response": [] }, { "name": "Import transactions to the cloud.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/import\/cloud\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/import\/cloud\/transactions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Cache", "description": "", "item": [ { "name": "Refresh the cache.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cache\/refresh", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cache\/refresh" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Warm the cache.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cache\/warm", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cache\/warm" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Clear the cache.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cache\/clear", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cache\/clear" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Real Time", "description": "", "item": [ { "name": "Generate connection token for Centrifugo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/real-time\/connection-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/real-time\/connection-token" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Generate subscription token for Centrifugo.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/real-time\/subscription-token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/real-time\/subscription-token" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"channel\":\"reiciendis\"}" }, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Abilities", "description": "", "item": [ { "name": "Retrieve specific abilities for a specific role (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id\/specific-abilities", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id\/specific-abilities", "variable": [ { "id": "role_id", "key": "role_id", "value": "1", "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Attach a specific ability to a role (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id\/specific-abilities\/attach", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id\/specific-abilities\/attach", "variable": [ { "id": "role_id", "key": "role_id", "value": "1", "description": "The ID of the role." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Detach a specific ability to a role (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/roles\/:role_id\/specific-abilities\/detach", "query": [], "raw": "{{baseUrl}}\/api\/v1\/roles\/:role_id\/specific-abilities\/detach", "variable": [ { "id": "role_id", "key": "role_id", "value": "1", "description": "The ID of the role." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "[]" }, "description": "" }, "response": [] }, { "name": "Retrieve all specific abilities (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/specific-abilities", "query": [], "raw": "{{baseUrl}}\/api\/v1\/specific-abilities" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Ability", "description": "", "item": [ { "name": "Allow an ability to a group. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/:abilityGroupId\/allow", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/:abilityGroupId\/allow", "variable": [ { "id": "abilityGroupId", "key": "abilityGroupId", "value": "officiis", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ability\":\"update\",\"entity\":\"App\\\\DataLayer\\\\Models\\\\PayCodeVariable\",\"entityId\":\"corrupti\"}" }, "description": "" }, "response": [] }, { "name": "Forbid an ability to a group. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/:abilityGroupId\/forbid", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/:abilityGroupId\/forbid", "variable": [ { "id": "abilityGroupId", "key": "abilityGroupId", "value": "in", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"ability\":\"update\",\"entity\":\"App\\\\DataLayer\\\\Models\\\\RoleEmpPermission\",\"entityId\":\"omnis\"}" }, "description": "" }, "response": [] }, { "name": "Assign a role to a user. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:roleId\/assign", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:roleId\/assign", "variable": [ { "id": "roleId", "key": "roleId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"nihil\",\"title\":\"est\"}" }, "description": "" }, "response": [] }, { "name": "Retract a role from a user. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:roleId\/retract", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:roleId\/retract", "variable": [ { "id": "roleId", "key": "roleId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"dolores\",\"title\":\"animi\"}" }, "description": "" }, "response": [] }, { "name": "Assign a group to a role. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:roleId\/assign-group", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:roleId\/assign-group", "variable": [ { "id": "roleId", "key": "roleId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"abilityGroupId\":7}" }, "description": "" }, "response": [] }, { "name": "Retract a group from a role. (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:roleId\/retract-group", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:roleId\/retract-group", "variable": [ { "id": "roleId", "key": "roleId", "value": "1", "description": "" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"abilityGroupId\":15}" }, "description": "" }, "response": [] }, { "name": "Get all types of entities (Stability Score: 0.1)", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/entity-types", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/entity-types" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] } ] }, { "name": "Endpoints", "description": "All other endpoints", "item": [ { "name": "Filters, sorts, and fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/search", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/search" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Creates a batch of new resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Update a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/batch" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Deletes a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/batch" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Creates new resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/:id", "variable": [ { "id": "id", "key": "id", "value": "nesciunt", "description": "The ID of the ability group." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/:id", "variable": [ { "id": "id", "key": "id", "value": "eos", "description": "The ID of the ability group." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Deletes a resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/ability-group\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/ability-group\/:id", "variable": [ { "id": "id", "key": "id", "value": "autem", "description": "The ID of the ability group." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Filters, sorts, and fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/search", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/search" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Creates a batch of new resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Update a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/batch" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Deletes a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/batch" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Creates new resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Deletes a resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/abilities\/roles\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/abilities\/roles\/:id", "variable": [ { "id": "id", "key": "id", "value": "1", "description": "The ID of the role." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Orion Endpoints", "description": "", "item": [ { "name": "Filters, sorts, and fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/search", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/search" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Creates a batch of new resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/batch" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Update a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/batch" }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"resources\":[]}" }, "description": "" }, "response": [] }, { "name": "Deletes a batch of resources in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/batch", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/batch" }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches the list of resources.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Creates new resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Fetches resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/:id", "variable": [ { "id": "id", "key": "id", "value": "amet", "description": "The ID of the transaction." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a resource in a transaction-safe way.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/:id", "variable": [ { "id": "id", "key": "id", "value": "repellat", "description": "The ID of the transaction." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] }, { "name": "Deletes a resource.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/orion\/transactions\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/orion\/transactions\/:id", "variable": [ { "id": "id", "key": "id", "value": "et", "description": "The ID of the transaction." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [] } ] }, { "name": "Uncategorized Endpoints", "description": "All other endpoints", "item": [ { "name": "GET api\/octane-firebase-concurrently", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/octane-firebase-concurrently", "query": [], "raw": "{{baseUrl}}\/api\/octane-firebase-concurrently" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "GET api\/v1\/user\/roles", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/user\/roles", "query": [], "raw": "{{baseUrl}}\/api\/v1\/user\/roles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "POST api\/v1\/users", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/users", "query": [], "raw": "{{baseUrl}}\/api\/v1\/users" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"ut\",\"email\":\"bschaefer@example.net\"}" }, "description": "" }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }