{ "info": { "_postman_id": "c3211a3f-9055-4ae7-bd5b-75a1625352a7", "name": "Remote Address Details Incentives API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:46:35.000Z", "updatedAt": "2026-07-28T02:46:35.000Z", "lastUpdatedBy": "35240", "uid": "35240-c3211a3f-9055-4ae7-bd5b-75a1625352a7" }, "item": [ { "name": "v1", "item": [ { "name": "employee", "item": [ { "name": "incentives", "item": [ { "name": "List incentives for the authenticated employee", "id": "59d80f6c-2879-452a-afdd-d31ae6ed8b67", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "address:read address:write bank_account:read bank_account:write document:read document:write emergency_contact:read emergency_contact:write employment_documents employment_payments employments expense:read incentive:read payroll payslip:read personal_detail:read personal_detail:write time_and_attendance timeoff:read timeoff:write timesheet:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/employee/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "incentives" ] }, "description": "Returns all incentives for the authenticated employee.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "2b73301b-7635-493e-8275-37d4cfa48dda", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "incentives" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-2b73301b-7635-493e-8275-37d4cfa48dda" }, { "id": "d053b5b2-213a-48d3-a1ae-301303107a9f", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "incentives" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-d053b5b2-213a-48d3-a1ae-301303107a9f" }, { "id": "1b16af0b-4e5c-4c12-8695-cd3fe05897df", "name": "Forbidden", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "incentives" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Forbidden\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-1b16af0b-4e5c-4c12-8695-cd3fe05897df" }, { "id": "e5e3627e-c30e-4815-8a9f-f97e3a747332", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/v1/employee/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "employee", "incentives" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-e5e3627e-c30e-4815-8a9f-f97e3a747332" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-59d80f6c-2879-452a-afdd-d31ae6ed8b67" } ], "id": "2f8a6d9b-ade0-4ad4-b7e5-72467f916432", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-2f8a6d9b-ade0-4ad4-b7e5-72467f916432" } ], "id": "8039fa09-1dfd-4127-8cd5-2e3d3a7caf20", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-8039fa09-1dfd-4127-8cd5-2e3d3a7caf20" }, { "name": "incentives", "item": [ { "name": "{id}", "item": [ { "name": "Delete an Incentive", "id": "baec0f0a-b83b-4800-b48a-0a60c5a00440", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "id": "207a138b-5bba-4851-a095-f1bd4c06bc7e", "key": "id", "value": "", "description": "(Required) Incentive ID" } ] }, "description": "Delete an incentive.\n\n`one_time` incentives that have the following status **CANNOT** be deleted:\n* `processing`\n* `paid`\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "cd8a3051-5a2d-44e1-be84-5b4b9c9eb340", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-cd8a3051-5a2d-44e1-be84-5b4b9c9eb340" }, { "id": "89c3bc9e-037f-4939-8eb1-cf845cb58596", "name": "Bad Request", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-89c3bc9e-037f-4939-8eb1-cf845cb58596" }, { "id": "61e85d9c-26b3-495c-b51b-378a22c3ee41", "name": "Unauthorized", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-61e85d9c-26b3-495c-b51b-378a22c3ee41" }, { "id": "bfa18786-f124-4521-a0cf-42b676af816a", "name": "Not Found", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-bfa18786-f124-4521-a0cf-42b676af816a" }, { "id": "adb16945-22f6-49d9-8c92-089de24da021", "name": "Conflict", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-adb16945-22f6-49d9-8c92-089de24da021" }, { "id": "a6baa138-e36d-46cb-b363-26816dbf06b9", "name": "Unprocessable Entity", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-a6baa138-e36d-46cb-b363-26816dbf06b9" }, { "id": "899b9e1a-7740-4f2b-bb80-fcc0751e88c8", "name": "Too many requests", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-899b9e1a-7740-4f2b-bb80-fcc0751e88c8" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-baec0f0a-b83b-4800-b48a-0a60c5a00440" }, { "name": "Show Incentive", "id": "97178d29-f859-4837-a616-e1047669918b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "id": "95236d06-3cfc-4257-a77d-da80a4832a6a", "key": "id", "value": "", "description": "(Required) Incentive ID" } ] }, "description": "Show an Incentive's details\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "6181d397-3075-47ef-a428-9460dd6aea0a", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"incentive\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-6181d397-3075-47ef-a428-9460dd6aea0a" }, { "id": "09cf476f-dfe5-4101-b329-6fa546d90342", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-09cf476f-dfe5-4101-b329-6fa546d90342" }, { "id": "63dbfd49-c8a4-46d7-ab24-c112207f719b", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-63dbfd49-c8a4-46d7-ab24-c112207f719b" }, { "id": "21616402-686c-4d10-a628-d64ff022e7ac", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-21616402-686c-4d10-a628-d64ff022e7ac" }, { "id": "a806553e-de3b-46a1-973a-c4b0a70f5417", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-a806553e-de3b-46a1-973a-c4b0a70f5417" }, { "id": "66b7c59d-4186-45de-82e8-138a432676d7", "name": "Too many requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-66b7c59d-4186-45de-82e8-138a432676d7" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-97178d29-f859-4837-a616-e1047669918b" }, { "name": "Update Incentive", "id": "6c65fbc6-8236-40b8-845f-4555ceae2235", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "id": "5b1c6370-4717-43d2-b6cc-74b5329a4cb0", "key": "id", "value": "", "description": "(Required) Incentive ID" } ] }, "description": "Updates an Incentive.\n\nIncentives use the currency of the employment specified provided in the `employment_id` field.\n\nThe API doesn't support updating paid incentives.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "5f244f9a-c79c-411b-afe8-7e46b2e003e0", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"incentive\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-5f244f9a-c79c-411b-afe8-7e46b2e003e0" }, { "id": "935c6cd2-8c6c-4b8b-8e89-d69d1ab8c667", "name": "Bad Request", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-935c6cd2-8c6c-4b8b-8e89-d69d1ab8c667" }, { "id": "949ecbb6-9eb1-4288-a8f3-6402ce68fd2e", "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-949ecbb6-9eb1-4288-a8f3-6402ce68fd2e" }, { "id": "9fab6768-2fa8-4057-a430-47de94e58bc8", "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-9fab6768-2fa8-4057-a430-47de94e58bc8" }, { "id": "0da75e4c-ec03-4c57-bc97-f129badbcb51", "name": "Conflict", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-0da75e4c-ec03-4c57-bc97-f129badbcb51" }, { "id": "89c9f7b6-6934-4c97-8026-81adf1de70a3", "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-89c9f7b6-6934-4c97-8026-81adf1de70a3" }, { "id": "55233b8f-92a0-4edd-95ef-85e41e7c2676", "name": "Too many requests", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-55233b8f-92a0-4edd-95ef-85e41e7c2676" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-6c65fbc6-8236-40b8-845f-4555ceae2235" }, { "name": "Update Incentive", "id": "ddcefefe-5380-4382-b1d9-a6a7eb0b0a1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "id": "194c1890-2073-49e4-8c18-24efca571bf5", "key": "id", "value": "", "description": "(Required) Incentive ID" } ] }, "description": "Updates an Incentive.\n\nIncentives use the currency of the employment specified provided in the `employment_id` field.\n\nThe API doesn't support updating paid incentives.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "682a4dfd-d7ad-47da-9f9d-91b080029074", "name": "Success", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"incentive\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-682a4dfd-d7ad-47da-9f9d-91b080029074" }, { "id": "85f9711b-b8f7-47c5-acc2-70d4c819b8e9", "name": "Bad Request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-85f9711b-b8f7-47c5-acc2-70d4c819b8e9" }, { "id": "a7e72775-6b13-48cf-b80a-38be54290444", "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-a7e72775-6b13-48cf-b80a-38be54290444" }, { "id": "35e7e035-6862-4317-aa56-cabb6d49ef13", "name": "Not Found", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-35e7e035-6862-4317-aa56-cabb6d49ef13" }, { "id": "565c5311-fc2e-4d4a-b5c2-d9f348a12895", "name": "Conflict", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-565c5311-fc2e-4d4a-b5c2-d9f348a12895" }, { "id": "e6e6ec91-2924-4314-9b41-778cc470345b", "name": "Unprocessable Entity", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-e6e6ec91-2924-4314-9b41-778cc470345b" }, { "id": "6b93449a-5fd3-4d4a-99e1-7b8ddb1e50dd", "name": "Too many requests", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"type\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-6b93449a-5fd3-4d4a-99e1-7b8ddb1e50dd" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-ddcefefe-5380-4382-b1d9-a6a7eb0b0a1c" } ], "id": "e8ba0763-aff6-4311-abd1-09c702217231", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-e8ba0763-aff6-4311-abd1-09c702217231" }, { "name": "List Incentives", "id": "cabd8972-99a5-43b3-9e8d-aca331a863b6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] }, "description": "Lists all Incentives of a company\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View incentives (`incentive:read`) | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "c6790adb-4f0f-4ed2-8519-fafd42fd2a3d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"incentives\": [\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n },\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-c6790adb-4f0f-4ed2-8519-fafd42fd2a3d" }, { "id": "2037de78-ee0e-4e05-8cdb-873a3c03ea7f", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-2037de78-ee0e-4e05-8cdb-873a3c03ea7f" }, { "id": "ba40af81-a983-4a96-8f00-df1aa0e144e4", "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-ba40af81-a983-4a96-8f00-df1aa0e144e4" }, { "id": "a2cfb3ea-6ec2-4f6f-8176-f0c9f2585d5c", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-a2cfb3ea-6ec2-4f6f-8176-f0c9f2585d5c" }, { "id": "0a8d7766-4cb1-4e29-8ac7-d9dbd665a702", "name": "Unprocessable Entity", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-0a8d7766-4cb1-4e29-8ac7-d9dbd665a702" }, { "id": "f1d12c21-88d4-448b-b17c-2f8a43dbecfd", "name": "Too many requests", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/incentives?employment_id=&status=&recurring_incentive_id=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ], "query": [ { "description": "Filter by Employment ID", "key": "employment_id", "value": "" }, { "description": "Filter by Incentive status", "key": "status", "value": "" }, { "description": "Filter by Recurring Incentive id", "key": "recurring_incentive_id", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "" }, { "description": "Change the amount of records returned per page, defaults to 20, limited to 100", "key": "page_size", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-f1d12c21-88d4-448b-b17c-2f8a43dbecfd" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-cabd8972-99a5-43b3-9e8d-aca331a863b6" }, { "name": "Create Incentive", "id": "357e3938-1cce-4159-b35e-9affffef1a56", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] }, "description": "Creates an Incentive.\n\nIncentives use the currency of the employment specified provided in the `employment_id` field.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage incentives (`incentive:write`) |\n" }, "response": [ { "id": "6589fc26-5a54-4765-af6c-c7742763833f", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"incentive\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"\",\n \"status\": \"\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"effective_date\": \"\",\n \"expected_payout_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\",\n \"recurring_incentive_id\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-6589fc26-5a54-4765-af6c-c7742763833f" }, { "id": "0bcd49d3-915e-46b5-b214-f0e8efd74df4", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-0bcd49d3-915e-46b5-b214-f0e8efd74df4" }, { "id": "fc79309c-64ce-4f57-b451-bc9a4a489704", "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Unauthorized\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-fc79309c-64ce-4f57-b451-bc9a4a489704" }, { "id": "72c09f2d-1fbf-415b-a28c-ed7e458f7319", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Not Found\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-72c09f2d-1fbf-415b-a28c-ed7e458f7319" }, { "id": "ea508d57-b692-4de3-b019-fdbf132b2e74", "name": "Unprocessable Entity", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {}\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-ea508d57-b692-4de3-b019-fdbf132b2e74" }, { "id": "2d06db6f-13db-4d1f-b789-6d869a09e42d", "name": "Too many requests", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"type\": \"referral_bonus\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"period_end\": \"\",\n \"period_start\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": \"Too many requests\"\n}", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-2d06db6f-13db-4d1f-b789-6d869a09e42d" } ], "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-357e3938-1cce-4159-b35e-9affffef1a56" } ], "id": "a80a01ab-6942-4555-acaa-c73b198d423c", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-a80a01ab-6942-4555-acaa-c73b198d423c" } ], "id": "545515dc-a755-4f48-a4d7-bcaf4359fbde", "createdAt": "2026-07-28T02:46:36.000Z", "updatedAt": "2026-07-28T02:46:36.000Z", "uid": "35240-545515dc-a755-4f48-a4d7-bcaf4359fbde" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company_department:read webhook:write magic_link:write offboarding:write custom_field:write address:write expense:read employment:write identity_verification:write timesheet:write travel_letter:write incentive:read personal_detail:read invoices:write work_authorization:write timeoff:write company_structure:read benefit_renewal:write benefit_offer:read employment_documents onboarding:write payroll_run:read risk_reserve:write invoices resignation_letter:read resignation:read convert_currency:read employments probation_document:read company_admin payroll help_center_article:read timesheet:read custom_field_value:write company_currencies:read payslip:read pay_item:write resignation:write custom_field:read payroll_calendar:read contract_amendment:write offboarding:read timeoff:read probation_document:write country:read webhook:read company_department:write company_manager:read pay_item:read contract_amendment:read company:read sso_configuration:write benefit_offer:write contract_eligibility:write benefit_renewal:read background_check:read custom_field_value:read expense:write identity_verification:read address:read document:write time_and_attendance employment_payments form:read work_authorization:read invoices:read incentive:write employment:read contract:read company_manager:write travel_letter:read document:read sso_configuration:read", "type": "string" }, { "key": "accessTokenUrl", "value": "/auth/oauth2/token", "type": "string" }, { "key": "authUrl", "value": "/auth/oauth2/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://gateway.remote.com/" } ] }