{ "info": { "_postman_id": "7c1d723a-22f2-42da-858b-f9c42cdd16c0", "name": "Remote Address Details Pay & Compensation API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "lastUpdatedBy": "35240", "uid": "35240-7c1d723a-22f2-42da-858b-f9c42cdd16c0" }, "item": [ { "name": "v1", "item": [ { "name": "pay-items", "item": [ { "name": "bulk", "item": [ { "name": "Bulk Create Pay Items", "id": "a32c1dab-b92d-4b2f-9e2f-aded5ec99a9f", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] }, "description": "Bulk creates pay items for employments. Supports up to 500 items per request.\nIntegration-specific fields (shift code, currency, pay amount, etc.) go in the `provider_data` object.\nOnly Global Payroll employments are supported. Non-GP employments are returned as `employment_not_global_payroll`.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | - | Manage pay items (`pay_item:write`) |\n" }, "response": [ { "id": "78f1d234-bcfb-4450-9db5-02e948329afb", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"successes\": [\n {\n \"row_number\": \"\",\n \"pay_item\": {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n },\n {\n \"row_number\": \"\",\n \"pay_item\": {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n }\n ],\n \"failures\": [\n {\n \"error\": \"\",\n \"row_number\": \"\"\n },\n {\n \"error\": \"\",\n \"row_number\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-78f1d234-bcfb-4450-9db5-02e948329afb" }, { "id": "7a4d0a5f-4762-488b-ae5f-39e35fcd2df0", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-7a4d0a5f-4762-488b-ae5f-39e35fcd2df0" }, { "id": "a40efffe-563e-445f-973b-39a09302f0f1", "name": "Forbidden", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a40efffe-563e-445f-973b-39a09302f0f1" }, { "id": "41a88eef-bb0f-45fa-ae50-3651cc774119", "name": "Conflict", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-41a88eef-bb0f-45fa-ae50-3651cc774119" }, { "id": "9c88c530-9429-4ce4-9244-2668eb086615", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-9c88c530-9429-4ce4-9244-2668eb086615" }, { "id": "5a412f76-6b4d-4e35-9d21-f1edb7723f85", "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 \"pay_items\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/pay-items/bulk", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items", "bulk" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-5a412f76-6b4d-4e35-9d21-f1edb7723f85" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a32c1dab-b92d-4b2f-9e2f-aded5ec99a9f" } ], "id": "dd7a193f-769c-4f67-8685-843586c1f29d", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dd7a193f-769c-4f67-8685-843586c1f29d" }, { "name": "List Pay Items", "id": "66265e48-53c8-4192-bd80-ffbb69702906", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Lists pay items for a company with optional filtering by employment, date range, and pagination.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) |\n" }, "response": [ { "id": "55e3b645-bf43-400d-aa11-fa59dba74ee7", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"data\": [\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n },\n {\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"code\": \"\",\n \"amount\": \"\",\n \"provider_data\": {\n \"adjustment_effective_date\": \"\",\n \"hourly_rate\": \"\",\n \"hourly_rate_currency_code\": \"\",\n \"is_deduction\": \"\",\n \"pay_rate\": \"\",\n \"payout_amount\": \"\",\n \"payout_currency_code\": \"\",\n \"shift_code\": \"\",\n \"work_day_duration\": \"\"\n }\n }\n ],\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-55e3b645-bf43-400d-aa11-fa59dba74ee7" }, { "id": "7890d36b-bbef-4024-af38-725f91204734", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-7890d36b-bbef-4024-af38-725f91204734" }, { "id": "7568a0a1-f368-42e1-94cf-4a9afc9e6bf2", "name": "Forbidden", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-7568a0a1-f368-42e1-94cf-4a9afc9e6bf2" }, { "id": "ae00b8f8-70ca-4f61-8951-e05ddf520fda", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ae00b8f8-70ca-4f61-8951-e05ddf520fda" }, { "id": "26be79e1-74a5-48be-aa96-8a8cbcb28882", "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/pay-items?employment_slug=&effective_from=&effective_to=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pay-items" ], "query": [ { "description": "Filter by employment slug", "key": "employment_slug", "value": "" }, { "description": "Filter pay items with effective_date >= given date (YYYY-MM-DD)", "key": "effective_from", "value": "" }, { "description": "Filter pay items with effective_date <= given date (YYYY-MM-DD)", "key": "effective_to", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-26be79e1-74a5-48be-aa96-8a8cbcb28882" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-66265e48-53c8-4192-bd80-ffbb69702906" } ], "id": "d49b3e13-67cc-4bf4-9160-8e63b4a80ffd", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-d49b3e13-67cc-4bf4-9160-8e63b4a80ffd" }, { "name": "currency-converter", "item": [ { "name": "raw", "item": [ { "name": "Convert currency using flat rates", "id": "5aab5459-9902-4530-921f-af6a9bbc65b7", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/raw", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "raw" ] }, "description": "Convert currency using FX rates used in Remote\u2019s estimation tools.\n These rates are not guaranteed to match final onboarding or contract rates.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - |\n" }, "response": [ { "id": "ef08b74a-6e69-44b5-a44c-cef34bb63eca", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/raw", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "raw" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"conversion_data\": {\n \"source_amount\": \"\",\n \"source_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"target_amount\": \"\",\n \"target_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"exchange_rate\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ef08b74a-6e69-44b5-a44c-cef34bb63eca" }, { "id": "c4384c75-04ee-49ff-95c4-b9df10161658", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/raw", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "raw" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c4384c75-04ee-49ff-95c4-b9df10161658" }, { "id": "993f548d-9cfc-4006-9ba8-e9d3097971b5", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/raw", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "raw" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-993f548d-9cfc-4006-9ba8-e9d3097971b5" }, { "id": "6034a776-4b37-4eb2-844e-e48140f40ef1", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/raw", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "raw" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6034a776-4b37-4eb2-844e-e48140f40ef1" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-5aab5459-9902-4530-921f-af6a9bbc65b7" } ], "id": "91fd8579-867a-4508-854c-29527366521f", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-91fd8579-867a-4508-854c-29527366521f" }, { "name": "effective", "item": [ { "name": "Convert currency using dynamic rates", "id": "67ccae93-83a6-4f36-a140-b677f66346d8", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/effective", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "effective" ] }, "description": "Convert currency using the rates Remote applies during employment creation and invoicing.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - |\n" }, "response": [ { "id": "e01ca591-e101-4ca1-b154-291483b864a4", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/effective", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "effective" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"conversion_data\": {\n \"source_amount\": \"\",\n \"source_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"target_amount\": \"\",\n \"target_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"exchange_rate\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e01ca591-e101-4ca1-b154-291483b864a4" }, { "id": "5737c202-f5bb-4243-a1b8-e733992ea004", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/effective", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "effective" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-5737c202-f5bb-4243-a1b8-e733992ea004" }, { "id": "4fbb5c05-1b35-45e3-85d5-1541f2d2145e", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/effective", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "effective" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4fbb5c05-1b35-45e3-85d5-1541f2d2145e" }, { "id": "bf2491e3-e177-4a07-be8d-2f31e7b19055", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter/effective", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter", "effective" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bf2491e3-e177-4a07-be8d-2f31e7b19055" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-67ccae93-83a6-4f36-a140-b677f66346d8" } ], "id": "b71ca09f-db09-4013-8525-8c52b1974a71", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b71ca09f-db09-4013-8525-8c52b1974a71" }, { "name": "Convert currency using dynamic rates", "id": "ff4c1c84-8e02-4d9d-8068-dc110f7546d3", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter" ] }, "description": "Convert currency using the rates Remote applies during employment creation and invoicing.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage company resources (`company_admin`) | Convert currencies (`convert_currency:read`) | - |\n" }, "response": [ { "id": "4a083cc3-cf40-4c13-8628-cee3ea8bbc47", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"conversion_data\": {\n \"source_amount\": \"\",\n \"source_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"target_amount\": \"\",\n \"target_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"exchange_rate\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4a083cc3-cf40-4c13-8628-cee3ea8bbc47" }, { "id": "50b590fb-fac3-443e-bc01-178ee520d449", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-50b590fb-fac3-443e-bc01-178ee520d449" }, { "id": "2efb67b8-e61a-4fdc-92e4-cfe888c6d726", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2efb67b8-e61a-4fdc-92e4-cfe888c6d726" }, { "id": "b652528a-4eed-4c78-9d07-49d26628d513", "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 \"source_currency\": \"\",\n \"target_currency\": \"\",\n \"amount\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/currency-converter", "host": [ "{{baseUrl}}" ], "path": [ "v1", "currency-converter" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b652528a-4eed-4c78-9d07-49d26628d513" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ff4c1c84-8e02-4d9d-8068-dc110f7546d3" } ], "id": "f13cfc9a-f1eb-4312-90ee-44f48728f69d", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-f13cfc9a-f1eb-4312-90ee-44f48728f69d" }, { "name": "cost-calculator", "item": [ { "name": "estimation", "item": [ { "name": "Creates a cost estimation of employments", "id": "058db852-346b-4be9-925c-ecde6ff3e261", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation" ] } }, "response": [ { "id": "ac1cab2e-89f3-4a6b-8dda-56ae81a0ee1b", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employments\": [\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"features\": [\n \"\",\n \"\"\n ]\n },\n \"employer_currency_costs\": {\n \"annual_gross_salary\": \"\",\n \"annual_contributions_total\": \"\",\n \"annual_total\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"extra_statutory_payments_total\": \"\",\n \"monthly_contributions_total\": \"\",\n \"monthly_gross_salary\": \"\",\n \"monthly_tce\": \"\",\n \"monthly_total\": \"\",\n \"annual_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_benefits_total\": \"\",\n \"annual_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_indirect_tax\": \"\",\n \"annual_management_fee\": \"\",\n \"discount\": {\n \"annual_amount\": \"\",\n \"monthly_amount\": \"\",\n \"text\": \"\",\n \"months\": \"\"\n },\n \"extra_statutory_payments_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_total\": \"\",\n \"monthly_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_indirect_tax\": \"\",\n \"monthly_management_fee\": \"\"\n },\n \"has_extra_statutory_payment\": \"\",\n \"region\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"active\"\n },\n \"regional_currency_costs\": {\n \"annual_gross_salary\": \"\",\n \"annual_contributions_total\": \"\",\n \"annual_total\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"extra_statutory_payments_total\": \"\",\n \"monthly_contributions_total\": \"\",\n \"monthly_gross_salary\": \"\",\n \"monthly_tce\": \"\",\n \"monthly_total\": \"\",\n \"annual_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_benefits_total\": \"\",\n \"annual_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_indirect_tax\": \"\",\n \"annual_management_fee\": \"\",\n \"discount\": {\n \"annual_amount\": \"\",\n \"monthly_amount\": \"\",\n \"text\": \"\",\n \"months\": \"\"\n },\n \"extra_statutory_payments_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_total\": \"\",\n \"monthly_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_indirect_tax\": \"\",\n \"monthly_management_fee\": \"\"\n },\n \"country_benefits_details_url\": \"\",\n \"country_guide_url\": \"\",\n \"minimum_onboarding_time\": \"\"\n },\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"features\": [\n \"\",\n \"\"\n ]\n },\n \"employer_currency_costs\": {\n \"annual_gross_salary\": \"\",\n \"annual_contributions_total\": \"\",\n \"annual_total\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"extra_statutory_payments_total\": \"\",\n \"monthly_contributions_total\": \"\",\n \"monthly_gross_salary\": \"\",\n \"monthly_tce\": \"\",\n \"monthly_total\": \"\",\n \"annual_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_benefits_total\": \"\",\n \"annual_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_indirect_tax\": \"\",\n \"annual_management_fee\": \"\",\n \"discount\": {\n \"annual_amount\": \"\",\n \"monthly_amount\": \"\",\n \"text\": \"\",\n \"months\": \"\"\n },\n \"extra_statutory_payments_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_total\": \"\",\n \"monthly_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_indirect_tax\": \"\",\n \"monthly_management_fee\": \"\"\n },\n \"has_extra_statutory_payment\": \"\",\n \"region\": {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"inactive\"\n },\n \"regional_currency_costs\": {\n \"annual_gross_salary\": \"\",\n \"annual_contributions_total\": \"\",\n \"annual_total\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"extra_statutory_payments_total\": \"\",\n \"monthly_contributions_total\": \"\",\n \"monthly_gross_salary\": \"\",\n \"monthly_tce\": \"\",\n \"monthly_total\": \"\",\n \"annual_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_benefits_total\": \"\",\n \"annual_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"annual_indirect_tax\": \"\",\n \"annual_management_fee\": \"\",\n \"discount\": {\n \"annual_amount\": \"\",\n \"monthly_amount\": \"\",\n \"text\": \"\",\n \"months\": \"\"\n },\n \"extra_statutory_payments_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_benefits_total\": \"\",\n \"monthly_contributions_breakdown\": [\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n },\n {\n \"amount\": \"\",\n \"description\": \"\",\n \"name\": \"\",\n \"zendesk_article_url\": \"\",\n \"zendesk_article_id\": \"\"\n }\n ],\n \"monthly_indirect_tax\": \"\",\n \"monthly_management_fee\": \"\"\n },\n \"country_benefits_details_url\": \"\",\n \"country_guide_url\": \"\",\n \"minimum_onboarding_time\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ac1cab2e-89f3-4a6b-8dda-56ae81a0ee1b" }, { "id": "489beeba-f775-41d2-ae71-105464863e8c", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-489beeba-f775-41d2-ae71-105464863e8c" }, { "id": "865b8e90-6b73-43db-bf04-6af113bca8ca", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-865b8e90-6b73-43db-bf04-6af113bca8ca" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-058db852-346b-4be9-925c-ecde6ff3e261" } ], "id": "57b34f13-3a45-4d9b-b12e-38acaf683e3d", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-57b34f13-3a45-4d9b-b12e-38acaf683e3d" }, { "name": "estimation-pdf", "item": [ { "name": "Creates PDF cost estimation of employments", "id": "d02e7b0b-c986-4ee7-b0d7-462ff570c1db", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-pdf" ] }, "description": "Creates a PDF cost estimation of employments based on the provided parameters." }, "response": [ { "id": "c86206a5-4d05-4019-932c-d9bbbd120fb6", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-pdf" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"content\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c86206a5-4d05-4019-932c-d9bbbd120fb6" }, { "id": "8d401776-a2a8-40db-987c-c33484142f28", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-pdf" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8d401776-a2a8-40db-987c-c33484142f28" }, { "id": "1244a923-2b47-43f4-97a9-0b7d9d56da0f", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-pdf" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-1244a923-2b47-43f4-97a9-0b7d9d56da0f" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-d02e7b0b-c986-4ee7-b0d7-462ff570c1db" } ], "id": "789c51da-2e70-434d-81a7-0e4afbeb1ffb", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-789c51da-2e70-434d-81a7-0e4afbeb1ffb" }, { "name": "countries", "item": [ { "name": "List countries for Cost Calculator", "id": "2c0e495e-cdf5-499a-9880-576109bf0c63", "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/cost-calculator/countries?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "countries" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ] }, "description": "Lists active and processing countries" }, "response": [ { "id": "e042e28f-cce4-4dc6-a1ad-580487aeb258", "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/cost-calculator/countries?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "countries" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"original_country_slug\": \"\",\n \"region_slug\": \"\",\n \"availability\": \"active\",\n \"child_regions\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"active\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"inactive\"\n }\n ],\n \"has_additional_fields\": \"\"\n },\n {\n \"code\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"symbol\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\",\n \"original_country_slug\": \"\",\n \"region_slug\": \"\",\n \"availability\": \"active\",\n \"child_regions\": [\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"active\"\n },\n {\n \"name\": \"\",\n \"slug\": \"\",\n \"child_regions\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"code\": \"\",\n \"status\": \"inactive\"\n }\n ],\n \"has_additional_fields\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e042e28f-cce4-4dc6-a1ad-580487aeb258" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2c0e495e-cdf5-499a-9880-576109bf0c63" } ], "id": "29d65f06-e7e4-426d-ac9c-0713cbcadca6", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-29d65f06-e7e4-426d-ac9c-0713cbcadca6" }, { "name": "regions", "item": [ { "name": "{slug}", "item": [ { "name": "fields", "item": [ { "name": "Show region fields", "id": "92d809b5-3ac4-4f34-81b2-7aec102e7168", "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/cost-calculator/regions/:slug/fields?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "regions", ":slug", "fields" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ], "variable": [ { "id": "2a2c3ea6-72a8-4190-8631-a635991fde40", "key": "slug", "value": "", "description": "(Required) Slug" } ] }, "description": "Returns required fields JSON Schema for a given region. These are required in order to calculate\n the cost of employment for the region. These fields are based on employer contributions that are associated\n with the region or any of it's parent regions." }, "response": [ { "id": "b504ae3e-d055-473a-ba82-04a9a0edf251", "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/cost-calculator/regions/:slug/fields?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "regions", ":slug", "fields" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ], "variable": [ { "key": "slug" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"schema\": {\n \"properties\": {\n \"dolor1a_\": 18560918,\n \"enim24\": 49289612\n },\n \"required\": [\n \"\",\n \"\"\n ],\n \"x-jsf-order\": [\n \"\",\n \"\"\n ]\n },\n \"version\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b504ae3e-d055-473a-ba82-04a9a0edf251" }, { "id": "b79b071d-1935-4759-af76-b589e3357502", "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/cost-calculator/regions/:slug/fields?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "regions", ":slug", "fields" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ], "variable": [ { "key": "slug" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b79b071d-1935-4759-af76-b589e3357502" }, { "id": "765f0b54-bee5-48b4-b589-24d0f96e03c4", "name": "Internal Server Error", "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/cost-calculator/regions/:slug/fields?include_premium_benefits=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "regions", ":slug", "fields" ], "query": [ { "description": "If the premium benefits should be included in the response", "key": "include_premium_benefits", "value": "" } ], "variable": [ { "key": "slug" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": {\n \"laborumfb\": -55145511.022306204,\n \"culpac\": \"ut dolore Duis dolor\",\n \"eaef\": true\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-765f0b54-bee5-48b4-b589-24d0f96e03c4" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-92d809b5-3ac4-4f34-81b2-7aec102e7168" } ], "id": "ab8918f7-34bd-455c-95e4-36551d47a554", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ab8918f7-34bd-455c-95e4-36551d47a554" } ], "id": "db127da1-ab79-470c-93df-9a27b09d16e2", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-db127da1-ab79-470c-93df-9a27b09d16e2" } ], "id": "0716b19b-b7ce-46ad-b289-a5ba4a050a68", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0716b19b-b7ce-46ad-b289-a5ba4a050a68" }, { "name": "estimation-csv", "item": [ { "name": "Creates a CSV cost estimation of employments", "id": "6aacdd13-7164-4a07-b635-f1a49bb9d1b2", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-csv", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-csv" ] }, "description": "Creates CSV cost estimation of employments" }, "response": [ { "id": "621880dd-3745-42c0-b7f6-754556818e10", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-csv", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-csv" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"content\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-621880dd-3745-42c0-b7f6-754556818e10" }, { "id": "dbcd1f42-d548-4aa0-9308-7fbf39c4637e", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-csv", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-csv" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dbcd1f42-d548-4aa0-9308-7fbf39c4637e" }, { "id": "de784603-c809-48d3-8b07-09c39946ef17", "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 \"employments\": [\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"indefinite\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n },\n {\n \"region_slug\": \"\",\n \"age\": \"\",\n \"annual_gross_salary\": \"\",\n \"annual_gross_salary_in_employer_currency\": \"\",\n \"annual_total_cost\": \"\",\n \"annual_total_cost_in_employer_currency\": \"\",\n \"benefits\": [\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n },\n {\n \"benefit_group_slug\": \"\",\n \"benefit_tier_slug\": \"\"\n }\n ],\n \"discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"employment_term\": \"fixed\",\n \"regional_to_employer_exchange_rate\": \"\",\n \"title\": \"\"\n }\n ],\n \"employer_currency_slug\": \"\",\n \"company_name\": \"\",\n \"global_discount\": {\n \"text\": \"\",\n \"amount\": \"\",\n \"months\": 12,\n \"percent\": \"\",\n \"quoted_amount\": \"\"\n },\n \"include_benefits\": \"\",\n \"include_cost_breakdowns\": \"\",\n \"include_management_fee\": \"\",\n \"include_premium_benefits\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/cost-calculator/estimation-csv", "host": [ "{{baseUrl}}" ], "path": [ "v1", "cost-calculator", "estimation-csv" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-de784603-c809-48d3-8b07-09c39946ef17" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6aacdd13-7164-4a07-b635-f1a49bb9d1b2" } ], "id": "982097d5-92d6-4b67-b952-a4c20c25432a", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-982097d5-92d6-4b67-b952-a4c20c25432a" } ], "id": "b3042c27-ae48-4fd3-aeb5-a33dfa14523e", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b3042c27-ae48-4fd3-aeb5-a33dfa14523e" }, { "name": "payroll-calendars", "item": [ { "name": "{cycle}", "item": [ { "name": "List Company Payroll Calendar", "id": "b888c9f7-8839-4ebf-bfe6-d2808c8b05a6", "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/payroll-calendars/:cycle?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars", ":cycle" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "0c0cefb8-4e63-4aa3-96d5-7ccceaa3d778", "key": "cycle", "value": "", "description": "(Required) The cycle for which to list the payroll calendars. Format: YYYY-MM" } ] }, "description": "List all payroll calendars for the company within the requested cycle.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - |\n" }, "response": [ { "id": "8a3fa68b-f5a8-4df4-93de-8d9daeaad80a", "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/payroll-calendars/:cycle?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars", ":cycle" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "cycle" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"payroll_calendars\": [\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"owned_by_remote\": \"\",\n \"cycle_frequency\": \"bi_weekly\",\n \"cycles\": [\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n },\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n }\n ]\n },\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"owned_by_remote\": \"\",\n \"cycle_frequency\": \"weekly\",\n \"cycles\": [\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n },\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n }\n ]\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8a3fa68b-f5a8-4df4-93de-8d9daeaad80a" }, { "id": "4bac78b6-b4ef-44b4-83bd-8284a5b217d3", "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/payroll-calendars/:cycle?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars", ":cycle" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "cycle" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4bac78b6-b4ef-44b4-83bd-8284a5b217d3" }, { "id": "479f8181-eae8-4771-bbc2-16ab0e817a7f", "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/payroll-calendars/:cycle?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars", ":cycle" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "cycle" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-479f8181-eae8-4771-bbc2-16ab0e817a7f" }, { "id": "94ad5812-5805-46a1-b028-a2299350d378", "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/payroll-calendars/:cycle?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars", ":cycle" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "cycle" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-94ad5812-5805-46a1-b028-a2299350d378" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b888c9f7-8839-4ebf-bfe6-d2808c8b05a6" } ], "id": "a2524b96-ea17-437e-8360-c9334a698653", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a2524b96-ea17-437e-8360-c9334a698653" }, { "name": "List EOR Payroll Calendar", "id": "062f3176-bba9-4a6c-8e68-bcc620048e9b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "company:read company:write company_admin company_management convert_currency:read country:read employment_documents employment_payments employments help_center_article:read invoices payroll payroll_calendar:read pricing_plan:read pricing_plan:write time_and_attendance webhook:read webhook:write", "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/payroll-calendars?country_code=&year=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars" ], "query": [ { "description": "Filter payroll calendars by country code", "key": "country_code", "value": "" }, { "description": "Filter payroll calendars by year", "key": "year", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "List all active payroll calendars for EOR.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll calendars (`payroll_calendar:read`) | - |\n" }, "response": [ { "id": "92adef85-e2f9-4af0-8f49-29f565f39781", "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/payroll-calendars?country_code=&year=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars" ], "query": [ { "description": "Filter payroll calendars by country code", "key": "country_code", "value": "" }, { "description": "Filter payroll calendars by year", "key": "year", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"payroll_calendars\": [\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"plus\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"cycle_frequency\": \"bi_monthly\",\n \"cycles\": [\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n },\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n }\n ],\n \"id\": \"\"\n },\n {\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"cor\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"cycle_frequency\": \"bi_weekly\",\n \"cycles\": [\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n },\n {\n \"employee_inclusion_cutoff_date\": \"\",\n \"end_date\": \"\",\n \"input_cutoff_date\": \"\",\n \"payment_date\": \"\",\n \"start_date\": \"\"\n }\n ],\n \"id\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-92adef85-e2f9-4af0-8f49-29f565f39781" }, { "id": "85211cf3-171c-4eb3-a145-78e4611c37d6", "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/payroll-calendars?country_code=&year=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars" ], "query": [ { "description": "Filter payroll calendars by country code", "key": "country_code", "value": "" }, { "description": "Filter payroll calendars by year", "key": "year", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-85211cf3-171c-4eb3-a145-78e4611c37d6" }, { "id": "076a8fcc-6a31-49d2-8afc-003de48055fb", "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/payroll-calendars?country_code=&year=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars" ], "query": [ { "description": "Filter payroll calendars by country code", "key": "country_code", "value": "" }, { "description": "Filter payroll calendars by year", "key": "year", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-076a8fcc-6a31-49d2-8afc-003de48055fb" }, { "id": "92e42722-5090-4e49-8eb8-98d93a4854e5", "name": "Unprocessable Entity", "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/payroll-calendars?country_code=&year=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-calendars" ], "query": [ { "description": "Filter payroll calendars by country code", "key": "country_code", "value": "" }, { "description": "Filter payroll calendars by year", "key": "year", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-92e42722-5090-4e49-8eb8-98d93a4854e5" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-062f3176-bba9-4a6c-8e68-bcc620048e9b" } ], "id": "a1804297-a9cc-4229-a775-a7c1e640cb08", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a1804297-a9cc-4229-a775-a7c1e640cb08" }, { "name": "incentives", "item": [ { "name": "recurring", "item": [ { "name": "{id}", "item": [ { "name": "Delete a Recurring Incentive", "id": "445b8bee-5ca2-4da7-b5c3-37b19c2d3c51", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":id" ], "variable": [ { "id": "1f832573-ee75-46ab-8f35-5a4baa43b276", "key": "id", "value": "", "description": "(Required) Recurring Incentive ID" } ] }, "description": "Delete a Recurring Incentive, that is, a monthly paid incentive.\n\nInternally, Remote schedules upcoming incentives. As such, when you attempt to\ndelete a recurring incentive, Remote will **ONLY** delete scheduled incentives\nwith the `pending` status.\n\nIncentives payments that are already scheduled and cannot be deleted will be\nincluded in the response, in case you need to reference them.\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": "3f8c409e-db21-4365-83a0-4945e90d6a00", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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 \"already_scheduled_incentives\": [\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 \"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 \"status\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3f8c409e-db21-4365-83a0-4945e90d6a00" }, { "id": "52907ef8-6c98-40d4-bd63-5158f78bcadd", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-52907ef8-6c98-40d4-bd63-5158f78bcadd" }, { "id": "4bf69d35-cebc-4066-a943-6dc30f7e4eac", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4bf69d35-cebc-4066-a943-6dc30f7e4eac" }, { "id": "2ce5feab-51ec-4590-b77a-66798414b9fc", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2ce5feab-51ec-4590-b77a-66798414b9fc" }, { "id": "645bb69b-55d0-40fd-81f8-38465f880390", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-645bb69b-55d0-40fd-81f8-38465f880390" }, { "id": "78f3fc9c-acef-4a18-9a90-12befec1f4cb", "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/recurring/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-78f3fc9c-acef-4a18-9a90-12befec1f4cb" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-445b8bee-5ca2-4da7-b5c3-37b19c2d3c51" } ], "id": "15e0cfac-f726-4714-8d5c-4abb050c6f31", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-15e0cfac-f726-4714-8d5c-4abb050c6f31" }, { "name": "List Recurring Incentive", "id": "8fe521cc-803e-43d2-b252-be430afc285e", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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": "List all Recurring Incentives of a company.\n\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": "446334af-a907-4494-b7a4-0d60db98b468", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"recurring_incentives\": [\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"meal_allowance\",\n \"status\": \"active\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"note\": \"\"\n },\n {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"allowance\",\n \"status\": \"active\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"note\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-446334af-a907-4494-b7a4-0d60db98b468" }, { "id": "dc77b4cf-ea08-4fbd-a635-9808f2f41ea7", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dc77b4cf-ea08-4fbd-a635-9808f2f41ea7" }, { "id": "c947de42-9de1-4c6b-b5e0-85bdfa17c0af", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c947de42-9de1-4c6b-b5e0-85bdfa17c0af" }, { "id": "78ce42cc-aa99-41fc-a29e-f608501c94e9", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-78ce42cc-aa99-41fc-a29e-f608501c94e9" }, { "id": "80dc9af5-8a38-4d08-8e5c-5b8487ef4605", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-80dc9af5-8a38-4d08-8e5c-5b8487ef4605" }, { "id": "01fa8591-72f7-4a63-8f84-61777f74f4d0", "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/recurring?status=&type=¬e=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ], "query": [ { "description": "Filter by recurring incentive status: active or deactive.", "key": "status", "value": "" }, { "description": "Filter by recurring incentive type.", "key": "type", "value": "" }, { "description": "Filter by recurring incentives that contain the value in their notes.", "key": "note", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-01fa8591-72f7-4a63-8f84-61777f74f4d0" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8fe521cc-803e-43d2-b252-be430afc285e" }, { "name": "Create Recurring Incentive", "id": "46fbc0ff-37fd-44e3-a199-c00156e75ac2", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] }, "description": "Create a Recurring Incentive, that is, a monthly paid 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": "dc2e8b9d-6b00-44d7-8568-e8513b17f405", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"recurring_incentive\": {\n \"id\": \"\",\n \"employment_id\": \"\",\n \"type\": \"holiday_bonus\",\n \"status\": \"active\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"note\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dc2e8b9d-6b00-44d7-8568-e8513b17f405" }, { "id": "94e02091-9e8a-4106-82e7-f70ddb357b63", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-94e02091-9e8a-4106-82e7-f70ddb357b63" }, { "id": "3ee73327-7241-4a31-9c59-da043ada63e5", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3ee73327-7241-4a31-9c59-da043ada63e5" }, { "id": "e64ea99e-45ac-422c-90ea-f5293be935e2", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e64ea99e-45ac-422c-90ea-f5293be935e2" }, { "id": "e0952dcb-5b8e-48ad-a912-b5433b0b7bcb", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e0952dcb-5b8e-48ad-a912-b5433b0b7bcb" }, { "id": "ac2f8eed-a185-46ce-a927-eb2bae7fdf0a", "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\": \"on_call_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"net\",\n \"employment_id\": \"\",\n \"effective_date\": \"\",\n \"note\": \"\",\n \"duration_in_months\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/incentives/recurring", "host": [ "{{baseUrl}}" ], "path": [ "v1", "incentives", "recurring" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ac2f8eed-a185-46ce-a927-eb2bae7fdf0a" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-46fbc0ff-37fd-44e3-a199-c00156e75ac2" } ], "id": "00c3cf1b-9401-42a5-9ff1-209ec7191318", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-00c3cf1b-9401-42a5-9ff1-209ec7191318" }, { "name": "{id}", "item": [ { "name": "Delete an Incentive", "id": "e7f7178a-4ac5-454b-90c8-345b6ace88c6", "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": "a34ee576-e98f-4c0d-8ab7-68f4a7c02403", "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": "478b84ce-83b1-42ce-a9e8-43c001127a6d", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-478b84ce-83b1-42ce-a9e8-43c001127a6d" }, { "id": "af3bd4be-e46c-4f75-abc7-17673eeff00e", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-af3bd4be-e46c-4f75-abc7-17673eeff00e" }, { "id": "46ca6c04-6592-4e48-9f28-72e31dc7059a", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-46ca6c04-6592-4e48-9f28-72e31dc7059a" }, { "id": "49b7c6b7-cc48-44d7-a1dd-43c4b9bc29ce", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-49b7c6b7-cc48-44d7-a1dd-43c4b9bc29ce" }, { "id": "5b127c89-b5c8-4d2b-9546-08792feacd3d", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-5b127c89-b5c8-4d2b-9546-08792feacd3d" }, { "id": "238d20e6-2cb2-40ee-bfe5-beb00ddab737", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-238d20e6-2cb2-40ee-bfe5-beb00ddab737" }, { "id": "21068828-2f8d-4ac9-966a-ab80fc7bbdf6", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-21068828-2f8d-4ac9-966a-ab80fc7bbdf6" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e7f7178a-4ac5-454b-90c8-345b6ace88c6" }, { "name": "Show Incentive", "id": "c8b9f977-c4eb-4f25-b1e7-3f511476fdb0", "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": "6d246f4d-7854-45d7-86d2-4d9199103d60", "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": "a2cbe89b-164b-4804-8ce6-7579999e7ede", "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\": \"net\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a2cbe89b-164b-4804-8ce6-7579999e7ede" }, { "id": "ffebc869-dac7-4e27-87f0-6694b3e6215e", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ffebc869-dac7-4e27-87f0-6694b3e6215e" }, { "id": "a3400e98-192a-46a3-9e73-90b4f99b3db6", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a3400e98-192a-46a3-9e73-90b4f99b3db6" }, { "id": "4a2acf33-5838-4852-884f-57a54211e552", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4a2acf33-5838-4852-884f-57a54211e552" }, { "id": "8cf7f758-7de2-4b1b-b052-4f69ce8e162b", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8cf7f758-7de2-4b1b-b052-4f69ce8e162b" }, { "id": "cce68c3b-493c-493c-9188-1ecf88315d65", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-cce68c3b-493c-493c-9188-1ecf88315d65" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c8b9f977-c4eb-4f25-b1e7-3f511476fdb0" }, { "name": "Update Incentive", "id": "6569aa30-3ca6-46d7-aeef-efa92c19be15", "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": "cf1f25ad-081d-40c6-97f0-d2d8ca613d4c", "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": "9a3b0caf-9dcc-4907-a93b-b7c745562005", "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\": \"net\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-9a3b0caf-9dcc-4907-a93b-b7c745562005" }, { "id": "fcf04eea-ca7f-4edd-99e4-ec67356ff1a4", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-fcf04eea-ca7f-4edd-99e4-ec67356ff1a4" }, { "id": "927a4d95-f5eb-4ae6-9042-b714d1ed29a8", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-927a4d95-f5eb-4ae6-9042-b714d1ed29a8" }, { "id": "b65620f5-4226-4f3a-b999-07b0b1fa0477", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b65620f5-4226-4f3a-b999-07b0b1fa0477" }, { "id": "c4fef7d4-909f-400a-9113-2c0f0f003e7c", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c4fef7d4-909f-400a-9113-2c0f0f003e7c" }, { "id": "704e7ec7-1340-48a8-9740-a21a5d18b4be", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-704e7ec7-1340-48a8-9740-a21a5d18b4be" }, { "id": "49799d6c-4638-4851-8b5a-816ee5a6d862", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-49799d6c-4638-4851-8b5a-816ee5a6d862" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6569aa30-3ca6-46d7-aeef-efa92c19be15" }, { "name": "Update Incentive", "id": "e6b9c7e2-2197-424b-816b-96c4f818e656", "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": "3d18d108-f7bb-46e2-9d21-c8baa0e1f33a", "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": "db92e655-ac91-42ef-afed-2037a100274b", "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\": \"net\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-db92e655-ac91-42ef-afed-2037a100274b" }, { "id": "48486669-e5ad-4b8e-a45b-9e99c5bb469e", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-48486669-e5ad-4b8e-a45b-9e99c5bb469e" }, { "id": "6e4b1444-4571-4231-9fd1-146a9ccdff2a", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6e4b1444-4571-4231-9fd1-146a9ccdff2a" }, { "id": "1aa70601-00bd-4a0a-88ae-71a82b60bf7d", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-1aa70601-00bd-4a0a-88ae-71a82b60bf7d" }, { "id": "a1ede7b7-eff8-4fcb-805f-41de3ad7a684", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a1ede7b7-eff8-4fcb-805f-41de3ad7a684" }, { "id": "6c8f4c27-7079-445b-8778-c13253343bd8", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6c8f4c27-7079-445b-8778-c13253343bd8" }, { "id": "8f31d72f-514e-4a1b-a807-1f33a722796c", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8f31d72f-514e-4a1b-a807-1f33a722796c" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e6b9c7e2-2197-424b-816b-96c4f818e656" } ], "id": "85c5cc00-03af-44d3-91f3-e184447bbab3", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-85c5cc00-03af-44d3-91f3-e184447bbab3" }, { "name": "List Incentives", "id": "11a6854f-4958-481d-addc-108b96bffdd4", "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": "46cd196c-554b-4e89-ac3c-54c9960d8fdd", "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\": \"net\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-46cd196c-554b-4e89-ac3c-54c9960d8fdd" }, { "id": "4b81ef8a-4f4c-40a0-8570-37fe8e0f2f76", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4b81ef8a-4f4c-40a0-8570-37fe8e0f2f76" }, { "id": "dfddb8f5-bf4e-40c4-a3f7-1574a6abf597", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dfddb8f5-bf4e-40c4-a3f7-1574a6abf597" }, { "id": "5bff4ac4-d3d0-47b8-bf90-f46cffc53b3a", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-5bff4ac4-d3d0-47b8-bf90-f46cffc53b3a" }, { "id": "070c41d2-ba36-4f67-94ba-1681f70ff1e4", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-070c41d2-ba36-4f67-94ba-1681f70ff1e4" }, { "id": "4c894272-9b19-4b4a-9b2e-3af5447f82d6", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4c894272-9b19-4b4a-9b2e-3af5447f82d6" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-11a6854f-4958-481d-addc-108b96bffdd4" }, { "name": "Create Incentive", "id": "ede956d7-d75f-48b4-b86b-4044434a27bc", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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": "343d9337-0198-45ba-a2e6-63d1b7280af9", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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\": \"net\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-343d9337-0198-45ba-a2e6-63d1b7280af9" }, { "id": "376871c5-3812-4754-bc14-a7bdcfade6c2", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-376871c5-3812-4754-bc14-a7bdcfade6c2" }, { "id": "947b45fc-11b9-4387-b88f-fa09436b8922", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-947b45fc-11b9-4387-b88f-fa09436b8922" }, { "id": "0bf2938b-0462-4e8f-8f8d-85382d988f69", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0bf2938b-0462-4e8f-8f8d-85382d988f69" }, { "id": "18cfb735-a6aa-47c5-bb85-f3cbbd6de840", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-18cfb735-a6aa-47c5-bb85-f3cbbd6de840" }, { "id": "2e8cd7ca-4b9b-4546-8495-ab4bb3601a44", "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\": \"phone_allowance\",\n \"amount\": \"\",\n \"amount_tax_type\": \"gross\",\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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2e8cd7ca-4b9b-4546-8495-ab4bb3601a44" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ede956d7-d75f-48b4-b86b-4044434a27bc" } ], "id": "203fe111-449e-43fc-98fc-027f4108733e", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-203fe111-449e-43fc-98fc-027f4108733e" }, { "name": "expenses", "item": [ { "name": "{expense_id}", "item": [ { "name": "receipt", "item": [ { "name": "Download a receipt", "id": "e5b28db1-5864-4295-ae9e-1f28a1e05166", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" } ], "url": { "raw": "{{baseUrl}}/v1/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "id": "d6928096-fd8c-40b1-b866-d84ff6999703", "key": "expense_id", "value": "", "description": "(Required) The expense ID" } ] }, "description": " Downloads an expense receipt.\n\n Deprecated since late February 2024 in favour of **[Download a receipt by id](#tag/Expenses/operation/get_download_by_id_expense_receipt)** endpoint.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "0355125f-159c-4dfd-9184-74d1b145c3d2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0355125f-159c-4dfd-9184-74d1b145c3d2" }, { "id": "3436e5f7-659d-45d5-8048-13936a593efd", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3436e5f7-659d-45d5-8048-13936a593efd" }, { "id": "be45e343-f984-4d84-a220-6ebb0fe2850c", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-be45e343-f984-4d84-a220-6ebb0fe2850c" }, { "id": "8b2fa9cf-46a3-4de9-bba7-3448e92c257e", "name": "Forbidden", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_id" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8b2fa9cf-46a3-4de9-bba7-3448e92c257e" }, { "id": "c7fb73e0-4ad8-44b9-a0d6-fe4d4cf34523", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c7fb73e0-4ad8-44b9-a0d6-fe4d4cf34523" }, { "id": "bc7f081d-cd01-4819-8f3c-d96995266c4d", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bc7f081d-cd01-4819-8f3c-d96995266c4d" }, { "id": "c6501ea7-885e-49d9-92d3-0fde7da650c5", "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/expenses/:expense_id/receipt", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipt" ], "variable": [ { "key": "expense_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c6501ea7-885e-49d9-92d3-0fde7da650c5" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e5b28db1-5864-4295-ae9e-1f28a1e05166" } ], "id": "566ae48e-450e-44b2-aa6e-ddb4c2f8c21c", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-566ae48e-450e-44b2-aa6e-ddb4c2f8c21c" }, { "name": "receipts", "item": [ { "name": "{receipt_id}", "item": [ { "name": "Download a receipt by id", "id": "1ab4275e-1162-4159-9b18-69c016082e9a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" } ], "url": { "raw": "{{baseUrl}}/v1/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "id": "8f10c140-3758-494b-8cac-b4937b0983a4", "key": "expense_id", "value": "", "description": "(Required) The expense ID" }, { "id": "da7bac77-94dc-4233-aae8-f29aceab2c36", "key": "receipt_id", "value": "", "description": "(Required) The receipt ID" } ] }, "description": "Download a receipt by id.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "e779b048-abb9-49c5-aa08-593be035cec6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/pdf" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/pdf" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e779b048-abb9-49c5-aa08-593be035cec6" }, { "id": "42bd5721-1cb6-4ca5-88eb-7227a0f1567e", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-42bd5721-1cb6-4ca5-88eb-7227a0f1567e" }, { "id": "01afaa3a-e5e7-48e6-998d-90e9f2cf8aba", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-01afaa3a-e5e7-48e6-998d-90e9f2cf8aba" }, { "id": "3a7b0f35-851a-4574-86f7-c01040ccbb8d", "name": "Forbidden", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_id" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3a7b0f35-851a-4574-86f7-c01040ccbb8d" }, { "id": "4d8cf552-48e8-4b41-9e32-0ec7a897237f", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4d8cf552-48e8-4b41-9e32-0ec7a897237f" }, { "id": "7f72161e-563e-4132-8409-0f2956683b98", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-7f72161e-563e-4132-8409-0f2956683b98" }, { "id": "d97c6b0a-26b6-422d-800c-94c5b280992e", "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/expenses/:expense_id/receipts/:receipt_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":expense_id", "receipts", ":receipt_id" ], "variable": [ { "key": "expense_id" }, { "key": "receipt_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-d97c6b0a-26b6-422d-800c-94c5b280992e" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-1ab4275e-1162-4159-9b18-69c016082e9a" } ], "id": "0fec4a77-2494-4f96-a3c9-5649c8ad636e", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0fec4a77-2494-4f96-a3c9-5649c8ad636e" } ], "id": "13fd628d-c430-43e2-8cef-9b5661bc846e", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-13fd628d-c430-43e2-8cef-9b5661bc846e" } ], "id": "a933a67f-423d-460d-885f-3d3fc80ef889", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a933a67f-423d-460d-885f-3d3fc80ef889" }, { "name": "categories", "item": [ { "name": "List expense categories", "id": "e6ec8665-5dee-4689-be76-4c1c59c0cb84", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "value": "" } ] }, "description": "Lists the effective hierarchy of expense categories. At least one of employment_id, expense_id, or country_code must be provided." }, "response": [ { "id": "c7cab69c-1c17-4d7d-9482-f811cb7c7f59", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"is_selectable\": \"\",\n \"parent\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"prompt\": \"\",\n \"scope\": \"\",\n \"slug\": \"\",\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"instructions\": \"\",\n \"is_selectable\": \"\",\n \"parent\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"prompt\": \"\",\n \"scope\": \"\",\n \"slug\": \"\",\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c7cab69c-1c17-4d7d-9482-f811cb7c7f59" }, { "id": "ee13e5ca-d88b-4e33-8e46-57a631af384e", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ee13e5ca-d88b-4e33-8e46-57a631af384e" }, { "id": "18d98998-1ff9-41cf-96c7-cea052f748a6", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-18d98998-1ff9-41cf-96c7-cea052f748a6" }, { "id": "11a8ab60-4c25-44f2-819d-7dfb1ae78a61", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-11a8ab60-4c25-44f2-819d-7dfb1ae78a61" }, { "id": "aa3de4a7-d55b-458b-97ef-eb0ccde1c0f4", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-aa3de4a7-d55b-458b-97ef-eb0ccde1c0f4" }, { "id": "9d241cfd-17fb-49cf-b497-ade09cb114b6", "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/expenses/categories?employment_id=&expense_id=&include_parents=&country_code=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", "categories" ], "query": [ { "description": "The employment ID for which to list categories. Required if neither expense_id nor country_code is provided.", "key": "employment_id", "value": "" }, { "description": "The expense ID for which to list categories (includes the expense's category, even if it is not selectable by default). If provided without employment_id, will use the expense's employment context.", "key": "expense_id", "value": "" }, { "description": "Include un-selectable intermediate categories in the response", "key": "include_parents", "value": "" }, { "description": "Filter categories by country (ISO 3166-1 alpha-3 code, e.g. \"GBR\"). Only used when neither employment_id nor expense_id is provided.", "key": "country_code", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-9d241cfd-17fb-49cf-b497-ade09cb114b6" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e6ec8665-5dee-4689-be76-4c1c59c0cb84" } ], "id": "824d6642-db31-460c-a49f-c530f5bf1ba3", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-824d6642-db31-460c-a49f-c530f5bf1ba3" }, { "name": "{id}", "item": [ { "name": "Show expense", "id": "a2a29948-937b-4c6f-bd90-a7bf0bdf64e4", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":id" ], "variable": [ { "id": "042b414d-7b78-4bbb-8734-9a7d83595a56", "key": "id", "value": "", "description": "(Required) Expense ID" } ] }, "description": "Shows a single expense record\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "c3a9861c-f9f2-4cc9-9e22-cf87bcd8c73f", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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 \"expense\": {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"transport\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"approved\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c3a9861c-f9f2-4cc9-9e22-cf87bcd8c73f" }, { "id": "6d5a1efe-1ae1-4d83-98ae-4a6ec61afcde", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-6d5a1efe-1ae1-4d83-98ae-4a6ec61afcde" }, { "id": "4f3492e2-5f10-4c57-bb54-e61e219c4db9", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4f3492e2-5f10-4c57-bb54-e61e219c4db9" }, { "id": "696a5954-3ad7-49e4-9991-06f90cf98a65", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-696a5954-3ad7-49e4-9991-06f90cf98a65" }, { "id": "b3797502-40f0-4bf3-a1da-95a63b8899a0", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b3797502-40f0-4bf3-a1da-95a63b8899a0" }, { "id": "fb60c775-710b-452e-9ba9-59a1e75e258f", "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/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-fb60c775-710b-452e-9ba9-59a1e75e258f" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a2a29948-937b-4c6f-bd90-a7bf0bdf64e4" }, { "name": "Update an expense", "id": "933e502f-e115-4d73-8a44-e25de28e528f", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":id" ], "variable": [ { "id": "07e60be6-a0d3-49e6-a75a-6f81a2e4b407", "key": "id", "value": "", "description": "(Required) Expense ID" } ] }, "description": "Updates an expense\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "8e3169b0-5f5f-4150-ae01-658964a9307e", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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 \"expense\": {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"transport\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"approved\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8e3169b0-5f5f-4150-ae01-658964a9307e" }, { "id": "f568cc98-3589-45c0-b07d-3a009b34a144", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-f568cc98-3589-45c0-b07d-3a009b34a144" }, { "id": "8f46b5d0-4231-489b-a948-d3f309edf625", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8f46b5d0-4231-489b-a948-d3f309edf625" }, { "id": "b258e162-6da5-470c-9415-3108a64bb9ee", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b258e162-6da5-470c-9415-3108a64bb9ee" }, { "id": "4785420f-d934-42fb-824d-07f4bbb9d0d1", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4785420f-d934-42fb-824d-07f4bbb9d0d1" }, { "id": "8e595118-e920-4de1-bad5-0cbd3a4e90f4", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8e595118-e920-4de1-bad5-0cbd3a4e90f4" }, { "id": "ee761bd7-6f16-42e9-920d-8e3f1a08d6b3", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ee761bd7-6f16-42e9-920d-8e3f1a08d6b3" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-933e502f-e115-4d73-8a44-e25de28e528f" }, { "name": "Update an expense", "id": "c4a346f9-782d-41f4-822f-d950b8d34938", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":id" ], "variable": [ { "id": "135c978b-02f1-4337-b6aa-6fbcf51bdb5d", "key": "id", "value": "", "description": "(Required) Expense ID" } ] }, "description": "Updates an expense\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "2f3a543d-10ac-4d60-b0b4-b27b5145964b", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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 \"expense\": {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"transport\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"approved\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2f3a543d-10ac-4d60-b0b4-b27b5145964b" }, { "id": "79a3393f-c923-44ba-be65-9f780c267982", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-79a3393f-c923-44ba-be65-9f780c267982" }, { "id": "154cec40-504c-4e5c-8c4d-1651a6e0458e", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-154cec40-504c-4e5c-8c4d-1651a6e0458e" }, { "id": "dad6da7f-1bc0-4759-93dc-e2c6ea07b44f", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dad6da7f-1bc0-4759-93dc-e2c6ea07b44f" }, { "id": "543d3a4d-6bd7-409e-85fb-509411a5ebd1", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-543d3a4d-6bd7-409e-85fb-509411a5ebd1" }, { "id": "ede6a1b8-3917-4d59-88e9-1471b15ab9e5", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ede6a1b8-3917-4d59-88e9-1471b15ab9e5" }, { "id": "3dfceb68-f6b1-44b3-a6ab-3f29bc778759", "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 \"status\": \"approved\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses/:id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses", ":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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3dfceb68-f6b1-44b3-a6ab-3f29bc778759" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-c4a346f9-782d-41f4-822f-d950b8d34938" } ], "id": "fab65230-75ac-41c3-ade4-ddf61123cb3d", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-fab65230-75ac-41c3-ade4-ddf61123cb3d" }, { "name": "List expenses", "id": "fb10fd05-d648-4ef5-b34c-3f49b4a19c88", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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 expenses records\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | View expenses (`expense:read`) | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "d9ef4e4e-5130-4822-a5cc-bd871f3240a4", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"expenses\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"transport\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"approved\"\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"meals\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"canceled\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-d9ef4e4e-5130-4822-a5cc-bd871f3240a4" }, { "id": "bf7ce6c7-3320-4aff-bfe7-2899006a8db1", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bf7ce6c7-3320-4aff-bfe7-2899006a8db1" }, { "id": "efeaa422-a16e-41c6-90d2-09ae628ee2ba", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-efeaa422-a16e-41c6-90d2-09ae628ee2ba" }, { "id": "cc63070a-fbc3-48e7-af7c-d7f1f01da807", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-cc63070a-fbc3-48e7-af7c-d7f1f01da807" }, { "id": "ca849efc-41a5-4e21-8551-3f12e0344626", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ca849efc-41a5-4e21-8551-3f12e0344626" }, { "id": "ed67c127-029c-43d4-8bd9-1a98c332d2c6", "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/expenses?page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ], "query": [ { "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ed67c127-029c-43d4-8bd9-1a98c332d2c6" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-fb10fd05-d648-4ef5-b34c-3f49b4a19c88" }, { "name": "Create expense", "id": "606e8f81-2c99-4b29-bcb2-0aafe7eb3662", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] }, "description": "Creates an **approved** expense\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage expenses (`employment_payments`) | - | Manage expenses (`expense:write`) |\n" }, "response": [ { "id": "851fca2f-e521-4483-8e10-e9f1e11ec3ca", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"expense\": {\n \"id\": \"\",\n \"title\": \"\",\n \"employment_id\": \"\",\n \"amount\": \"\",\n \"converted_amount\": \"\",\n \"currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"converted_currency\": {\n \"code\": \"\",\n \"name\": \"\",\n \"symbol\": \"\"\n },\n \"expense_date\": \"\",\n \"tax_amount\": \"\",\n \"converted_tax_amount\": \"\",\n \"category\": \"transport\",\n \"expense_category\": {\n \"code\": \"\",\n \"slug\": \"\",\n \"title\": \"\"\n },\n \"invoice_period\": \"\",\n \"notes\": \"\",\n \"reason\": \"\",\n \"receipts\": [\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n },\n {\n \"id\": \"\",\n \"inserted_at\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"sub_type\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer\": {\n \"user_email\": \"\",\n \"user_id\": \"\",\n \"user_name\": \"\"\n },\n \"status\": \"approved\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-851fca2f-e521-4483-8e10-e9f1e11ec3ca" }, { "id": "35d5d8bd-b944-49dc-bcf5-afb10f573122", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-35d5d8bd-b944-49dc-bcf5-afb10f573122" }, { "id": "06c05525-307a-411e-9caf-ece691d5bbd9", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-06c05525-307a-411e-9caf-ece691d5bbd9" }, { "id": "505418be-fee0-41b8-a402-4c4a17e4449d", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-505418be-fee0-41b8-a402-4c4a17e4449d" }, { "id": "9e62159e-bcb7-4c9a-8f11-12581fbc48cd", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-9e62159e-bcb7-4c9a-8f11-12581fbc48cd" }, { "id": "ceecc2e0-118e-4d50-b9d7-35395cf6d615", "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 \"expense_date\": \"\",\n \"title\": \"\",\n \"amount\": \"\",\n \"currency\": \"\",\n \"employment_id\": \"\",\n \"category\": \"coworking_office\",\n \"expense_category_slug\": \"\",\n \"receipt\": {\n \"name\": \"\",\n \"content\": \"\"\n },\n \"receipts\": [\n {\n \"name\": \"\",\n \"content\": \"\"\n },\n {\n \"name\": \"\",\n \"content\": \"\"\n }\n ],\n \"reviewed_at\": \"\",\n \"reviewer_id\": \"\",\n \"tax_amount\": \"\",\n \"timezone\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/expenses", "host": [ "{{baseUrl}}" ], "path": [ "v1", "expenses" ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ceecc2e0-118e-4d50-b9d7-35395cf6d615" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-606e8f81-2c99-4b29-bcb2-0aafe7eb3662" } ], "id": "bdcf4dbd-640f-4dcb-91dc-b71ee31ba022", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bdcf4dbd-640f-4dcb-91dc-b71ee31ba022" }, { "name": "payroll-runs", "item": [ { "name": "{payroll_run_id}", "item": [ { "name": "gl-reports", "item": [ { "name": "{gl_report_id}", "item": [ { "name": "download", "item": [ { "name": "Download a GL report", "id": "fea85efd-6751-4530-aadc-5c2a2f791276", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id", "download" ], "variable": [ { "id": "22d5c980-4227-4058-987e-3db83a1ada61", "key": "payroll_run_id", "value": "", "description": "(Required) The payroll run's ID" }, { "id": "146ee0f3-b9cd-42b8-b53e-bb0a11f5060d", "key": "gl_report_id", "value": "", "description": "(Required) The GL report's ID" } ] }, "description": "Downloads the generated GL report as a CSV file. The report must have `status: completed` before calling this endpoint.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "e7f6345d-eac1-4f28-9e30-7d9c79ff6baf", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id", "download" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-e7f6345d-eac1-4f28-9e30-7d9c79ff6baf" }, { "id": "bec43949-7cfc-431c-ac83-d8a2f0a3cc8b", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id", "download" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bec43949-7cfc-431c-ac83-d8a2f0a3cc8b" }, { "id": "1bb7b837-98c2-4024-8676-c49c727eec55", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id/download", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id", "download" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-1bb7b837-98c2-4024-8676-c49c727eec55" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-fea85efd-6751-4530-aadc-5c2a2f791276" } ], "id": "2bd3562f-5420-46d8-8034-5cb94e6d3080", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2bd3562f-5420-46d8-8034-5cb94e6d3080" }, { "name": "Show a GL report", "id": "bc4f6d01-2636-435f-862a-1e3be5f1ce77", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id" ], "variable": [ { "id": "e259ff78-06ba-4346-aba7-9aec201fe04a", "key": "payroll_run_id", "value": "", "description": "(Required) The payroll run's ID" }, { "id": "32f150af-3568-4343-9ac8-21ee748117d4", "key": "gl_report_id", "value": "", "description": "(Required) The GL report's ID" } ] }, "description": "Returns the current status of a GL report. Poll until `status` is `completed`, then call `download`.\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "38a60382-a91a-408c-ad8d-51eec7ac37f8", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"gl_report\": {\n \"id\": \"\",\n \"type\": \"by_department\",\n \"status\": \"pending\",\n \"inserted_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-38a60382-a91a-408c-ad8d-51eec7ac37f8" }, { "id": "829716ea-bec9-4719-bd2c-6aa408647194", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-829716ea-bec9-4719-bd2c-6aa408647194" }, { "id": "032fb142-bd4d-4cf7-8c53-0c8458922a6d", "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/payroll-runs/:payroll_run_id/gl-reports/:gl_report_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports", ":gl_report_id" ], "variable": [ { "key": "payroll_run_id" }, { "key": "gl_report_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-032fb142-bd4d-4cf7-8c53-0c8458922a6d" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-bc4f6d01-2636-435f-862a-1e3be5f1ce77" } ], "id": "769e7492-cce8-483d-956d-dbabdf7dece1", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-769e7492-cce8-483d-956d-dbabdf7dece1" }, { "name": "Create a GL report", "id": "0230f6ec-cb29-4e0d-8858-50b34ad48fbf", "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\": \"by_department\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/payroll-runs/:payroll_run_id/gl-reports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports" ], "variable": [ { "id": "4a845b0d-9ae1-4e20-8817-4bf58f122f31", "key": "payroll_run_id", "value": "", "description": "(Required) The payroll run's ID" } ] }, "description": "Triggers generation of a General Ledger report for the given payroll run and type.\nReturns immediately with a `pending` report \u2014 poll `show` until `status` is `completed`,\nthen call `download`.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "787729f2-ffce-45e1-bcf0-68a35f052745", "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\": \"by_department\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/payroll-runs/:payroll_run_id/gl-reports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports" ], "variable": [ { "key": "payroll_run_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"gl_report\": {\n \"id\": \"\",\n \"type\": \"by_department\",\n \"status\": \"pending\",\n \"inserted_at\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-787729f2-ffce-45e1-bcf0-68a35f052745" }, { "id": "979fdd86-5441-4e0c-a312-83a09e3acb46", "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\": \"by_department\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/payroll-runs/:payroll_run_id/gl-reports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-979fdd86-5441-4e0c-a312-83a09e3acb46" }, { "id": "734a3250-a86e-4201-8e03-8dd860c8afa3", "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\": \"by_department\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/payroll-runs/:payroll_run_id/gl-reports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-734a3250-a86e-4201-8e03-8dd860c8afa3" }, { "id": "d170104b-0408-487a-af53-f6e4f55ccf56", "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\": \"by_department\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/payroll-runs/:payroll_run_id/gl-reports", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "gl-reports" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-d170104b-0408-487a-af53-f6e4f55ccf56" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0230f6ec-cb29-4e0d-8858-50b34ad48fbf" } ], "id": "736369ec-8aba-431c-a53e-8d079172aeb9", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-736369ec-8aba-431c-a53e-8d079172aeb9" }, { "name": "employee-details", "item": [ { "name": "Get Employee Details for a Payroll Run", "id": "ea2a98b8-ab99-408e-81ee-64a1917f9226", "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/payroll-runs/:payroll_run_id/employee-details?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "employee-details" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "0dc830c0-1710-49ed-8a94-6f4202be99a3", "key": "payroll_run_id", "value": "", "description": "(Required) Payroll run ID" } ] }, "description": "Gets the employee details for a payroll run\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "9c711ed5-b353-4550-84e2-007379793e0f", "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/payroll-runs/:payroll_run_id/employee-details?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "employee-details" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "payroll_run_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"employee_details\": [\n {\n \"full_name\": \"\",\n \"payslip_id\": \"\",\n \"total_cost\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"net_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"gross_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"deductions\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"base_salary\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"expenses\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"incentives\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"other\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"benefits\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employer_costs\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employment_id\": \"\"\n },\n {\n \"full_name\": \"\",\n \"payslip_id\": \"\",\n \"total_cost\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"net_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"gross_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"deductions\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"base_salary\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"expenses\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"incentives\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"other\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"benefits\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employer_costs\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employment_id\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-9c711ed5-b353-4550-84e2-007379793e0f" }, { "id": "0b651e5e-4c19-4347-b62a-ae09061337a3", "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/payroll-runs/:payroll_run_id/employee-details?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "employee-details" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0b651e5e-4c19-4347-b62a-ae09061337a3" }, { "id": "ca82c40e-9e34-468b-a1b9-6d6950727b22", "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/payroll-runs/:payroll_run_id/employee-details?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "employee-details" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ca82c40e-9e34-468b-a1b9-6d6950727b22" }, { "id": "33ab1012-ff9b-4c57-82cc-5e70309b7c6c", "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/payroll-runs/:payroll_run_id/employee-details?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id", "employee-details" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-33ab1012-ff9b-4c57-82cc-5e70309b7c6c" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ea2a98b8-ab99-408e-81ee-64a1917f9226" } ], "id": "a80b1ba5-2ee2-458f-a27b-206218ff58d2", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a80b1ba5-2ee2-458f-a27b-206218ff58d2" }, { "name": "Show Company Payroll Runs", "id": "a44ffe91-e190-4ba8-aad7-bf782d3b79af", "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/payroll-runs/:payroll_run_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id" ], "variable": [ { "id": "9d8c3690-ae5c-4079-8456-adb5402c04a2", "key": "payroll_run_id", "value": "", "description": "(Required) Payroll run ID" } ] }, "description": "Given an ID, shows a payroll run.\n`employee_details` field is deprecated in favour of the `employee_details` endpoint and will be removed in the future.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "15505137-416a-4ff1-9aa7-69f8707a8662", "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/payroll-runs/:payroll_run_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id" ], "variable": [ { "key": "payroll_run_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payroll_run\": {\n \"id\": \"\",\n \"status\": \"processing\",\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"approval_date\": \"\",\n \"expected_payout_date\": \"\",\n \"currency_code\": \"\",\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"standard\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"total_payroll_cost\": \"\",\n \"salary_total\": \"\",\n \"benefits_total\": \"\",\n \"incentives_total\": \"\",\n \"expenses_total\": \"\",\n \"other_total\": \"\",\n \"employer_contributions_total\": \"\",\n \"employee_details\": [\n {\n \"full_name\": \"\",\n \"payslip_id\": \"\",\n \"total_cost\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"net_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"gross_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"deductions\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"base_salary\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"expenses\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"incentives\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"other\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"benefits\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employer_costs\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employment_id\": \"\"\n },\n {\n \"full_name\": \"\",\n \"payslip_id\": \"\",\n \"total_cost\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"net_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"gross_pay\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"deductions\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"base_salary\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"expenses\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"incentives\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"other\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"benefits\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employer_costs\": {\n \"amount\": \"\",\n \"currency\": \"\"\n },\n \"employment_id\": \"\"\n }\n ],\n \"cutoff_date\": \"\",\n \"type\": \"expenses\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-15505137-416a-4ff1-9aa7-69f8707a8662" }, { "id": "36bc07bc-1afd-48f1-8a41-980a355a1e50", "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/payroll-runs/:payroll_run_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-36bc07bc-1afd-48f1-8a41-980a355a1e50" }, { "id": "cc3cf50f-50b7-47a5-a0d4-ff5cb3db92dd", "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/payroll-runs/:payroll_run_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-cc3cf50f-50b7-47a5-a0d4-ff5cb3db92dd" }, { "id": "b15431db-3a36-4311-a6c4-fe6508064fb8", "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/payroll-runs/:payroll_run_id", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs", ":payroll_run_id" ], "variable": [ { "key": "payroll_run_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b15431db-3a36-4311-a6c4-fe6508064fb8" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-a44ffe91-e190-4ba8-aad7-bf782d3b79af" } ], "id": "af7501f1-e6ae-4e9f-8d2e-e95dcb3ec389", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-af7501f1-e6ae-4e9f-8d2e-e95dcb3ec389" }, { "name": "List Company Payroll Runs", "id": "01cd1459-5701-41cd-9b6b-c617d22451cf", "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/payroll-runs?payroll_period=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs" ], "query": [ { "description": "Filters payroll runs where period_start or period_end match the given date", "key": "payroll_period", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] }, "description": "Lists all payroll runs for a company\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View payroll runs (`payroll_run:read`) | - |\n" }, "response": [ { "id": "70543ab2-adb2-45a4-9970-a6be4eefd6ee", "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/payroll-runs?payroll_period=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs" ], "query": [ { "description": "Filters payroll runs where period_start or period_end match the given date", "key": "payroll_period", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"payroll_runs\": [\n {\n \"id\": \"\",\n \"status\": \"waiting_for_customer_approval\",\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"approval_date\": \"\",\n \"expected_payout_date\": \"\",\n \"currency_code\": \"\",\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"cor\",\n \"standard\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"total_payroll_cost\": \"\",\n \"type\": \"parallel\",\n \"cutoff_date\": \"\"\n },\n {\n \"id\": \"\",\n \"status\": \"waiting_for_customer_approval\",\n \"period_start\": \"\",\n \"period_end\": \"\",\n \"approval_date\": \"\",\n \"expected_payout_date\": \"\",\n \"currency_code\": \"\",\n \"country\": {\n \"alpha_2_code\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"contractor_products_available\": [\n \"plus\",\n \"cor\"\n ],\n \"country_subdivisions\": [\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n },\n {\n \"name\": \"\",\n \"code\": \"\",\n \"subdivision_type\": \"\"\n }\n ],\n \"employment_agreement_preview_available\": \"\",\n \"eor_onboarding\": \"\",\n \"locked_benefits\": \"\",\n \"region\": \"\",\n \"subregion\": \"\",\n \"supported_json_schemas\": [\n \"\",\n \"\"\n ]\n },\n \"total_payroll_cost\": \"\",\n \"type\": \"pro_forma\",\n \"cutoff_date\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-70543ab2-adb2-45a4-9970-a6be4eefd6ee" }, { "id": "0a8a9cd7-7248-416b-bab4-de08a716eb88", "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/payroll-runs?payroll_period=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs" ], "query": [ { "description": "Filters payroll runs where period_start or period_end match the given date", "key": "payroll_period", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0a8a9cd7-7248-416b-bab4-de08a716eb88" }, { "id": "57e7822d-3729-4757-9df9-caaa01861f0a", "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/payroll-runs?payroll_period=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs" ], "query": [ { "description": "Filters payroll runs where period_start or period_end match the given date", "key": "payroll_period", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-57e7822d-3729-4757-9df9-caaa01861f0a" }, { "id": "548a2be1-5ae0-4678-b960-5f7c5417efe7", "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/payroll-runs?payroll_period=&page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payroll-runs" ], "query": [ { "description": "Filters payroll runs where period_start or period_end match the given date", "key": "payroll_period", "value": "" }, { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-548a2be1-5ae0-4678-b960-5f7c5417efe7" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-01cd1459-5701-41cd-9b6b-c617d22451cf" } ], "id": "ac17374c-57aa-4e14-91f2-faa493d5ddc7", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ac17374c-57aa-4e14-91f2-faa493d5ddc7" }, { "name": "companies", "item": [ { "name": "{company_id}", "item": [ { "name": "legal-entities", "item": [ { "name": "{legal_entity_id}", "item": [ { "name": "pay-codes", "item": [ { "name": "List Pay Codes", "id": "eae910fd-71b8-4d41-96a5-5f9676935d29", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "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": "redirect_uri", "value": "/auth/oauth2/token", "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" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/companies/:company_id/legal-entities/:legal_entity_id/pay-codes?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "pay-codes" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "id": "a8c58b08-5429-41f1-ad0d-350c8b171ccc", "key": "company_id", "value": "", "description": "(Required) Company ID" }, { "id": "a63515a9-9efe-4c27-8922-6777eb15298e", "key": "legal_entity_id", "value": "", "description": "(Required) Legal entity ID" } ] }, "description": "Lists pay codes available for a legal entity.\nPay codes represent the allowed pay element types that can be submitted via `POST /v1/pay-items/bulk`.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage payroll runs (`payroll`) | View pay items (`pay_item:read`) | Manage pay items (`pay_item:write`) |\n" }, "response": [ { "id": "2dfad646-49d8-4881-b964-cb4fa843f1c6", "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/companies/:company_id/legal-entities/:legal_entity_id/pay-codes?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "pay-codes" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"data\": {\n \"current_page\": \"\",\n \"pay_codes\": [\n {\n \"slug\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"external_import_code\": \"\"\n },\n {\n \"slug\": \"\",\n \"code\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"description\": \"\",\n \"external_import_code\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-2dfad646-49d8-4881-b964-cb4fa843f1c6" }, { "id": "92716dc0-9900-4204-9954-4f9c06678204", "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/companies/:company_id/legal-entities/:legal_entity_id/pay-codes?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "pay-codes" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-92716dc0-9900-4204-9954-4f9c06678204" }, { "id": "dae5e17b-2e46-4485-a645-e0f7fa7bca52", "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/companies/:company_id/legal-entities/:legal_entity_id/pay-codes?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "pay-codes" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_id" } ] } }, "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-dae5e17b-2e46-4485-a645-e0f7fa7bca52" }, { "id": "ddf827ea-7495-4ffa-ba5b-6cd92fb022dc", "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/companies/:company_id/legal-entities/:legal_entity_id/pay-codes?page=1&page_size=20", "host": [ "{{baseUrl}}" ], "path": [ "v1", "companies", ":company_id", "legal-entities", ":legal_entity_id", "pay-codes" ], "query": [ { "description": "Starts fetching records after the given page", "key": "page", "value": "1" }, { "description": "Number of items per page", "key": "page_size", "value": "20" } ], "variable": [ { "key": "company_id" }, { "key": "legal_entity_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ddf827ea-7495-4ffa-ba5b-6cd92fb022dc" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-eae910fd-71b8-4d41-96a5-5f9676935d29" } ], "id": "abcb4d92-341e-46b1-b8cb-14b706383c68", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-abcb4d92-341e-46b1-b8cb-14b706383c68" } ], "id": "962a3fc5-7f7d-4b2e-8058-26475f05da48", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-962a3fc5-7f7d-4b2e-8058-26475f05da48" } ], "id": "f736e987-acfc-4286-b800-5fb75dd7bf81", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-f736e987-acfc-4286-b800-5fb75dd7bf81" } ], "id": "63f69446-fe19-4e2c-bec0-331401918717", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-63f69446-fe19-4e2c-bec0-331401918717" } ], "id": "edaba5c3-78c1-42c9-9fc2-960244564c11", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-edaba5c3-78c1-42c9-9fc2-960244564c11" }, { "name": "payslips", "item": [ { "name": "{payslip_id}", "item": [ { "name": "pdf", "item": [ { "name": "Download payslip in the PDF format", "id": "91a5bc35-acff-40bc-a1c9-c7a40805e6f4", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "id": "6522daee-13c4-48d7-9c7f-dc7ccc5ef284", "key": "payslip_id", "value": "", "description": "(Required) Payslip ID" } ] }, "description": "Given a Payslip ID, downloads a payslip.\nIt is important to note that each country has a different payslip format and they are not authored by Remote.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - |\n" }, "response": [ { "id": "b008410c-c044-49f7-990e-7760830d59ef", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b008410c-c044-49f7-990e-7760830d59ef" }, { "id": "245180b9-45ea-48c6-9a5b-17996bac6c12", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-245180b9-45ea-48c6-9a5b-17996bac6c12" }, { "id": "99b3e10d-27db-4e4e-8683-bc00eb8a83b3", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-99b3e10d-27db-4e4e-8683-bc00eb8a83b3" }, { "id": "4b403e7e-0280-4794-8d0c-a597d8b1c0b4", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-4b403e7e-0280-4794-8d0c-a597d8b1c0b4" }, { "id": "acdcce3a-d24f-40fc-b33d-1fd62e5f51a3", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-acdcce3a-d24f-40fc-b33d-1fd62e5f51a3" }, { "id": "0e64ed65-8751-4109-ab9f-b37e87924215", "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/payslips/:payslip_id/pdf", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips", ":payslip_id", "pdf" ], "variable": [ { "key": "payslip_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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-0e64ed65-8751-4109-ab9f-b37e87924215" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-91a5bc35-acff-40bc-a1c9-c7a40805e6f4" } ], "id": "13d01a18-6b79-4a7b-8ec3-c80cfba86031", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-13d01a18-6b79-4a7b-8ec3-c80cfba86031" } ], "id": "be4ed233-502a-4a95-80f1-b56e07f5fbd6", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-be4ed233-502a-4a95-80f1-b56e07f5fbd6" }, { "name": "List payslips", "id": "aac3676c-5d23-4717-83b4-1bce28f016a7", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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 payslips belonging to a company. Can also filter for a single employment belonging\nto that company.\n\n\n## Scopes\n\n| Category | Read only Scope | Write only Scope (read access implicit) |\n|---|---|---|\n| Manage employment documents (`employment_documents`) | View payslips (`payslip:read`) | - |\n" }, "response": [ { "id": "b340737d-91a1-4843-92d3-52f6c6db66d5", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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 \"payslips\": [\n {\n \"id\": \"\",\n \"issued_at\": \"\",\n \"employment_id\": \"\",\n \"expected_payout_date\": \"\",\n \"net_pay_converted_amount\": \"\",\n \"net_pay_source_amount\": \"\"\n },\n {\n \"id\": \"\",\n \"issued_at\": \"\",\n \"employment_id\": \"\",\n \"expected_payout_date\": \"\",\n \"net_pay_converted_amount\": \"\",\n \"net_pay_source_amount\": \"\"\n }\n ],\n \"total_count\": \"\",\n \"total_pages\": \"\"\n }\n}", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-b340737d-91a1-4843-92d3-52f6c6db66d5" }, { "id": "acbb0b85-f1fd-49a9-897e-2c3403ac2766", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-acbb0b85-f1fd-49a9-897e-2c3403ac2766" }, { "id": "ebea3024-fc38-4fd2-b976-15f210961600", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ebea3024-fc38-4fd2-b976-15f210961600" }, { "id": "8253f009-38a4-4868-8767-c85e43bfeac5", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-8253f009-38a4-4868-8767-c85e43bfeac5" }, { "id": "3adb2c3e-6773-40d0-aafc-bf25216fb90a", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-3adb2c3e-6773-40d0-aafc-bf25216fb90a" }, { "id": "7f81c358-a348-42ef-b2bd-1ad8ff73af0e", "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/payslips?employment_id=&start_date=&end_date=&expected_payout_start_date=&expected_payout_end_date=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "payslips" ], "query": [ { "description": "Employment ID", "key": "employment_id", "value": "" }, { "description": "Filters by payslips `issued_at` field, after or on the same day than the given date", "key": "start_date", "value": "" }, { "description": "Filters by payslips `issued_at` field, before or or the same day than the given date", "key": "end_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, after or on the same day than the given date", "key": "expected_payout_start_date", "value": "" }, { "description": "Filters by payslips `expected_payout_date` field, before or or the same day than the given date", "key": "expected_payout_end_date", "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:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-7f81c358-a348-42ef-b2bd-1ad8ff73af0e" } ], "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-aac3676c-5d23-4717-83b4-1bce28f016a7" } ], "id": "77114361-a283-462d-8214-dabef18fc72a", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-77114361-a283-462d-8214-dabef18fc72a" } ], "id": "ff83d9e5-bc64-42b3-ab21-be3a5fabbd36", "createdAt": "2026-07-28T02:47:00.000Z", "updatedAt": "2026-07-28T02:47:00.000Z", "uid": "35240-ff83d9e5-bc64-42b3-ab21-be3a5fabbd36" } ], "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/" } ] }