{"info":{"_postman_id":"7c3616f6-d6e8-4d00-8942-c996cde6287b","name":"quickclaim API documentation","description":"

In this workspace you can find quickclaim API documentation on this page. #ndis-native-api and #enhanced-api and #public-api are documented under different collections.

\n

👋 Introduction

\n

Welcome to the quickclaim API development workspace. This workspace serves as a single source of truth for the NDIS APIs and Public APIs we build and helps new engineers get onboarded to our team's API landscape faster.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"30270969","collectionId":"7c3616f6-d6e8-4d00-8942-c996cde6287b","publishedId":"2sA3kPoiuw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-07-15T00:58:10.000Z"},"item":[{"name":"Public APIs","item":[{"name":"serviceBooking","item":[{"name":"/serviceBooking","id":"2f908dfc-4fb9-4992-99d3-8af2251e05d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/serviceBooking?ndisNumber=&participantName=&supportCategory=&serviceBookingNumber=&sbFrom=&sbTo=&supportItem=&page=1","description":"

This endpoint retrieves all service bookings from the quickclaim database, NOT from NDIS, and it is applicable to all participants. By using this endpoint, you can query service booking data using various parameters.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["serviceBooking"],"host":["https://api.quickclaim.io/public"],"query":[{"description":{"content":"

Filter result by the NDIS participant ID (maxLength: 10)

\n","type":"text/plain"},"key":"ndisNumber","value":""},{"description":{"content":"

Filter result by the participant name. This is a CONTAIN switch, allowing you to filter results using a partial name.

\n","type":"text/plain"},"key":"participantName","value":""},{"description":{"content":"

Filter result by the support category

\n","type":"text/plain"},"key":"supportCategory","value":""},{"description":{"content":"

Filter result by the service booking number. This is a CONTAIN switch, allowing you to filter results using a portion of the service booking number

\n","type":"text/plain"},"key":"serviceBookingNumber","value":""},{"description":{"content":"

Service Booking From, to filter data for service bookings that are on or after the specified date.

\n","type":"text/plain"},"key":"sbFrom","value":""},{"description":{"content":"

Service Booking To, to filter data for service bookings that are on or before the specified date.

\n","type":"text/plain"},"key":"sbTo","value":""},{"description":{"content":"

Filter result by the support item.

\n","type":"text/plain"},"key":"supportItem","value":""},{"description":{"content":"

Each page will display 1000 rows, and you can navigate to subsequent pages using this parameter.

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"10aea991-94f5-43d4-8d19-53cc97d14434","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/serviceBooking?ndisNumber=&participantName=&supportCategory=&serviceBookingNumber=&sbFrom=&sbTo=&supportItem=&page=1","host":["https://api.quickclaim.io/public"],"path":["serviceBooking"],"query":[{"description":"Filter result by the NDIS participant ID (maxLength: 10)","key":"ndisNumber","value":""},{"description":"Filter result by the participant name. This is a CONTAIN switch, allowing you to filter results using a partial name.","key":"participantName","value":""},{"description":"Filter result by the support category","key":"supportCategory","value":""},{"description":"Filter result by the service booking number. This is a CONTAIN switch, allowing you to filter results using a portion of the service booking number","key":"serviceBookingNumber","value":""},{"description":"Service Booking From, to filter data for service bookings that are on or after the specified date.","key":"sbFrom","value":""},{"description":"Service Booking To, to filter data for service bookings that are on or before the specified date.","key":"sbTo","value":""},{"description":"Filter result by the support item.","key":"supportItem","value":""},{"description":"Each page will display 1000 rows, and you can navigate to subsequent pages using this parameter.","key":"page","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"currentPageNo\": \"\",\n \"currentPageRecordNo\": \"\",\n \"data\": [\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"refresh\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\"\n },\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"refresh\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\"\n }\n ],\n \"numberOfPages\": \"\",\n \"totalLength\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"2f908dfc-4fb9-4992-99d3-8af2251e05d2"},{"name":"/serviceBooking/{id}","id":"2565b7b0-1652-4c64-906e-dec55fa43f98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/serviceBooking/:id","description":"

This endpoint returns a service booking from quickcalim database and won't refresh data from NDIS. The id in this call is the id of service booking in quickclaim database.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["serviceBooking",":id"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"7d74b1df-7990-45c5-9383-14a2b957bc23","description":{"content":"

(Required) Service booking id

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"293b52c4-ccdc-42f0-b47f-5f35dc84c9c8","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/serviceBooking/:id","host":["https://api.quickclaim.io/public"],"path":["serviceBooking",":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 {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"refresh\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\"\n },\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"refresh\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\"\n }\n ],\n \"version\": \"\"\n}"}],"_postman_id":"2565b7b0-1652-4c64-906e-dec55fa43f98"},{"name":"/serviceBookingByNdisNumber/{ndisNumber}","id":"f7647577-a244-4800-85bc-6a1cae46e68a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/serviceBookingByNdisNumber/:ndisNumber","description":"

This endpoint calls NDIS for the given NDIS number and returns all service bookings of that participant. It also updates quickclaim database.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["serviceBookingByNdisNumber",":ndisNumber"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"15d72f96-d5cd-4936-b317-15496878d348","description":{"content":"

(Required) NDIS participant ID (maxLength: 10)

\n","type":"text/plain"},"type":"any","value":"","key":"ndisNumber"}]}},"response":[{"id":"87fac2ea-cff4-4cdd-86a9-40a2d4cc9e5f","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/serviceBookingByNdisNumber/:ndisNumber","host":["https://api.quickclaim.io/public"],"path":["serviceBookingByNdisNumber",":ndisNumber"],"variable":[{"key":"ndisNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"regoId\": \"\",\n \"ndisRego\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"ndisNumber\": \"\",\n \"planNumber\": \"\",\n \"bookingType\": \"\",\n \"virtualStatus\": \"\",\n \"status\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"note\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportCategory\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amount\": \"\",\n \"remaining\": \"\",\n \"isUsed\": \"\",\n \"daysLeft\": \"\",\n \"isOld\": \"\",\n \"createDate\": \"\",\n \"modifyDate\": \"\",\n \"modifyBy\": \"\",\n \"ndisRefreshDate\": \"\",\n \"isDeleted\": \"\",\n \"isCancelled\": \"\",\n \"clientNumber\": \"\",\n \"refresh\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\"\n },\n {\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"regoId\": \"\",\n \"ndisRego\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"ndisNumber\": \"\",\n \"planNumber\": \"\",\n \"bookingType\": \"\",\n \"virtualStatus\": \"\",\n \"status\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"note\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportCategory\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amount\": \"\",\n \"remaining\": \"\",\n \"isUsed\": \"\",\n \"daysLeft\": \"\",\n \"isOld\": \"\",\n \"createDate\": \"\",\n \"modifyDate\": \"\",\n \"modifyBy\": \"\",\n \"ndisRefreshDate\": \"\",\n \"isDeleted\": \"\",\n \"isCancelled\": \"\",\n \"clientNumber\": \"\",\n \"refresh\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\"\n }\n ],\n \"version\": \"\"\n}"}],"_postman_id":"f7647577-a244-4800-85bc-6a1cae46e68a"},{"name":"/refreshAServiceBooking/{serviceBookingId}","id":"4bf896a9-2ddb-4984-8be9-8d613d5c6cb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","description":"

This endpoint calls NDIS with the provided service booking id, updates the quickclaim database, and returns the updated result. It should be used when you require real-time data from NDIS.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["refreshAServiceBooking",":serviceBookingId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"6c694bf4-6843-4cbf-b648-319a3e7c8cd9","type":"any","key":"serviceBookingId"}]}},"response":[{"id":"9946da02-15bc-4278-b6af-4ddf5745de59","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["refreshAServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\",\n \"virtualStatus\": \"\"\n },\n \"version\": \"\"\n}"},{"id":"5fc4e41a-c365-4cf5-8aef-3f51a6b4e8a7","name":"400 response","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["refreshAServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"message\": \"\"\n}"},{"id":"e44d55da-e9d0-4fa9-b6f1-ada9ff755542","name":"403 response","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["refreshAServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"message\": \"\"\n}"},{"id":"2e82e0c0-d106-4f9b-93ad-e4d623a198f3","name":"404 response","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["refreshAServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"message\": \"\"\n}"},{"id":"af35ea3e-7a2a-4f51-b4d2-a3c473878d8f","name":"500 response","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshAServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["refreshAServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"4bf896a9-2ddb-4984-8be9-8d613d5c6cb8"},{"name":"/serviceBooking","id":"8ab33180-e7bc-415e-a0d3-be16210502e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bookingType\": \"\",\n \"categoryCode\": \"\",\n \"endDate\": \"\",\n \"ndisNumber\": \"\",\n \"rate\": \"\",\n \"quantity\": \"\",\n \"ndisRego\": \"\",\n \"startDate\": \"\",\n \"note\": \"\",\n \"supportItem\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/serviceBooking","description":"

This endpoint creates a service booking on NDIS. Before using this API you need to make sure the participant is added to quickclaim database.\nTo simplify the process for each service booking you can only add one line of support. Support can be booked either at the Category or Item level. If adding the service booking at the Category level you should add categoryCode, but no need to add the supportItem field. However, for service bookings at the Support level, you must add both categoryCode and supportItem fields.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["serviceBooking"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"29787594-f9d2-4eb1-9182-efa28517765a","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"bookingType\": \"\",\n \"categoryCode\": \"\",\n \"endDate\": \"\",\n \"ndisNumber\": \"\",\n \"rate\": \"\",\n \"quantity\": \"\",\n \"ndisRego\": \"\",\n \"startDate\": \"\",\n \"note\": \"\",\n \"supportItem\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/serviceBooking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": {\n \"serviceBookingNumber\": \"\"\n }\n}"}],"_postman_id":"8ab33180-e7bc-415e-a0d3-be16210502e6"},{"name":"/serviceBookingByParticipantId","id":"86cfbf97-ceb5-49b5-8950-a792524614ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bookingType\": \"\",\n \"categoryCode\": \"\",\n \"endDate\": \"\",\n \"participantId\": \"\",\n \"rate\": \"\",\n \"quantity\": \"\",\n \"regoId\": \"\",\n \"startDate\": \"\",\n \"note\": \"\",\n \"supportItem\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/serviceBookingByParticipantId","description":"

This endpoint creates a service booking on NDIS using quickclaim participant id. Before using this API you need to make sure the participant is added to quickclaim database.\nTo simplify the process for each service booking you can only add one line of support. Support can be booked either at the Category or Item level. If adding the service booking at the Category level you should add categoryCode, but no need to add the supportItem field. However, for service bookings at the Support level, you must add both categoryCode and supportItem fields.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["serviceBookingByParticipantId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"d73e9b39-911d-4802-8983-5a0b4fc5e7cd","name":"200 response","originalRequest":{"method":"POST","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"bookingType\": \"\",\n \"categoryCode\": \"\",\n \"endDate\": \"\",\n \"participantId\": \"\",\n \"rate\": \"\",\n \"quantity\": \"\",\n \"regoId\": \"\",\n \"startDate\": \"\",\n \"note\": \"\",\n \"supportItem\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/serviceBookingByParticipantId"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": {\n \"serviceBookingNumber\": \"\"\n }\n}"}],"_postman_id":"86cfbf97-ceb5-49b5-8950-a792524614ec"},{"name":"/updateServiceBooking","id":"deb0889a-f22e-4538-8902-dd7d6cd53fd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": \"\",\n \"rate\": \"\",\n \"serviceBookingId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/updateServiceBooking","description":"

This endpoint allows you to update the allocation of a service booking. It takes the serviceBookingId, rate, and quantity (unit) in the request body, and subsequently updates the service booking on NDIS.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["updateServiceBooking"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"71b8461c-2f58-4c0e-a850-e92ce42acb2f","name":"Item created","originalRequest":{"method":"POST","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"quantity\": \"\",\n \"rate\": \"\",\n \"serviceBookingId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/updateServiceBooking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\",\n \"virtualStatus\": \"\"\n },\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\",\n \"virtualStatus\": \"\"\n }\n ],\n \"message\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"deb0889a-f22e-4538-8902-dd7d6cd53fd7"},{"name":"/extendServiceBooking","id":"38b8156b-0ce4-450d-8e20-3ff338464843","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"endDate\": \"\",\n \"serviceBookingId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/extendServiceBooking","description":"

This endpoint extends the end date of a service booking by updating it on NDIS. It requires the quickclaim service booking id and the new end date.\nPlease note that, while you are able to extend the end date of an inactive Service Booking that is scheduled in the future, you cannot make changes to the end date of an inactive Service Booking whose end date has already passed.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["extendServiceBooking"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"15a77e35-89ab-493e-afaa-454da9a85ebf","name":"Item created","originalRequest":{"method":"POST","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"endDate\": \"\",\n \"serviceBookingId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/extendServiceBooking"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"version\": \"\"\n}"},{"id":"dc6ebf59-5c2c-48db-bc0f-ccbc37c268b3","name":"Bad request","originalRequest":{"method":"POST","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"{\n \"endDate\": \"\",\n \"serviceBookingId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/extendServiceBooking"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"38b8156b-0ce4-450d-8e20-3ff338464843"},{"name":"/cancelServiceBooking/{serviceBookingId}","id":"93d54188-a2f3-4bf6-98a6-473dad2e8e96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/cancelServiceBooking/:serviceBookingId","description":"

This endpoint is to cancel/delete a ServiceBooking and release the unused funds. It gets serviceBookingId as path parameter. If the ServiceBooking has never been used, it gets DELETED. All the remaining funds will be released. If it has been used before and the endDate is in future, it gets CANCELLED. All the remaining funds will be released. Then the endDate is changed to today's date. The CANCELLED ServiceBookings are NOT editable anymore.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["cancelServiceBooking",":serviceBookingId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"2898c2c8-c759-4ffc-b914-bca52b31b47e","description":{"content":"

(Required) Service booking id. ex: SBH-119

\n","type":"text/plain"},"type":"any","value":"","key":"serviceBookingId"}]}},"response":[{"id":"960f0efc-e914-44e3-b294-f94dd9f3e93d","name":"Item deleted","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/cancelServiceBooking/:serviceBookingId","host":["https://api.quickclaim.io/public"],"path":["cancelServiceBooking",":serviceBookingId"],"variable":[{"key":"serviceBookingId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"93d54188-a2f3-4bf6-98a6-473dad2e8e96"}],"id":"5055970e-956d-4160-b44f-fdd0d40ec903","description":"

This collection includes all the APIs required for reading and writing to the service booking object. To expedite the process, quickclaim may store data in an internal database. Additionally, we've implemented a behind-the-scenes slow refresh process, ensuring that the QuickClaim database is continually updated from NDIS. It's worth noting that some of these endpoints return data from the QuickClaim database, while others retrieve real-time data directly from NDIS.

\n","_postman_id":"5055970e-956d-4160-b44f-fdd0d40ec903","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"participant","item":[{"name":"/participant","id":"769a9e8c-fef1-4ea9-9ce5-b4e34a0694f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"","description":"

(Required) 1234

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/participant?ndisNumber=&clientNumber=&participantName=&page=","description":"

This endpoint returns a paginated list of Participants from quickclaim database. You can query the Participant list by using the optional filters as query parameters. You can also navigate through pages of your call by passing page value that starts from 1. Note that the maximum number of participants returned in each page is 1000 items and you have to increment the page parameter value in order to get all of your participants.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["participant"],"host":["https://api.quickclaim.io/public"],"query":[{"description":{"content":"

430000000

\n","type":"text/plain"},"key":"ndisNumber","value":""},{"description":{"content":"

1234

\n","type":"text/plain"},"key":"clientNumber","value":""},{"description":{"content":"

Phoebe

\n","type":"text/plain"},"key":"participantName","value":""},{"description":{"content":"

1

\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"99a34dd0-3281-4c5a-a8cb-f1f53a8a0130","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 1234"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://api.quickclaim.io/public/participant?ndisNumber=&clientNumber=&participantName=&page=","host":["https://api.quickclaim.io/public"],"path":["participant"],"query":[{"key":"ndisNumber","value":"","description":"430000000"},{"key":"clientNumber","value":"","description":"1234"},{"key":"participantName","value":"","description":"Phoebe"},{"key":"page","value":"","description":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"clientNumber\": \"\",\n \"createDate\": \"\",\n \"defaultLocationId\": \"\",\n \"defaultLocationName\": \"\",\n \"dob\": \"\",\n \"financialContactCompany\": \"\",\n \"financialContactId\": \"\",\n \"firstName\": \"\",\n \"isActive\": \"\",\n \"isPace\": \"\",\n \"paceEnrolmentDate\": \"\",\n \"isDeleted\": \"\",\n \"isValidated\": \"\",\n \"lastName\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRego\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"regoId\": \"\"\n },\n {\n \"clientNumber\": \"\",\n \"createDate\": \"\",\n \"defaultLocationId\": \"\",\n \"defaultLocationName\": \"\",\n \"dob\": \"\",\n \"financialContactCompany\": \"\",\n \"financialContactId\": \"\",\n \"firstName\": \"\",\n \"isActive\": \"\",\n \"isPace\": \"\",\n \"paceEnrolmentDate\": \"\",\n \"isDeleted\": \"\",\n \"isValidated\": \"\",\n \"lastName\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRego\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"regoId\": \"\"\n }\n ],\n \"numberOfRecords\": \"\",\n \"numberOfPages\": \"\",\n \"currentPageNo\": \"\",\n \"currentPageRecordNo\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"769a9e8c-fef1-4ea9-9ce5-b4e34a0694f4"},{"name":"/participant","id":"e3e45f9f-af68-4f2f-a3c8-d7e79bf9e5f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"","description":"

(Required) 123

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ndisNumber\": \"\",\n \"regoId\": \"\",\n \"clientNumber\": \"\",\n \"dob\": \"\",\n \"financialContactId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"isActive\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/participant","description":"

This endpoint INSERT or UPDATE a Participant to the quickclaim database. ndisNumber is the ID of the participant, if this ID exists in the database the record gets updated. Otherwise, the record is added to the database.

\n

The field isActive must be a string with a value of either \"0\" or \"1\".

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["participant"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"7ef6c7c4-f61c-46fc-aca2-4021b0540531","name":"Item created","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ndisNumber\": \"\",\n \"regoId\": \"\",\n \"clientNumber\": \"\",\n \"dob\": \"\",\n \"financialContactId\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"locationId\": \"\",\n \"isActive\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/participant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"e3e45f9f-af68-4f2f-a3c8-d7e79bf9e5f0"},{"name":"/paceParticipantPlans","id":"9ceb4039-10a9-4913-ae8d-303dd7c4c319","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) Your organization ID as part of your credentials.

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/paceParticipantPlans","description":"

This endpoint retrieves all the plans for pace participants from the quickclaim database.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["paceParticipantPlans"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"e4cfbaa3-2bf6-4144-a1e8-ff1c0448a61f","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) Your organization ID as part of your credentials.","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":"https://api.quickclaim.io/public/paceParticipantPlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Nov 2023 04:33:05 GMT","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"470","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": [\n {\n \"participantId\": 82,\n \"ndisNumber\": \"517746990\",\n \"orgId\": 19,\n \"firstName\": \"Monica\",\n \"lastName\": \"becattini\",\n \"startDate\": \"2023-06-27T00:00:00.000Z\",\n \"endDate\": \"2026-06-27T00:00:00.000Z\",\n \"isPace\": 1,\n \"revisedEndDate\": null,\n \"isProviderConnected\": \"YES\"\n }\n ]\n}"}],"_postman_id":"9ceb4039-10a9-4913-ae8d-303dd7c4c319"},{"name":"/refreshParticipantServiceBooking/{participantId}","id":"94032184-b9e6-42b7-b080-f49c0a6ae3ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":false},"method":"GET","header":[{"description":"

(Required) 1234

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/refreshParticipantServiceBooking/:participantId","description":"

This endpoint calls NDIS and gets all ServiceBookings of the given participantId.

\n","urlObject":{"path":["refreshParticipantServiceBooking",":participantId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"1e7019f3-b7c5-4edf-ac54-9b709d7b848a","type":"any","key":"participantId"}]}},"response":[{"id":"c1f0e895-3e60-43e7-9709-2aa8428f4e09","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) 1234","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/refreshParticipantServiceBooking/:participantId","host":["https://api.quickclaim.io/public"],"path":["refreshParticipantServiceBooking",":participantId"],"variable":[{"key":"participantId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\",\n \"virtualStatus\": \"\"\n },\n {\n \"amount\": \"\",\n \"bookingType\": \"\",\n \"clientNumber\": \"\",\n \"createBy\": \"\",\n \"createDate\": \"\",\n \"daysLeft\": \"\",\n \"endDate\": \"\",\n \"isCancelled\": \"\",\n \"isDeleted\": \"\",\n \"isOld\": \"\",\n \"isUsed\": \"\",\n \"modifyBy\": \"\",\n \"modifyDate\": \"\",\n \"ndisNumber\": \"\",\n \"ndisRefreshDate\": \"\",\n \"ndisRego\": \"\",\n \"note\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"participantName\": \"\",\n \"planNumber\": \"\",\n \"rate\": \"\",\n \"regoId\": \"\",\n \"remaining\": \"\",\n \"sbHeaderId\": \"\",\n \"serviceBookingId\": \"\",\n \"serviceBookingNumber\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"supportCategory\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportItem\": \"\",\n \"supportItemName\": \"\",\n \"unit\": \"\",\n \"virtualStatus\": \"\"\n }\n ],\n \"participantId\": \"\",\n \"version\": \"\"\n}"}],"_postman_id":"94032184-b9e6-42b7-b080-f49c0a6ae3ec"}],"id":"b7aca341-430d-4cac-acb8-f331cdbeb46c","_postman_id":"b7aca341-430d-4cac-acb8-f331cdbeb46c","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"budget","item":[{"name":"/budget","id":"970b94fb-ccb3-4bc6-a7d5-bb61699bd949","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) 1234

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/budget?pageNum=1&participantId=&participantName=&ndisNumber=&startDate=&endDate=&category=&type=","description":"

This API retrieves all budgets from the quickclaim database (\"PACE\" and \"MANUAL\").
With quickclaim, you can add and maintain your internal budget as a MANUAL budget.
Note: PACE budgets can be up to 48 hours behind. If you need a live budget use GET /paceBudget/{ndisNumber} API.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["budget"],"host":["https://api.quickclaim.io/public"],"query":[{"description":{"content":"

pageNum

\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"

participantId

\n","type":"text/plain"},"key":"participantId","value":""},{"description":{"content":"

participantName

\n","type":"text/plain"},"key":"participantName","value":""},{"description":{"content":"

ndisNumber

\n","type":"text/plain"},"key":"ndisNumber","value":""},{"description":{"content":"

startDate

\n","type":"text/plain"},"key":"startDate","value":""},{"description":{"content":"

endDate

\n","type":"text/plain"},"key":"endDate","value":""},{"description":{"content":"

category

\n","type":"text/plain"},"key":"category","value":""},{"description":{"content":"

\"PACE\" OR \"MANUAL\"

\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[{"id":"0cc8fb9a-6a9c-4aba-b3a7-38a2fb6ebaec","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 1234"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://api.quickclaim.io/public/budget?pageNum=1&participantId=&participantName=&ndisNumber=&startDate=&endDate=&category=&type=","protocol":"https","host":["api","quickclaim","io"],"path":["public","budget"],"query":[{"key":"pageNum","value":"1","description":"pageNum"},{"key":"participantId","value":"","description":"participantId"},{"key":"participantName","value":"","description":"participantName"},{"key":"ndisNumber","value":"","description":"ndisNumber"},{"key":"startDate","value":"","description":"startDate"},{"key":"endDate","value":"","description":"endDate"},{"key":"category","value":"","description":"category"},{"key":"type","value":"","description":"\"PACE\" OR \"MANUAL\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"numberOfRecords\": \"\",\n \"numberOfPages\": \"\",\n \"currentPageNo\": \"\",\n \"currentPageRecordNo\": \"\",\n \"data\": [\n {\n \"budgetId\": \"\",\n \"orgId\": \"\",\n \"type\": \"\",\n \"participantId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"instalmentStartDate\": \"\",\n \"instalmentEndDate\": \"\",\n \"management\": \"\",\n \"support\": \"\",\n \"categoryCode\": \"\",\n \"paceCategoryCode\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportCategoryPace\": \"\",\n \"supportCategoryShortNamePace\": \"\",\n \"supportCategory\": \"\",\n \"spentAmount\": \"\",\n \"allocatedAmount\": \"\",\n \"releasedAmount\": \"\",\n \"remainingAmount\": \"\",\n \"approvedAmount\": \"\",\n \"quoteableItem\": \"\",\n \"inKind\": \"\",\n \"quoteApproved\": \"\",\n \"daysLeft\": \"\",\n \"budgetRefreshDate\": \"\",\n \"paceRefreshDateAttempt\": \"\",\n \"isDeleted\": \"\",\n \"participantName\": \"\",\n \"ndisNumber\": \"\",\n \"budgetType\": \"\",\n \"fundingPeriod\": \"\",\n \"instalmentType\": \"\",\n \"periodBudget\": [\n {\n \"orgId\": \"\",\n \"amount\": \"\",\n \"endDate\": \"\",\n \"budgetId\": \"\",\n \"duration\": \"\",\n \"released\": \"\",\n \"startDate\": \"\",\n \"budgetPeriodId\": \"\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"970b94fb-ccb3-4bc6-a7d5-bb61699bd949"}],"id":"da9359af-fc8b-4a99-a7df-dda05e8d16ae","_postman_id":"da9359af-fc8b-4a99-a7df-dda05e8d16ae","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"paceBudget","item":[{"name":"/paceBudget/{ndisNumber}","id":"c2b05f68-8140-46c1-badc-bdeb639f0cec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) 1234

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/paceBudget/:ndisNumber","description":"

This API retrieves a participant’s PACE budget directly from the NDIS. It only returns data for participants with a PACE plan. Please note that prior to calling this API you must add a Participant to the quickclaim database first, using POST /participant API. After a participant is added you can always call this API using the ndisNumber.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["paceBudget",":ndisNumber"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"580cff50-10f3-4c01-a095-e4176b46ad85","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ndisNumber"}]}},"response":[{"id":"a3128104-6365-4aa8-a8c0-ec501d6f19cd","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 1234"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://api.quickclaim.io/public/paceBudget/:ndisNumber","protocol":"https","host":["api","quickclaim","io"],"path":["public","paceBudget",":ndisNumber"],"variable":[{"key":"ndisNumber","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": [\n {\n \"budgetId\": \"\",\n \"orgId\": \"\",\n \"type\": \"\",\n \"participantId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"instalmentStartDate\": \"\",\n \"instalmentEndDate\": \"\",\n \"management\": \"\",\n \"support\": \"\",\n \"categoryCode\": \"\",\n \"paceCategoryCode\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportCategoryPace\": \"\",\n \"supportCategoryShortNamePace\": \"\",\n \"supportCategory\": \"\",\n \"spentAmount\": \"\",\n \"allocatedAmount\": \"\",\n \"releasedAmount\": \"\",\n \"remainingAmount\": \"\",\n \"approvedAmount\": \"\",\n \"quoteableItem\": \"\",\n \"inKind\": \"\",\n \"quoteApproved\": \"\",\n \"daysLeft\": \"\",\n \"budgetRefreshDate\": \"\",\n \"isDeleted\": \"\",\n \"participantName\": \"\",\n \"ndisNumber\": \"\",\n \"budgetType\": \"\",\n \"fundingPeriod\": \"\",\n \"instalmentType\": \"\",\n \"periodBudget\": [\n {\n \"orgId\": \"\",\n \"amount\": \"\",\n \"endDate\": \"\",\n \"budgetId\": \"\",\n \"duration\": \"\",\n \"released\": \"\",\n \"startDate\": \"\",\n \"budgetPeriodId\": \"\"\n }\n ]\n }\n ]\n}\n"}],"_postman_id":"c2b05f68-8140-46c1-badc-bdeb639f0cec"}],"id":"126a77e8-e419-4ef3-b671-376fe37e40d4","_postman_id":"126a77e8-e419-4ef3-b671-376fe37e40d4","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"sapBudget","item":[{"name":"/sapBudget/{ndisNumber}","id":"859c482e-a75d-41e6-b097-338c76c38bd6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"","description":"

(Required) 1234

\n"},{"key":"Accept","value":"application/json"},{"key":"rego-id","value":"","description":"

(Optional) 1234

\n","type":"text"}],"url":"https://api.quickclaim.io/public/sapBudget/:ndisNumber?planId=","description":"

This endpoint allows Plan Managers to retrieve plan-managed (SAP) budget details for a participant using a specific Plan ID. This API supports SAP participants only. For PACE participants, use the PACE Budget 4.0 endpoint.

\n

To receive a successful response, you must:

\n

• Have an active Service Booking for CB Choice and Control with Support Items 14_033_0127_8_3 or 14_034_0127_8_3

\n

• Have an active Plan Managed Service Booking between the participant and your organisation

\n

• Have received participant consent via the Participant Portal

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["sapBudget",":ndisNumber"],"host":["https://api.quickclaim.io/public"],"query":[{"description":{"content":"

Plan ID

\n","type":"text/plain"},"key":"planId","value":""}],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"ndisNumber"}]}},"response":[{"id":"9c8f8e25-56c1-44a2-be91-fc5f738e39da","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 1234"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://api.quickclaim.io/public/sapBudget/:ndisNumber","protocol":"https","host":["api","quickclaim","io"],"path":["public","sapBudget",":ndisNumber"],"variable":[{"key":"ndisNumber","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": [\n {\n \"budgetId\": \"\",\n \"orgId\": \"\",\n \"type\": \"\",\n \"participantId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"instalmentStartDate\": \"\",\n \"instalmentEndDate\": \"\",\n \"management\": \"\",\n \"support\": \"\",\n \"categoryCode\": \"\",\n \"paceCategoryCode\": \"\",\n \"supportCategoryApi\": \"\",\n \"supportCategoryPace\": \"\",\n \"supportCategoryShortNamePace\": \"\",\n \"supportCategory\": \"\",\n \"spentAmount\": \"\",\n \"allocatedAmount\": \"\",\n \"releasedAmount\": \"\",\n \"remainingAmount\": \"\",\n \"approvedAmount\": \"\",\n \"quoteableItem\": \"\",\n \"inKind\": \"\",\n \"quoteApproved\": \"\",\n \"daysLeft\": \"\",\n \"budgetRefreshDate\": \"\",\n \"isDeleted\": \"\",\n \"participantName\": \"\",\n \"ndisNumber\": \"\",\n \"budgetType\": \"\",\n \"fundingPeriod\": \"\",\n \"instalmentType\": \"\"\n }\n ]\n}\n"}],"_postman_id":"859c482e-a75d-41e6-b097-338c76c38bd6"}],"id":"d9b10112-74cf-4b3a-b40d-da9729b9d07b","description":"

Retrieve SAP (Non-PACE) Budget for a Participant

\n

https://api.quickclaim.io/public/sapBudget/:ndisNumber

\n","_postman_id":"d9b10112-74cf-4b3a-b40d-da9729b9d07b","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"plan","item":[{"name":"/plan/{ndisNumber}","id":"9d63d04c-7559-406d-ac6c-87c7132d7324","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

(Required) 1234

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/plan/:ndisNumber","description":"

This endpoint returns the NDIS plan of the given NDIS Number.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["plan",":ndisNumber"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"d171d04a-83b6-4d2d-a50a-7c22c4717ff7","type":"any","key":"ndisNumber"}]}},"response":[{"id":"683c5c21-4be3-4f8a-874b-24be88f07017","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) 1234","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/plan/:ndisNumber","host":["https://api.quickclaim.io/public"],"path":["plan",":ndisNumber"],"variable":[{"key":"ndisNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"participant\": {\n \"ndisNumber\": \"\",\n \"participantName\": \"\"\n },\n \"plans\": [\n {\n \"planNumber\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n },\n {\n \"planNumber\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n }\n ]\n },\n \"version\": \"\"\n}"},{"id":"678c557a-475e-4750-932a-420c6a541407","name":"422 response","originalRequest":{"method":"GET","header":[{"description":"(Required) 1234","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/plan/:ndisNumber","host":["https://api.quickclaim.io/public"],"path":["plan",":ndisNumber"],"variable":[{"key":"ndisNumber"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": \"\"\n}"}],"_postman_id":"9d63d04c-7559-406d-ac6c-87c7132d7324"},{"name":"/planByParticipantId/{participantId}","id":"d36b173e-5181-447e-a11a-ab698ec69f89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"key":"","value":"{{apiKey}}"},"isInherited":false},"method":"GET","header":[{"description":"

(Required) 1234

\n","key":"org-id","value":""},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/public/planByParticipantId/:participantId","description":"

This endpoint returns NDIS plans of the given participantId

\n","urlObject":{"path":["planByParticipantId",":participantId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"id":"52623c87-a7e4-4977-b99a-b8990aad555d","type":"any","key":"participantId"}]}},"response":[{"id":"8db2da3d-b81b-4584-b166-7c953e9329d9","name":"Success","originalRequest":{"method":"GET","header":[{"description":"(Required) 1234","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/planByParticipantId/:participantId","host":["https://api.quickclaim.io/public"],"path":["planByParticipantId",":participantId"],"variable":[{"key":"participantId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"endDate\": \"\",\n \"isCurrent\": \"\",\n \"ndisRefreshDate\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"planId\": \"\",\n \"planNumber\": \"\",\n \"startDate\": \"\"\n },\n {\n \"endDate\": \"\",\n \"isCurrent\": \"\",\n \"ndisRefreshDate\": \"\",\n \"orgId\": \"\",\n \"participantId\": \"\",\n \"planId\": \"\",\n \"planNumber\": \"\",\n \"startDate\": \"\"\n }\n ],\n \"version\": \"\"\n}"},{"id":"b3b5c230-4d8a-4978-8789-82553953c219","name":"422 response","originalRequest":{"method":"GET","header":[{"description":"(Required) 1234","key":"org-id","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"x-api-key","value":""}],"url":{"raw":"https://api.quickclaim.io/public/planByParticipantId/:participantId","host":["https://api.quickclaim.io/public"],"path":["planByParticipantId",":participantId"],"variable":[{"key":"participantId"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"message\": \"\"\n}"}],"_postman_id":"d36b173e-5181-447e-a11a-ab698ec69f89"}],"id":"0f5b54a6-6894-45a4-af9d-99548bd41e39","_postman_id":"0f5b54a6-6894-45a4-af9d-99548bd41e39","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"notification","item":[{"name":"/ndis-notification/subscriptions/{regoId}","id":"5f24555e-31ec-46d6-b662-520bd45f18a1","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","type":"text","value":""}],"url":"https://api.quickclaim.io/public/ndis-notification/subscriptions/:regoId","description":"

Using this endpoint, you can retrieve the list of existing subscribed events in NDIS. You will need the guid parameter from the response payload later to unsubscribe from that event.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["ndis-notification","subscriptions",":regoId"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[{"type":"any","value":"","key":"regoId"}]}},"response":[{"id":"ee3913bf-5382-482c-8b67-1b76b2fc4ec1","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","type":"text"},{"key":"x-api-key","value":"","type":"text"}],"url":{"raw":"https://api.quickclaim.io/public/ndis-notification/subscriptions/:regoId","host":["https://api.quickclaim.io/public"],"path":["ndis-notification","subscriptions",":regoId"],"variable":[{"key":"regoId","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": {\n \"success\": true,\n \"result\": [\n {\n \"guid\": \"40000AA000061ED000A4D90000A90000\",\n \"event_id\": \"SB_EXPIRING\",\n \"device_id\": \"quickclaim\",\n \"webhook_url\": \"https://api.quickclaim.com.au/ndis-notification/listener/{orgId}\"\n },\n {\n \"guid\": \"002F500B38001ED00FE000A700AF3000\",\n \"event_id\": \"SB_NEW\",\n \"device_id\": \"quickclaim\",\n \"webhook_url\": \"https://api.quickclaim.com.au/ndis-notification/listener/{orgId}\"\n }\n ]\n }\n}"}],"_postman_id":"5f24555e-31ec-46d6-b662-520bd45f18a1"},{"name":"/ndis-notification/subscriber","id":"d1e60f38-428c-49f9-b619-8d4bc6fb7029","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"event_id\": \"\",\n \"regoId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.quickclaim.io/public/ndis-notification/subscriber","description":"

Using this endpoint, you can subscribe to an event in NDIS.
Event IDs such as:

\n
    \n

  • SB_NEW

    \n
    • \n

  • SB_END_DATE_UPDATED

    \n
    • \n

  • SB_BUDGET_UPDATED

    \n
    • \n

  • SB_DELETED

    \n
    • \n

  • SB_EXPIRING

    \n
    • \n

  • PLAN_END_DT_UPDATED

    \n
    • \n

  • REMIT_ADV_GENERATED

    \n
    • \n

  • QUOTATION_RESPO_REQD

    \n
    • \n

  • RFS_ASSIGNED

    \n
    • \n

  • PRODUCT_CAT_UPDATED

    \n
    • \n

  • BULK_PROCESS_FINISH

    \n
    • \n

  • BUDGET_UPDATED

    \n
    • \n

  • RLTN_CREATED

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["ndis-notification","subscriber"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"6d3172d8-9e06-4708-9fe8-62b4b10d5863","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","type":"text"},{"key":"x-api-key","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"event_id\": \"\",\n \"regoId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.quickclaim.io/public/ndis-notification/subscriber"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": {\n \"success\": true\n }\n}"}],"_postman_id":"d1e60f38-428c-49f9-b619-8d4bc6fb7029"},{"name":"/ndis-notification/unsubscribe","id":"befe79a1-831d-4b41-a0f3-34d57cac119e","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","type":"text","value":""}],"body":{"mode":"raw","raw":"{\n \"guid\": \"\",\n \"event_id\": \"\",\n \"regoId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.quickclaim.io/public/ndis-notification/unsubscribe","description":"

Using this endpoint, you can unsubscribe from an event. You need the guid to unsubscribe, which you can get from the subscriptions API that lists all subscribed events for you.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["ndis-notification","unsubscribe"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"d2bf5c85-1268-4773-b00a-15fc9f233ed4","name":"Success","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","type":"text"},{"key":"x-api-key","value":"","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"guid\": \"\",\n \"event_id\": \"\",\n \"regoId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.quickclaim.io/public/ndis-notification/unsubscribe"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": {\n \"success\": true\n }\n}"}],"_postman_id":"befe79a1-831d-4b41-a0f3-34d57cac119e"}],"id":"42484c95-2c25-453a-b4df-87a71d9b29af","_postman_id":"42484c95-2c25-453a-b4df-87a71d9b29af","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"payment","item":[{"name":"Events","item":[],"id":"fab6a625-31d6-4f87-97b1-7149f0b21ed7","description":"

Quick Claim Webhook Events

\n

When you configure a webhook URL with us, Quick Claim notifications are delivered through the exact same HTTP endpoint, you already use for standard NDIS notifications.

\n

QC events are emitted on transactions originally lodged via the Payment POST API on status changes. They arrive inter-mixed with your existing NDIS events. All QC event identifiers start with QC- and every payload follows the structure documented below (see Event envelope, Event catalogue, and Transaction object).

\n

Event Envelop

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
JSON attributeTypeDescription
event_idStringIdentifies the kind of notification. Always starts with QC-.
responseObjectContainer holding your data.
└─ response.transactionsArrayOne or more transactions (up to 1000)
\n

Event Catalog

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
event_idWhen you receive itNotes
QC-Transaction-InvoicedA payment request (invoice) has been raised.First step in the claim life-cycle.
QC-Transaction-SuccessThe request was settled in full.paidAmount holds the settled figure.
QC-Transaction-CancelThe request was withdrawn.cancellationDate / cancellationReason populate.
QC-Transaction-ErrorProcessing failed after invoicing.errorMessage explains the failure.
QC-Transaction-InvalidThe row was rejected at import/validation time.approved + errorMessage supplied.
\n

Transaction Object — field reference

\n

Every notification carries one or more transaction records under response.transactions[].
Unless marked Required, an attribute may be omitted or appear as an empty string (\"\").

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldType / FormatDescription
shiftIdInteger (Required)Internal shift identifier.
orgIdInteger (Required)Organisation (tenant) ID.
customerTransactionIdStringCaller-supplied external reference.
batchNameStringHuman-readable batch label.
batchIdUUID (String)System batch identifier.
clientFirstnameStringParticipant first name.
clientLastnameStringParticipant last name.
ndisNumberStringParticipant’s 9-digit NDIS number.
clientNumberStringCustomer identifier inside Quick Claim.
paymentTypeEnum plan-managed agency-managedType of payment
registrationNumberString / IntegerProvider NDIS registration number.
programCodeStringFunding-program code (if applicable).
programNameStringFunding-program name (if applicable).
programCostcodeStringCost-centre for the program.
locationCodeStringService-location code.
locationNameStringService-location name.
serviceNameStringSupport item text.
serviceCodeStringSupport item code.
supportItemStringNDIS support item delivered.
gstApply\"true\"Is GST Applied
serviceStartDateISO-8601Start date-time of service.
serviceEndDateISO-8601End date-time of service.
unitNumberUnits delivered (e.g. hours).
rateNumberUnit rate, GST-exclusive.
billingNameString“Bill-to” entity name.
financeDebtorCodeStringDebtor code used in finance system.
billingAddressStringStreet address.
billingSuburbStringSuburb / city.
billingPostcodeStringPostcode / ZIP.
billingStateStringState / region.
billingEmailStringAccounts-receivable email.
billingPhoneStringLandline number.
billingMobileStringMobile number.
billingContactStringContact person (appears in Invalid events).
claimTypeStringClaim category.
invoiceDescriptionStringNarrative shown on the invoice.
claimReferenceStringExternal claim reference.
claimExportFileNameStringFilename sent to NDIS, if any.
claimSubmissionDateISO-8601Timestamp when the claim was lodged.
paidAmountNumberAmount paid or invoiced.
paymentRequestNumberStringNDIS payment-request ID.
paymentRequestStatusINVOICEDStatus of the pyament for the transaction
errorMessageStringDiagnostic detail (present on Error / Invalid).
financeNoteStringInternal finance note.
invoiceNumberStringIssued invoice number.
paymentDateISO-8601Settlement date-time.
ratioStringSupport ratio (e.g. \"1:1\").
createDateISO-8601Record-creation timestamp.
cancellationDateISO-8601Populated on Cancel events.
cancellationReasonStringReason for cancellation.
approvedBoolean (\"true\" / \"false\")Only in Invalid events—indicates prior approval status.
userFieldStringFree-form field supplied by the caller.
timeZoneStringOriginal local time-zone (e.g. Australia/Sydney).
\n

**
Notes**

\n
    \n

  • Fields marked null in examples are still emitted; your parser should accept empty strings or JSON null.

    \n
    • \n

  • All date/times use UTC unless a separate timeZone is present for reference.

    \n
    • \n

  • Numeric fields (unit, rate, paidAmount) are plain JSON numbers, not strings.

    \n
    • \n
\n

Examples:

\n

QC-Transaction-Invoiced

\n
{\n  \"event_id\": \"QC-Transaction-Invoiced\",\n  \"response\": {\n    \"transactions\": [\n      {\n        \"shiftId\": 223344556,\n        \"orgId\": 25024,\n        \"customerTransactionId\": \"7012345_639999999999999999\",\n        \"batchName\": \"777001_639999999999999999\",\n        \"batchId\": \"a1b2c3d4-e5f6-7890-aaaa-bbbbbbbbbbbb\",\n        \"clientFirstname\": \"Jordan\",\n        \"clientLastname\": \"Taylor\",\n        \"ndisNumber\": \"999888777\",\n        \"clientNumber\": \"12345\",\n        \"paymentType\": \"plan-managed\",\n        \"registrationNumber\": 4000000001,\n        \"programCode\": null,\n        \"programName\": \"General\",\n        \"programCostcode\": null,\n        \"locationCode\": \"General\",\n        \"locationName\": \"Job_Admin\",\n        \"serviceName\": \"07_002_0106_8_3\",\n        \"serviceCode\": \"07_002_0106_8_3\",\n        \"supportItem\": \"07_002_0106_8_3\",\n        \"gstApply\": \"false\",\n        \"serviceStartDate\": \"2025-03-31T22:00:00Z\",\n        \"serviceEndDate\": \"2025-03-31T22:15:00Z\",\n        \"unit\": 0.25,\n        \"rate\": 150.21,\n        \"billingName\": \"QC Plan Management\",\n        \"financeDebtorCode\": \"1111aaaa-2222-bbbb-3333-ccccdddd4444\",\n        \"billingAddress\": null,\n        \"billingSuburb\": null,\n        \"billingPostcode\": null,\n        \"billingState\": null,\n        \"billingEmail\": \"billing@example.com\",\n        \"billingPhone\": null,\n        \"billingMobile\": null,\n        \"claimType\": null,\n        \"invoiceDescription\": null,\n        \"claimReference\": null,\n        \"claimExportFileName\": null,\n        \"claimSubmissionDate\": \"2025-07-09T11:41:36Z\",\n        \"paidAmount\": 37.55,\n        \"paymentRequestNumber\": \"8000001\",\n        \"paymentRequestStatus\": \"INVOICED\",\n        \"errorMessage\": \"\",\n        \"financeNote\": null,\n        \"invoiceNumber\": null,\n        \"paymentDate\": null,\n        \"ratio\": \"1:1\",\n        \"createDate\": \"2025-06-02T06:14:20Z\",\n        \"cancellationDate\": \"2025-07-09T01:08:33Z\",\n        \"userField\": null,\n        \"timeZone\": \"Australia/Sydney\",\n        \"cancellationReason\": \"\"\n      }\n    ]\n  }\n}\n\n

QC-Transaction-Invalid

\n
{\n  \"event_id\": \"QC-Transaction-Invalid\",\n  \"response\": {\n    \"transactions\": [\n      {\n        \"customerTransactionId\": \"7012366_xxyyzz638433634752081947\",\n        \"orgId\": 25024,\n        \"batchId\": \"d4c3b2a1-9e8f-7654-bbbb-cccccccccccc\",\n        \"batchName\": \"777099_638853634752011947\",\n        \"errorMessage\": \"Duplicate transaction\",\n        \"clientFirstname\": \"Alex\",\n        \"clientLastname\": \"Morgan\",\n        \"ndisNumber\": \"888777666\",\n        \"clientNumber\": \"67890\",\n        \"paymentType\": \"agency-managed\",\n        \"registrationNumber\": \"4000000001\",\n        \"programCode\": null,\n        \"programName\": \"IBS9814\",\n        \"programCostcode\": null,\n        \"locationCode\": null,\n        \"locationName\": \"DB,AS,SIL,12SAV\",\n        \"serviceCode\": null,\n        \"serviceName\": null,\n        \"supportItem\": \"01_801_0115_1_1\",\n        \"serviceStartDate\": \"2025-06-12 00:00\",\n        \"serviceEndDate\": \"2025-06-12 23:59\",\n        \"unit\": \"2\",\n        \"rate\": \"67.56\",\n        \"gstApply\": \"false\",\n        \"billingName\": \"NDIS\",\n        \"financeDebtorCode\": \"NDIS\",\n        \"billingContact\": null,\n        \"billingAddress\": null,\n        \"billingSuburb\": null,\n        \"billingPostcode\": null,\n        \"billingState\": null,\n        \"billingEmail\": null,\n        \"billingPhone\": null,\n        \"billingMobile\": null,\n        \"claimType\": null,\n        \"invoiceDescription\": null,\n        \"userField\": \"1234567890\",\n        \"timeZone\": null,\n        \"approved\": \"true\",\n        \"createDate\": \"2025-07-10T05:05:41Z\"\n      }\n    ]\n  }\n}\n\n

Processing rules

\n
    \n

  1. One POST per event; each array is chunked to ≤ 1000 transactions.

    \n
    2. \n

  2. Verify the X-QC-Signature exactly as for existing NDIS webhooks.

    \n
    3. \n

  3. Respond with HTTP 200 to acknowledge; any other status triggers exponential retries.

    \n
    4. \n
\n","_postman_id":"fab6a625-31d6-4f87-97b1-7149f0b21ed7","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}},{"name":"transactions","id":"852c458b-31b4-4dfa-9295-8bab5cbe5286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"","description":"

(Required) 123

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"batchName\":\"BATCH00001\",\n \"transactions\": [\n {\n \"customerTransactionId\":\"\",\n \"clientFirstname\": \"\",\n \"clientLastname\": \"\",\n \"ndisNumber\": \"\",\n \"clientNumber\":\"\",\n \"paymentType\": \"\",\n \"registrationNumber\":\"\",\n \"programCode\": \"\",\n \"programName\":\"\",\n \"programCostcode\": \"\",\n \"locationCode\": \"\",\n \"locationName\":\"\",\n \"serviceCode\": \"\",\n \"supportItem\": \"\",\n \"serviceName\":\"\",\n \"serviceDurationMin\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"gstApply\": \"\",\n \"billingName\":\"\",\n \"financeDebtorCode\":\"\",\n \"billingMobile\":\"\",\n \"billingPhone\":\"\",\n \"billingEmail\":\"\",\n \"billingState\":\"\",\n \"billingPostcode\":\"\",\n \"billingSuburb\":\"\",\n \"billingAddress\":\"\",\n \"claimType\": \"\",\n \"invoiceDescription\":\"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transactions","description":"

This API call allows you to send transaction details to quickclaim based on the parameters outlined below.

\n

Payload

\n

Transaction parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescription
customerTransactionIdUnique transaction identifier nominated by CRM.
approvedProvide true for automatic submission to NDIS. The transaction that are entered with false needs to get approved by user within quickclaim app.
clientFirstnameThe client/participant's first name.
clientLastnameThe client/participant's surname.
ndisNumberThe client/participant's NDIS number.
clientNumberThe client's identifier in the CRM. (good to have).
paymentTypeOne of the: agency-managed, plan-managed or self-managed.
registrationNumberThe organisation's NDIS registration number.
programCodeThe program code.
programNameThe unique program name based on CRM. This field is used to map to finance chart of accounts (may be one natural account). In case this field is empty it will map to the General program.
programCostcodeThe natural account code in Finance. This field defines where to book the revenue.
locationCodeThe location code.
locationNameThe unique location name mapped to a Finance Divisional Account. In case this field is empty it will map to the General location.
serviceCodeThe service or product code used in CRM.
serviceNameThe service or product name. In case this field is empty it’s going to map to the supportItem as the serviceName.
supportItemNDIS Support Item.
serviceStartDateStart datetime of the service.
serviceEndDateEnd datetime of the service.
unitUnit of the service delivered.
rateRate of the service.
gstApplyIdentifies if GST should be added to the rate. Rate amount is always GST exclusive.
billingNameOrganisation name of the recipient of the invoice. (This is the ID of the invoice recipient in our system). This field always updates the financial contact of the participant.
financeDebtorCodeDebtor code of the recipient of the invoice based on Finance.
billingAddressBilling address of the recipient.
billingSuburbBilling address of the recipient.
billingPostcodeBilling address of the recipient.
billingStateBilling address of the recipient.
billingEmailBilling email of the recipient.
billingPhoneBilling phone of the recipient.
billingMobileBilling mobile phone of the recipient.
claimTypeType of the service delivered which can be either of the below enum values to identify no-show or cancellation, non-face to face services: TRAN, CANC-NSDO, IRSS, NF2F, CANC-NSDT, NSNP, CANC-NSDH, CANC-NSDF.
invoiceDescriptionOptional description for each line of invoice.
userFieldOptional field for each line of invoice.
timeZoneOptional, default = Australia/Sydney
\n

Validation Rules

\n

Each transaction will go through a series of validation checks to ensure data integrity before processing. Once you send these transactions and our system validates them you can get them by their transaction ID and see how our system handled them. Please ensure the following conditions are met to avoid rejections:

\n

1. Customer Transaction ID

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be a unique string.

    \n
    • \n

  • Error Message: \"transactionId is missing.\"

    \n
    • \n
\n

2. Approved

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be either true or false.

    \n
    • \n

  • Error Message: \"approved must be 0 (false) or 1 (true).\"

    \n
    • \n
\n

3. NDIS Number

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must follow the regex pattern: ^(43|5\\d)\\d{7,8}$.

    \n
    • \n

  • Error Message: \"ndisNumber is not valid!\"

    \n
    • \n
\n

4. Payment Type

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be one of the following:

    \n
      \n

    • agency-managed

      \n
      • \n

    • plan-managed

      \n
      • \n

    • self-managed

      \n
      • \n
    \n
    • \n

  • Error Message: \"paymentType is missing or invalid.\"

    \n
    • \n
\n

5. Registration Number

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be provided in the QC dashboard.

    \n
    • \n

  • Error Message: \"registrationNumber is missing.\"

    \n
    • \n
\n

6. Support Item

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must match a valid support item in the NDIS catalogue.

    \n
    • \n

  • Error Message: \"supportItem is missing or invalid.\"

    \n
    • \n
\n

7. Service Start Date

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be a valid date in the format YYYY-MM-DD HH:mm.

    \n
    • \n

  • Error Message: \"serviceStartDate is not valid!\"

    \n
    • \n
\n

8. Service End Date

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be a valid date in the format YYYY-MM-DD HH:mm and should be greater than or equal to the service start date.

    \n
    • \n

  • Error Message: \"serviceEndDate is not valid!\"

    \n
    • \n
\n

9. Unit

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be a valid, positive number.

    \n
    • \n

  • Error Message: \"unit is missing or not a valid number.\"

    \n
    • \n
\n

10. Rate

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be a valid, positive number.

    \n
    • \n

  • Error Message: \"rate is missing or not a valid number.\"

    \n
    • \n
\n

11. GST Apply

\n
    \n

  • Required: Yes

    \n
    • \n

  • Validation: Must be either false (no GST) or true (GST applies).

    \n
    • \n

  • Error Message: \"gstApply must be 0 (false) or 1 (true).\"

    \n
    • \n
\n

12. Billing Name (For Plan-Managed or Self-Managed Payments)

\n
    \n

  • Required: Yes (for plan-managed or self-managed payment type)

    \n
    • \n

  • Validation: Must be provided if paymentType is plan-managed or self-managed.

    \n
    • \n

  • Error Message: \"billingName is missing.\"

    \n
    • \n
\n

13. Claim Type

\n
    \n

  • Required: No (Optional)

    \n
    • \n

  • Validation: If provided, must be one of the following:

    \n
      \n

    • TRAN

      \n
      • \n

    • CANC-NSDO

      \n
      • \n

    • IRSS

      \n
      • \n

    • NF2F

      \n
      • \n

    • CANC-NSDT

      \n
      • \n

    • NSNP

      \n
      • \n

    • CANC-NSDH

      \n
      • \n

    • CANC-NSDF

      \n
      • \n
    \n
    • \n

  • Error Message: \"claimType is invalid.\"

    \n
    • \n
\n

14. Time Zone

\n
    \n

  • Required: No (Optional)

    \n
    • \n

  • Validation: If provided, must be one of the following:

    \n
      \n

    • UTC

      \n
      • \n

    • Australia/Adelaide

      \n
      • \n

    • Australia/Brisbane

      \n
      • \n

    • Australia/Broken_Hill

      \n
      • \n

    • Australia/Currie

      \n
      • \n

    • Australia/Darwin

      \n
      • \n

    • Australia/Eucla

      \n
      • \n

    • Australia/Hobart

      \n
      • \n

    • Australia/Lindeman

      \n
      • \n

    • Australia/Lord_Howe

      \n
      • \n

    • Australia/Melbourne

      \n
      • \n

    • Australia/Perth

      \n
      • \n

    • Australia/Sydney

      \n
      • \n
    \n
    • \n

  • Error Message: \"timeZone is invalid.\"

    \n
    • \n
\n
\n

Mapping to Internal Dimensions

\n

When a transaction passes validation, it is mapped to several internal dimensions, including participants, programs, locations, and products. Here's how the mapping works:

\n

1. Participant Mapping

\n
    \n

  • The provided ndisNumber is used to fetch or create a participant record in our internal system.

    \n
    • \n

  • If the ndisNumber does not exist, a new participant is created.

    \n
    • \n
\n

2. Program Mapping

\n
    \n

  • The programId is determined based on the programName provided in the transaction.

    \n
    • \n

  • If no program name is provided, the default program \"General\" is used.

    \n
    • \n
\n

3. Location Mapping

\n
    \n

  • The locationId is determined based on the locationName provided in the transaction.

    \n
    • \n

  • If no location name is provided, the default location \"General\" is used.

    \n
    • \n
\n

4. Product(service) Mapping

\n
    \n

  • The productId is determined by the combination of serviceName and supportItem.

    \n
    • \n

  • If no serviceName is provided, we use the supportItem to map to the product name.

    \n
    • \n

  • If there is no matching serviceName and supportItem, a new product(service) is created.

    \n
    • \n
\n

5. Financial contact Mapping

\n
    \n
  • Provided billingName is the key to finding the participant's financial contact. If there is no record with the provided billingName we insert a new record and assign it to the participant. later in the the new transactions if a new billingName came with the same participant we link the new one to this participant.
    • \n
\n

6. Registration Mapping

\n
    \n
  • For transactions marked as agency-managed, the registrationNumber provided is used to map the regoId from our internal registration system. You need to define them in quickclaim dashboard before using this API.
    • \n
\n

7. Shift Table Insertion

\n

Once all the necessary mappings are complete, the validated transaction is inserted into our shift table, and it will be processed for claims.

\n

Reclaim Workflow

\n

Using the same post-transaction API, you can send modified transactions for reprocessing. These transactions must meet the following criteria:

\n
    \n

  1. Error Status: The existing customerTransactionId must be in the Error status before reprocessing.

    \n
    2. \n

  2. Validation Rules: The same validation rules apply to initial transactions, including checks for transaction ID, payment type, support items, service dates, and more.

    \n
    3. \n
\n

This workflow allows users to modify and resubmit erroneous transactions for successful inclusion in the system.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["transactions"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"fb5c5ccf-2f8c-4b84-8433-8b9b0b7e924a","name":"Item created","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"batchName\":\"BCH00001\",\n \"transactions\": [\n {\n \"customerTransactionId\":\"AH000000001\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"billingName\":\"B-Name\",\n \"financeDebtorCode\":\"FDCode\",\n \"programCode\": \"PC001\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"01_805_0115_1_1\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 1.0,\n \"rate\": 100.0,\n \"gstApply\": true,\n \"approved\": false,\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"invoice Description\",\n \"billingMobile\":\"billingMobile\",\n \"billingPhone\":\"billingPhone\",\n \"billingEmail\":\"billingEmail\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"billingContact\":\"billingContact\",\n \"serviceDurationMin\":\"serviceDurationMin\",\n \"serviceName\":\"serviceName\",\n \"locationName\":\"locationName\",\n \"programName\":\"programName\",\n \"clientNumber\":\"clientNumber\"\n },\n {\n \"transactionId\":\"YAYAYAY\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"43134567\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"asdads\",\n \"billingName\":\"asda\",\n \"financeDebtorCode\":\"asda\",\n \"programCode\": \"PC001\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\": \"LCName1\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 1.0,\n \"rate\": 100.0,\n \"gstApply\": true,\n \"claimType\": \"TRAN\"\n },\n {\n \"transactionId\":\"asd\",\n \"clientFirstname\": \"John3\",\n \"clientLastname\": \"Doe3\",\n \"ndisNumber\": \"433333333\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"asdads\",\n \"billingName\":\"asda33\",\n \"financeDebtorCode\":\"asda33\",\n \"programCode\": \"PC001\",\n \"programCostcode\": \"CC00133\",\n \"locationCode\": \"LC00133\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 1.0,\n \"rate\": 100.0,\n \"gstApply\": false,\n \"claimType\": \"TRAN\"\n },\n {\n \"transactionId\":\"asd22\",\n \"clientFirstname\": \"John22\",\n \"clientLastname\": \"Doe22\",\n \"ndisNumber\": \"432222222\",\n \"paymentType\": \"plan-managed\",\n \"registrationNumber\":\"asdads234\",\n \"billingName\":\"asda123\",\n \"financeDebtorCode\":\"asda\",\n \"programCode\": \"PC001\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 1.0,\n \"rate\": 100.0,\n \"gstApply\": false,\n \"claimType\": \"TRAN\"\n },\n {\n \"transactionId\":\"asd99\",\n \"clientFirstname\": \"John99\",\n \"clientLastname\": \"Doe99\",\n \"ndisNumber\": \"439994569\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"asdads\",\n \"billingName\":\"asda\",\n \"financeDebtorCode\":\"99999\",\n \"programCode\": \"99999\",\n \"programCostcode\": \"99999\",\n \"locationCode\": \"9999999\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": \"1.2d0\",\n \"rate\": \"\",\n \"gstApply\": false,\n \"claimType\": \"TRAN\"\n },\n {\n \"transactionId\":\"asd_new120\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"438888881\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"approved\": true,\n \"supportItem\":\"01_805_0115_1_1\",\n \"billingName\":\"billingName1\",\n \"financeDebtorCode\":\"asda\",\n \"programName\": \"programName\",\n \"programCode\": \"888888\",\n \"programCostcode\": \"88888\",\n \"locationCode\": \"8888\",\n \"locationName\": \"locName2\",\n \"serviceCode\": \"8888\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": \"1077.00\",\t\n \"rate\": \"6.78\",\n \"gstApply\": \"fsdfsdf\",\n \"claimType\": \"TRAN\"\n },\n {\n \"transactionId\":\"asd_new16\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"438888881\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"approved\": false,\n \"supportItem\":\"01_805_0115_1_1\",\n \"billingName\":\"billingName1\",\n \"financeDebtorCode\":\"asda\",\n \"programName\": \"programName\",\n \"programCode\": \"888888\",\n \"programCostcode\": \"88888\",\n \"locationCode\": \"8888\",\n \"locationName\": \"locName2\",\n \"serviceCode\": \"8888\",\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 23.23,\n \"rate\": 43.234,\n \"gstApply\": false,\n \"claimType\": \"TRAN\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transactions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"message\": \"Transaction data has been imported successfully.\"\n}"},{"id":"643baa67-ba4c-4785-b4e1-b6cf4d272854","name":"Invalid payload","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"\n{\n \"batchName\":\"BATCH00001\",\n \"transactionsdddd\": [\n {\n \"customerTransactionId\":\"AH00000001\",\n \"approved\":true,\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\":\"Maverick\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": false,\n \"billingName\":\"B0001\",\n \"financeDebtorCode\":\"F00001\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000002\",\n \"approved\":true,\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\":\"Maverick\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": false,\n \"billingName\":\"B0001\",\n \"financeDebtorCode\":\"F00001\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000003\",\n \"approved\":false,\n \"batchName\":\"BATCH00002\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234568\",\n \"clientNumber\":\"CL000000002\",\n \"paymentType\": \"plan-managed\",\n \"registrationNumber\":\"4050000201\",\n \"locationCode\": \"LC002\",\n \"locationName\":\"Randwik\",\n \"serviceCode\": \"SC002\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC002\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 132.14,\n \"rate\": 498.56,\n \"gstApply\": true,\n \"billingName\":\"B0002\",\n \"financeDebtorCode\":\"F00002\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"NF2F\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000004\",\n \n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": false,\n \"billingName\":\"B0001\",\n \"financeDebtorCode\":\"F00001\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000005\",\n \"approved\":false,\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\":\"Maverick\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": false,\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000006\",\n \"approved\":false,\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234568\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\":\"Maverick\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": true,\n \"billingName\":\"B0002\",\n \"financeDebtorCode\":\"F00001\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n },\n {\n \"transactionId\":\"AH00000007\",\n \"approved\":true,\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234568\",\n \"clientNumber\":\"CL000000001\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\":\"405044000201\",\n \"programCode\": \"PC001\",\n \"programName\":\"SC_SLEEP\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\":\"Maverick\",\n \"serviceCode\": \"SC001\",\n \"supportItem\": \"15_037_0117_1_3\",\n \"serviceName\":\"SC001\",\n \"serviceDurationMin\": 34,\n \"serviceStartDate\": \"2023-01-01T00:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00Z\",\n \"unit\": 432.14,\n \"rate\": 198.56,\n \"gstApply\": true,\n \"billingName\":\"B0001\",\n \"financeDebtorCode\":\"F00001\",\n \"billingMobile\":\"0435999999\",\n \"billingPhone\":\"0435999999\",\n \"billingEmail\":\"billing@email.com\",\n \"billingState\":\"billingState\",\n \"billingPostcode\":\"billingPostcode\",\n \"billingSuburb\":\"billingSuburb\",\n \"billingAddress\":\"billingAddress\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\":\"Invoice Description\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transactions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": \"Transactions data should be provided in the body.\"\n}"}],"_postman_id":"852c458b-31b4-4dfa-9295-8bab5cbe5286"},{"name":"transaction","id":"da13de27-a340-4d9a-be22-de4b334e4baf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"org-id","value":"15018","description":"

(Required) 123

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"user-id","value":"SYSTEM","type":"text"},{"key":"token","value":"{{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/{customerTransactionId}","description":"

Using this endpoint you can get the payment result of a transaction.

\n

Response Parameters Table

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
KeyDescriptionType
customerTransactionIdTransaction identifier nominated by CRM.string
batchNameName of the parent (batch name) of this transaction.string
batchIdUUID generated by quickclaim for each batch.string
claimReferenceUnique ID of the claim issued by quickclaim. Example: '12345_405000001_-12345_98765'.string
claimExportFileNameFor agency-managed transactions, the name of the batch submitted to NDIS.string
claimSubmissionDateThe submission date of the claims to the NDIS portal.datetime
paidAmountThe amount paid by the payer.decimal (8,2)
paymentRequestNumberNDIS Payment Request Number (PRN) for agency-managed transactions.string
participantNameNDIS Participant full name for agency-managed transactions.string
paymentRequestStatusPayment status, e.g. SUCCESSFUL, INVOICED, ERROR, PENDING PAYMENT, PENDING CANCEL, CANCELLED.string
errorMessageDetailed error message for failed payments.string
financeNoteA note from the processing team.string
invoiceNumberquickclaim invoice number.string
paymentDateDate of the payment.date
cancellationDateDate the transaction was cancelled on the NDIS portal.date
cancellationReasonThe reason for cancelling the claim.string
clientFirstnameThe client/participant's first name.string
clientLastnameThe client/participant's surname.string
ndisNumberThe client/participant's NDIS number.string
clientNumberThe client's identifier in the CRM (good to have).string
paymentTypeOne of: agency-managed, plan-managed, or self-managed.string
registrationNumberThe organisation's NDIS registration number.string
programCodeThe program code.string
programNameThe unique program name based on CRM.string
programCostcodeThe natural account code in Finance, defining where to book the revenue.string
locationCodeThe location code.string
locationNameThe unique location name mapped to a Finance Divisional Account.string
serviceCodeThe service or product code used in CRM.string
serviceNameThe service or product name.string
supportItemNDIS Support Item.string
serviceStartDateStart datetime of the service.datetime
serviceEndDateEnd datetime of the service.datetime
unitUnit of the service delivered.decimal (8,2)
rateRate of the service.decimal (8,2)
gstApplyIndicates whether GST has been added to the rate.boolean
billingNameOrganisation name of the invoice recipient.string
financeDebtorCodeDebtor code of the recipient of the invoice based on Finance.string
billingAddressBilling address of the recipient.string
billingSuburbBilling suburb of the recipient.string
billingPostcodeBilling postcode of the recipient.string
billingStateBilling state of the recipient.string
billingEmailBilling email of the recipient.string
billingPhoneBilling phone of the recipient.string
billingMobileBilling mobile phone of the recipient.string
claimTypeType of service delivered.string
invoiceDescriptionOptional description for each line of invoice.string
\n
","urlObject":{"path":["transaction","{customerTransactionId}"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"7dec15c0-613f-44d4-9784-128b48dddeb9","name":"Item found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/AH000000001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": {\n \"transaction\": [\n {\n \"transactionId\": \"AH000000001\",\n \"batchName\": \"BCH00001\",\n \"batchId\": \"80facafb-c59d-4e32-804c-d5b46040a42d\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\": \"clientNumber\",\n \"paymentType\": \"agency-managed\",\n \"registrationNumber\": 4050000201,\n \"programCode\": \"888888\",\n \"programName\": \"programName\",\n \"programCostcode\": \"88888\",\n \"locationCode\": \"LC001\",\n \"locationName\": \"locationName\",\n \"serviceName\": \"serviceName\",\n \"serviceCode\": \"01_805_0115_1_1\",\n \"supportItem\": \"01_805_0115_1_1\",\n \"gstApply\": \"true\",\n \"serviceStartDate\": \"2023-01-01T11:00:00Z\",\n \"serviceEndDate\": \"2023-01-01T12:00:00Z\",\n \"unit\": 1,\n \"rate\": 100,\n \"billingName\": \"B-Name\",\n \"financeDebtorCode\": \"FDCode\",\n \"billingAddress\": \"billingAddress\",\n \"billingSuburb\": \"billingSuburb\",\n \"billingPostcode\": \"billingPostcode\",\n \"billingState\": \"billingSta\",\n \"billingEmail\": \"billingEmail\",\n \"billingPhone\": \"billingPhone\",\n \"billingMobile\": \"billingMobile\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\": \"invoice Description\",\n \"claimReference\": null,\n \"claimExportFileName\": null,\n \"claimSubmissionDate\": null,\n \"paidAmount\": null,\n \"paymentRequestNumber\": null,\n \"paymentRequestStatus\": \"PENDING APPROVAL\",\n \"errorMessage\": null,\n \"financeNote\": null,\n \"invoiceNumber\": null,\n \"paymentDate\": null,\n \"ratio\": \"1:1\",\n \"createDate\": \"2024-09-23T01:20:05Z\",\n \"cancellationDate\": null,\n \"cancellationReason\": \"\"\n }\n ],\n \"invalidTransaction\": [\n {\n \"transactionId\": \"AH000000001\",\n \"batchId\": \"a0fee0f4-812e-4383-b50f-bc944ffbaeeb\",\n \"batchName\": \"BCH00001\",\n \"errorMessage\": \"approved must be 0 (false) or 1 (true). paymentType is missing or invalid. serviceStartDate is not valid! supportItem is not valid!\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\": \"clientNumber\",\n \"paymentType\": \"agendcy-managed\",\n \"registrationNumber\": \"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\": \"programName\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\": \"locationName\",\n \"serviceCode\": \"SC001\",\n \"serviceName\": \"serviceName\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"0000-00-00 00:00:00\",\n \"serviceEndDate\": \"2023-01-01T01:00:00.000Z\",\n \"unit\": \"1\",\n \"rate\": \"100\",\n \"gstApply\": \"false\",\n \"billingName\": \"asda\",\n \"financeDebtorCode\": \"asda\",\n \"billingContact\": \"billingContact\",\n \"billingAddress\": \"billingAddress\",\n \"billingSuburb\": \"billingSuburb\",\n \"billingPostcode\": \"billingPostcode\",\n \"billingState\": \"billingState\",\n \"billingEmail\": \"billingEmail\",\n \"billingPhone\": \"billingPhone\",\n \"billingMobile\": \"billingMobile\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\": \"invoiceDescription\",\n \"approved\": null\n },\n {\n \"transactionId\": \"AH000000001\",\n \"batchId\": \"4d046733-a4ab-4b10-8471-3b0903b6323d\",\n \"batchName\": \"BCH00001\",\n \"errorMessage\": \"approved must be 0 (false) or 1 (true). paymentType is missing or invalid. supportItem is not valid!\",\n \"clientFirstname\": \"John\",\n \"clientLastname\": \"Doe\",\n \"ndisNumber\": \"431234567\",\n \"clientNumber\": \"clientNumber\",\n \"paymentType\": \"agendcy-managed\",\n \"registrationNumber\": \"4050000201\",\n \"programCode\": \"PC001\",\n \"programName\": \"programName\",\n \"programCostcode\": \"CC001\",\n \"locationCode\": \"LC001\",\n \"locationName\": \"locationName\",\n \"serviceCode\": \"SC001\",\n \"serviceName\": \"serviceName\",\n \"supportItem\": \"SI001\",\n \"serviceStartDate\": \"2023-01-01T00:00:00.000Z\",\n \"serviceEndDate\": \"2023-01-01T01:00:00.000Z\",\n \"unit\": \"1\",\n \"rate\": \"100\",\n \"gstApply\": \"false\",\n \"billingName\": \"B-Name\",\n \"financeDebtorCode\": \"FDCode\",\n \"billingContact\": \"billingContact\",\n \"billingAddress\": \"billingAddress\",\n \"billingSuburb\": \"billingSuburb\",\n \"billingPostcode\": \"billingPostcode\",\n \"billingState\": \"billingState\",\n \"billingEmail\": \"billingEmail\",\n \"billingPhone\": \"billingPhone\",\n \"billingMobile\": \"billingMobile\",\n \"claimType\": \"TRAN\",\n \"invoiceDescription\": \"invoice Description\",\n \"approved\": null\n }\n ]\n }\n}"},{"id":"4f63073a-a932-4473-809d-980ec7942891","name":"Item not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/hfiwuhf83fhu"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": \"The transaction is not found!.\"\n}"}],"_postman_id":"da13de27-a340-4d9a-be22-de4b334e4baf"},{"name":"transaction","id":"6e3d8c15-eb51-43fa-8a51-731d66f7f5f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"org-id","value":"","description":"

(Required) 123

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/{customerTransactionId}","description":"

To successfully delete a transaction via the API, the following criteria must be met:

\n
    \n
  1. Error Status Requirement: The customerTransactionId must have an Error status. If the transaction is not in an Error status, the API will not perform any action.
    2. \n
\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}},"urlObject":{"path":["transaction","{customerTransactionId}"],"host":["https://api.quickclaim.io/public"],"query":[],"variable":[]}},"response":[{"id":"0cd42d1b-6ee3-463b-bbc5-d9d1363770c2","name":"Item found","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"x-api-key","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/AH000000001"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": {\n \"customerTransactionId\": \"AH000000001\",\n \"message\": \"Delete request has been successfully completed!\"\n }\n}"},{"id":"d6c5573e-4ff4-4008-972f-29f2652d6df0","name":"Item not found","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"","description":"(Required) 123"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/transaction/hfiwuhf83fhu"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.0.1\",\n \"data\": \"Transaction not found!\"\n}"}],"_postman_id":"6e3d8c15-eb51-43fa-8a51-731d66f7f5f2"}],"id":"9f16aea4-fda5-4b3f-9750-a73d35997c94","_postman_id":"9f16aea4-fda5-4b3f-9750-a73d35997c94","description":"","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":true,"source":{"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab","id":"dc464998-449c-41cb-8212-73d7a793d0ab","name":"Public APIs","type":"folder"}}}],"id":"dc464998-449c-41cb-8212-73d7a793d0ab","description":"

This collection provides enhanced APIs developed by quickclaim to simplify the use of NDIS APIs. It grants access to a range of functionalities utilized in quickclaim's enterprise SaaS software and mobile apps.

\n

How to get on board with the PUBLIC API?

\n

Follow the below steps to create and activate your account:

\n
    \n

  1. Create an account on https://app.quickclaim.io

    \n
    2. \n

  2. Connect your account to PRODA using this article: https://wiki.quickclaim.io/knowledge/connect-to-ndis-api

    \n
    3. \n

  3. Navigate to https://app.quickclaim.io/app/integration and write down your org-id and x-api-key from this page. You need these credentials in all the API calls for authentication.

    \n
    4. \n
\n

Note: Your x-api-key never expires, it's recommended to re-issue the x-api-key every three months.

\n

Authorization

\n

For all quickclaim APIs, you need to provide org-id and x-api-key in the header of the call.
You can get your credentials from quickclaim online app: https://app.quickclaim.io/app/integration.

\n","auth":{"type":"apikey","apikey":{"value":"{{apiKey}}","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b76d85aa-26ab-42cb-bf74-86985b34e11d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"52b29a42-9079-43c5-a70e-4e45fc45c6ef","type":"text/javascript","exec":[""]}}],"_postman_id":"dc464998-449c-41cb-8212-73d7a793d0ab"},{"name":"Digital Invoice","item":[{"name":"webhook","item":[{"name":"Events","item":[{"name":"Invoice ~ CREATE","item":[{"name":"Version - 1","item":[],"id":"41769a9d-bfe0-44f4-bb73-8a97ae1e0016","description":"

Event Category and Type Payload

\n

Invoice - CREATE

\n

This event is generated for your webhook endpoint whenever a new invoice is sent to you. Invoices can be sent to you via email or direct API calls.

\n

Event payload object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
dataObjectSee Data. Contains main invoice object.
metadataObjectSee Metadata. Contains additional information about invoice.
emailObjectSee Email. Contains email details associated with the invoice
\n

Invoice Data object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
fromObjectSee Contact. Contains contact information of invoice sender.
toObjectSee Contact. Contains contact information of invoice recipient.
headerObjectSee Header. Contains invoice number as well as the summary and total values of the line items in the Invoice.
lineItemsObject[] (Collection)See LineItem. The lineItems collection can contain any number of individual lineItem sub-elements.
paymentObjectSee Payment. Bank account Information of the invoice issuer.
\n

Invoice Contact object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
companyNameStringThe company name. Business name is the name your business operates under and shares with its clients.
legalNameStringThe entity name is the name used by a business to enter into contracts and make other legal or administrative commitments
abnNumberThe Australian Business Number is a unique 11-digit identifier issued by the Australian Business Register which is operated by the Australian Taxation Office
addressStringCompany registered location address.
websiteStringCompany public website URL.
phoneStringThe main contact phone number for the company
emailStringA company email dedicated to finance and tax related communications
contactPersonStringThe name of the main contact person in the company
ndisRegistrationNumberStringNDIS provider registration number
quickclaimIdStringQuickclaim’s unique ID for the sender or receiver of an invoice.
\n

Invoice Header object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
invoiceIdStringUnique ID for the digital invoice document.
invoiceNumberStringInvoice Number
referenceStringAdditional reference number
issueDateString (Full-Date)Date invoice was issued – YYYY-MM-DD
dueDateString (Full-Date)Date invoice is due – YYYY-MM-DD
totalAmountExcludingGstNumber (2 decimal points)Total of Invoice GST exclusive (i.e. totalAmountIncludingGst - totalGstAmount)
totalGstAmountNumber (2 decimal points)Total Goods and Services Tax on invoice
totalAmountIncludingGstNumber (2 decimal points)Total of Invoice GST inclusive (i.e. SubTotal)
participantFirstNameString
participantLastNameString
ndisNumberNumber (9 digits, starting in either 43 or 5)
\n

Invoice LineItem object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
lineIdNumberdenotes the transaction order, replicated from the invoice
descriptionStringThe description of the service provided to participant
supportItemStringUnique numerical code, designating the exact support type provided
unitNumber (2 decimal points)Service Unit value
rateNumber (2 decimal points)Service Rate value
amountIncludingGstNumber (2 decimal points)Service Amount (i.e. Unit * Rate)
gstAmountNumber (2 decimal points)Amount of GST charged per transaction
amountExcludingGstNumber (2 decimal points)Service Amount (i.e. Unit * Rate)
serviceStartDateString (ISO-8601 Format)Support delivered start date
serviceEndDateString (ISO-8601 Format)Support delivered end date
\n

Invoice Payment object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
payToStringBank Account Name
bankStringBank name of the issuer of the invoice
bsbStringBank State Branch number
accountNumberStringInvoice issuer’s Account number in the bank
websiteStringInvoice issuer’s website
phoneStringInvoice issuer’s phone number
contactPersonStringThe name of the main contact person in the company
remittanceAdviceEmailString
\n

Invoice Metadata object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
invoiceDocumentUrlStringPre signed temporary URL to download the invoice source file (e.x. pdf)
createdAtString (ISO-8601 Format)Date and time invoice object was created
updatedByString (ISO-8601 Format)Date and time invoice was updated
updatedAtStringUser who last updated the invoice
\n

Invoice Email object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
emailIdStringA uniq id for the email
subjectStringSubject of the email
fromStringEmail used for sending the invoice (from)
bodyStringBody content/text of the invoice (first 1000 characters)
\n

An example of an Invoice Event in JSON format would like below snippet:

\n
{\n  \"documentId\": \"hdow5nd7XAnhH9C66QqMn\",\n  \"category\": \"Invoice\",\n  \"type\": \"CREATE\",\n  \"resourceUrl\": \"https://api.quickclaim.io/mercury/invoices/c402ee45-dbc3-4da3-8318-c9cd3f03207b\",\n  \"resourceId\": \"c402ee45-dbc3-4da3-8318-c9cd3f03207b\",\n  \"eventDispatchDate\": \"2023-01-01T12:10:20.000Z\",\n  \"tenantId\": \"34567\",\n  \"tenantType\": \"Provider\",\n  \"payload\": {\n    \"data\": {\n      \"from\": {\n        \"companyName\": \"quickclaim\",\n        \"legalName\": \"quickclaim pty ltd\",\n        \"abn\": 12345678910,\n        \"address\": \"100 Harris Street, Pyrmont NSW 2009\",\n        \"website\": \"www.quickclaim.io\",\n        \"phone\": \"1300 311 780\",\n        \"email\": \"amir@quickclaim.io\",\n        \"contactPerson\": \"Amir Hosseini\"\n      },\n      \"to\": {\n        \"companyName\": \"quickclaim\",\n        \"legalName\": \"quickclaim pty ltd\",\n        \"abn\": 12345678910,\n        \"address\": \"100 Harris Street, Pyrmont NSW 2009\",\n        \"website\": \"www.quickclaim.io\",\n        \"phone\": \"1300 311 780\",\n        \"email\": \"amir@quickclaim.io\",\n        \"contactPerson\": \"Amir Hosseini\"\n      },\n      \"header\": {\n        \"invoiceId\": \"1234\",\n        \"invoiceNumber\": \"INV-29082023-000123\",\n        \"reference\": \"23894701837408123740\",\n        \"issueDate\": \"2023-05-14\",\n        \"dueDate\": \"2023-06-14\",\n        \"totalAmountExcludingGst\": 1100,\n        \"totalGstAmount\": 120.34,\n        \"totalAmountIncludingGst\": 1200.34,\n        \"participantFullName\": \"Jack Nicholson\",\n        \"ndisNumber\": 437689896\n      },\n      \"lineItems\": [\n        {\n          \"lineId\": \"LI3453453\",\n          \"description\": \"Line Item Description\",\n          \"supportItem\": \"01_011_0107_1_1_T\",\n          \"unit\": 500,\n          \"rate\": 2.5,\n          \"amountExcludingGst\": 1250,\n          \"amountIncludingGst\": 0,\n          \"gstAmount\": 0,\n          \"serviceStartDate\": \"2020-07-14T08:30:00.000\",\n          \"serviceEndDate\": \"2020-07-14T10:30:00.000\"\n        }\n      ],\n      \"payment\": {\n        \"payTo\": \"quickclaim\",\n        \"bank\": \"quickclaim pty ltd\",\n        \"bsb\": 111222,\n        \"accountNumber\": \"12345678910\",\n        \"website\": \"www.quickclaim.io\",\n        \"phone\": \"1300 311 780\",\n        \"contactPerson\": \"Amir Hosseini\",\n        \"remittanceAdviceEmail\": \"\"\n      }\n    },\n    \"metadata\": {\n      \"invoiceDocumentUrl\": \"https://presigned-dynamic-url-to-invoice.com/xyz234234/....\",\n      \"createdAt\": \"2020-07-14T10:30:00.000\",\n      \"updatedBy\": \"2020-07-14T10:30:00.000\",\n      \"updatedAt\": \"User123\"\n    },\n    \"email\": {\n      \"emailId\": \"1241ee45-dbc3-4da3-8318-c9cd3f052525\",\n      \"subject\": \"INV-123\",\n      \"from\": \"abi@pm.com.au\",\n      \"body\": \"Hi There, ......\"\n    }\n  }\n}\n\n
\n","_postman_id":"41769a9d-bfe0-44f4-bb73-8a97ae1e0016","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}},{"name":"Version - 2","item":[],"id":"688c3fa3-2671-4ba7-9999-11aab68a9f2b","description":"

Event Category and Type Payload

\n

Invoice - CREATE

\n

This event is generated for your webhook endpoint whenever a new invoice is sent to you. Invoices can be sent to you via email or direct API calls.

\n

Event payload object

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
dataObjectSee Data. Contains main invoice object.
metadataObjectSee Metadata. Contains additional information about invoice.
emailObjectSee Email. Contains email details associated with the invoice
\n

Invoice data object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
fromObjectSee Contact. Contains contact information of invoice sender.
toObjectSee Contact. Contains contact information of invoice recipient.
headerObjectSee Header. Contains invoice number as well as the summary and total values of the line items in the Invoice.
lineItemsObject[] (Collection)See LineItem. The lineItems collection can contain any number of individual lineItem sub-elements.
paymentObjectSee Payment. Bank account Information of the invoice issuer.
\n

Invoice Contact object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
companyNameStringThe company name. Business name is the name your business operates under and shares with its clients.
legalNameStringThe entity name is the name used by a business to enter into contracts and make other legal or administrative commitments
abnNumberThe Australian Business Number is a unique 11-digit identifier issued by the Australian Business Register which is operated by the Australian Taxation Office
addressStringCompany registered location address.
websiteStringCompany public website URL.
phoneStringThe main contact phone number for the company
emailStringA company email dedicated to finance and tax related communications
contactPersonStringThe name of the main contact person in the company
\n

Invoice Header object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
invoiceIdStringUnique ID for the digital invoice document.
invoiceNumberStringInvoice Number
referenceStringAdditional reference number
issueDateString format(\"DD/MM/YYYY\")Date invoice was issued
dueDateString format(\"DD/MM/YYYY\")Date invoice is due
totalAmountExcludingGstNumberTotal of Invoice GST exclusive (i.e. totalAmountIncludingGst - totalGstAmount)
totalGstAmountNumberTotal Goods and Services Tax on invoice
totalAmountIncludingGstNumberTotal of Invoice GST inclusive (i.e. SubTotal)
participantFirstNameString
participantLastNameString
ndisNumberStringNIDS number of particiapant
\n

Invoice LineItem object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
lineIdNumberdenotes the transaction order, replicated from the invoice
transactionIdStringTransaction Id associated to the line item
descriptionStringThe description of the service provided to participant
supportItemStringUnique numerical code, designating the exact support type provided
ndisClaimTypeStringNDIS claim type
unitNumberService Unit value
rateIncludingGstNumberService Rate value inclusive of GST
gstAmountNumberAmount of GST charged per transaction
amountExcludingGstNumberService Amount GST exclusive
amountIncludingGstNumberService Amount GST Inclusive
serviceStartDateString format(\"DD/MM/YYYY\")Support delivered start date
serviceEndDateString format(\"DD/MM/YYYY\")Support delivered end date
updatedByString (ISO-8601 Format)Timestamp when line was updated
\n

Invoice Payment object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
payToStringBank Account Name
bankStringBank name of the issuer of the invoice
bsbStringBank State Branch number
accountNumberStringInvoice issuer’s Account number in the bank
websiteStringInvoice issuer’s website
phoneStringInvoice issuer’s phone number
contactPersonStringThe name of the main contact person in the company
remittanceAdviceEmailString
\n

Invoice Metadata object model

\n
\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
versionStringPayload version
channelStringSource channel of Inovoice, it can be Email, API , etc
reviewedBooleanIs the invoice manually reviewed (applicable on Email autogenerated ones)
ownerTenantIdStringTenant Id that is owner of the invoice
providerTenantIdStringProvider Id associated to the invoice
pmTenantIdStringPlan-manager Id associated to the invoice
invoiceDocumentUrlStringPre signed temporary URL to download the invoice source file (e.x. pdf)
createdAtString (ISO-8601 Format)Date and time invoice object was created
updatedByString (ISO-8601 Format)Date and time invoice was updated
updatedAtStringUser who last updated the invoice
fileNameStringInvoice source file name
tagsObject (string key-value pairs)Tags associated with the invoice. If the email subject includes key-value pairs formatted as key=value, these pairs will be extracted and used to populate the tags object.
\n

Invoice Email object model

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
emailIdStringA uniq id for the email
subjectStringSubject of the email
fromStringEmail used for sending the invoice (from)
bodyStringBody content/text of the invoice (first 1000 characters)
\n

An example of an Invoice Event in JSON format would like below snippet:

\n
{\n  \"id\": \"abc123XYZ456def789\",\n  \"category\": \"Invoice\",\n  \"type\": \"CREATE\",\n  \"resourceUrl\": \"quickclaim/98765432-abcd-efgh-ijkl-123456789012\",\n  \"resourceId\": \"98765432-abcd-efgh-ijkl-123456789012\",\n  \"eventDispatchDate\": \"2024-12-02T00:42:28.199Z\",\n  \"tenantId\": \"\",\n  \"tenantType\": \"\",\n  \"payload\": {\n    \"metadata\": {\n      \"createdAt\": \"2024-11-24T22:45:46.000Z\",\n      \"updatedBy\": \"google-oauth2|123456789012345678901\",\n      \"providerTenantId\": \"\",\n      \"channel\": \"\",\n      \"reviewed\": false,\n      \"ownerTenantId\": \"tenant123-4567-89ab-cdef-123456789012\",\n      \"version\": \"2\",\n      \"pmTenantId\": \"tenant123-4567-89ab-cdef-123456789012\",\n      \"invoiceDocumentUrl\": \"https://example-storage.s3.ap-southeast-2.amazonaws.com/incoming/files/20241124/sample123456789/Invoice5678_John_Smith.pdf\",\n      \"updatedAt\": \"2024-12-02T00:41:24.000Z\",\n      \"fileName\": \"Invoice5678_John_Smith.pdf\",\n      \"tags\": {}\n    },\n    \"data\": {\n      \"lineItems\": [\n        {\n          \"supportItem\": \"15_617_0128_1_3\",\n          \"gstAmount\": 0,\n          \"unit\": 1.5,\n          \"amountExcludingGst\": 290.99,\n          \"amountIncludingGst\": 290.99,\n          \"serviceStartDate\": \"19/07/2024\",\n          \"ndisClaimType\": \"\",\n          \"updatedBy\": \"\",\n          \"rateIncludingGst\": 193.99,\n          \"lineId\": 1,\n          \"description\": \"Occupational Therapy - 15_617_0128_1_3\",\n          \"transactionId\": \"sample123456789-0-1\",\n          \"serviceEndDate\": \"19/07/2024\"\n        },\n        {\n          \"supportItem\": \"15_617_0128_1_3\",\n          \"gstAmount\": 0,\n          \"unit\": 0.5,\n          \"amountExcludingGst\": 97,\n          \"amountIncludingGst\": 97,\n          \"serviceStartDate\": \"23/07/2024\",\n          \"ndisClaimType\": \"\",\n          \"updatedBy\": \"\",\n          \"rateIncludingGst\": 193.99,\n          \"lineId\": 2,\n          \"description\": \"Occupational Therapy - 15_617_0128_1_3\",\n          \"transactionId\": \"sample123456789-0-2\",\n          \"serviceEndDate\": \"23/07/2024\"\n        },\n        {\n          \"supportItem\": \"15_622_0128_1_3\",\n          \"gstAmount\": 0,\n          \"unit\": 2,\n          \"amountExcludingGst\": 393.98,\n          \"amountIncludingGst\": 393.98,\n          \"serviceStartDate\": \"23/07/2024\",\n          \"ndisClaimType\": \"\",\n          \"updatedBy\": \"google-oauth2|987654321098765432109\",\n          \"rateIncludingGst\": 196.99,\n          \"lineId\": 3,\n          \"description\": \"Speech Pathology - 15_622_0128_1_3\",\n          \"transactionId\": \"sample123456789-0-3\",\n          \"serviceEndDate\": \"23/07/2024\"\n        },\n        {\n          \"supportItem\": \"15_619_0128_1_3\",\n          \"gstAmount\": 0,\n          \"unit\": 1,\n          \"amountExcludingGst\": 195.99,\n          \"amountIncludingGst\": 195.99,\n          \"serviceStartDate\": \"26/07/2024\",\n          \"ndisClaimType\": \"\",\n          \"updatedBy\": \"google-oauth2|987654321098765432109\",\n          \"rateIncludingGst\": 195.99,\n          \"lineId\": 4,\n          \"description\": \"Speech Pathology - 15_622_0128_1_3\",\n          \"transactionId\": \"sample123456789-0-4\",\n          \"serviceEndDate\": \"26/07/2024\"\n        }\n      ],\n      \"header\": {\n        \"reference\": \"\",\n        \"totalAmountIncludingGst\": 977.96,\n        \"participantFirstName\": \"John\",\n        \"ndisNumber\": \"987654321\",\n        \"dueDate\": \"08/08/2024\",\n        \"invoiceNumber\": \"5678\",\n        \"totalGstAmount\": 0,\n        \"invoiceId\": \"sample123456789-0\",\n        \"totalAmountExcludingGst\": 977.96,\n        \"issueDate\": \"31/07/2024\",\n        \"participantLastName\": \"Smith\"\n      },\n      \"from\": {\n        \"legalName\": \"\",\n        \"website\": \"\",\n        \"address\": \"123 Example Street\\nSAMPLE SUBURB\\nVIC 3000\",\n        \"phone\": \"1300 123 456\",\n        \"companyName\": \"Sample Healthcare Services PTY LTD\",\n        \"contactPerson\": \"\",\n        \"abn\": \"12345678901\",\n        \"email\": \"\"\n      },\n      \"payment\": {\n        \"bsb\": \"123456\",\n        \"bank\": \"\",\n        \"website\": \"\",\n        \"remittanceAdviceEmail\": \"\",\n        \"phone\": \"\",\n        \"contactPerson\": \"\",\n        \"payTo\": \"Sample Healthcare Services PTY LTD\",\n        \"accountNumber\": \"12345678\"\n      },\n      \"to\": {\n        \"legalName\": \"\",\n        \"website\": \"\",\n        \"address\": \"123 Example Street\\nSAMPLE SUBURB\\nVIC 3000\",\n        \"phone\": \"\",\n        \"companyName\": \"John Smith\",\n        \"contactPerson\": \"\",\n        \"abn\": \"\",\n        \"email\": \"\"\n      }\n    }\n  }\n}\n\n
\n","_postman_id":"688c3fa3-2671-4ba7-9999-11aab68a9f2b","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}}],"id":"efe9fefa-b739-4ed8-ae50-7dc3dfd9f9ac","_postman_id":"efe9fefa-b739-4ed8-ae50-7dc3dfd9f9ac","description":"","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}}],"id":"5b18a664-914c-450a-ad41-a0dd97a4fa7d","description":"

Introduction

\n

When you configure a webhook URL the following categories of events will be sent to your endpoint. Within each category there are certain types of events that can happen (e.g. create, update)

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event CategoryEvent TypeDescription
InvoiceCREATEA new invoice has been issued for you.
\n

Each event contains shared properties, but has a unique payload object determined by its event Event Category as well as Event Type. The common properties describes the properties shared by all events, and each event category and type describe the payload properties that are unique to the specific event.

\n

Event object common properties

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Event API attribute nameData TypeDescription
documentIdStringUnique identifier for the event.
categoryStringThe Category of event. Events uses PascalCase for the name (See Event Category table above).
typeStringThe type of event. Quickclaim uses ALL CAPS for the value of this attribute (See Event Category table above).
resourceUrlString (URL)The URL to retrieve the resource that has been created, changed, etc.
eventDispatchDateString (ISO-8601 Format)The date and time that event occurred (UTC time)
tenantIdStringThe ID of the tenant that the event happened in relation to (Organisation ID or PlanManger ID)
tenantTypeStringThe type of tenant, depending on the type of event it will be one of Provider (for Contact or Invoice events), or PL/SL (for Remittance events)
payloadObjectThe event payload object is unique to the event category and type. See the event type below for the event API payload object
\n

An example of common Event properties in JSON format would look like below snippet:

\n
{\n  \"documentId\": \"hdow5nd7XAnhH9C66QqMn\",\n  \"category\": \"Invoice\"\n  \"type\": \"CREATE\",\n  \"resourceUrl\": \"https://api.quickclaim.io/mercury/invoices/c402ee45-dbc3-4da3-8318-c9cd3f03207b\",\n  \"resourceId\": \"c402ee45-dbc3-4da3-8318-c9cd3f03207b\",\n  \"eventDispatchDate\": \"2023-01-01T12:10:20.000Z\"\n  \"tenantId\": \"34567\",\n  \"tenantType\": \"Provider\",\n  \"payload\": {\n    ...\n  }\n}\n\n
\n","_postman_id":"5b18a664-914c-450a-ad41-a0dd97a4fa7d","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}},{"name":"Webhook Registration Create","id":"07634184-772d-4df1-96a3-82563a119eee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"tenant-id","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://tenant-owned-domain-url/[...path]\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.di.quickclaim.io/mercury/channels/webhook","description":"

Creates a Webhook notification channel in your organisation. The organisation Webhook channel URL will be set from {{webhookUrl}} within the request body.

\n

The tenant-id header is required for this API and should be set to the unique ID of the organisation.

\n

After creating your Webhook Registration, the endpiont will respond with the signKey key that's assigned to your Webhook configuration:

\n
{\n    \"message\": \"Webhook Registered Successfully\",\n    \"signKey\": \"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBC......\",\n    \"encoding\": \"JSON\"\n}\n\n
\n

Signed payloads in webhooks

\n

Bad actors can intercept messages sent on the internet and change their contents to benefit themselves. To prevent unwanted changes, quickclaim signs your messages before sending them to your endpoint. The sign and verification key pair are issued and saved after completing Webhook registration and the verification key (signKey) will be available for you to download. quickclaim invoice signs all webhook events sent to your endpoints with a signature. This signature appears in each event's X-Quickclaim-Request-Signature header. The message input for generating signature appears in each event's X-Quickclaim-Signed-Input header. This allows you to verify the integrity of the data and the provider's authenticity from which data is coming.

\n

Whenever a webhook is triggered for a specific event, quickclaim generates a signature based on the a selected set of header values and appends it to the X-Quickclaim-Request-Signature header of the HTTP request. The message input is created as the hash value of the following headers:

\n
    \n

  • X-Quickclaim-Event-Resource-ID

    \n
    • \n

  • X-Quickclaim-Request-Timestamp

    \n
    • \n
\n

The values taken from above mentioned headers are joined using semicolon ; and then passed to the hash function to generate based64 encoded hash from the source string.

\n

The quickclaim uses the SHA-512 algorithm and RSA algorithm based on private key to generate webhook signatures and encodes them in base64 format.

\n

Here’s an example signature:

\n

X-Quickclaim-Request-Signature: BQIMHh4VbuCM5tx9OL2ee1k40sXu99tLXIQ88AJ5esSwd45L/b9y...

\n

Depending on the language and runtime environment that you use to receive notifications from quickclaim, you can use library functions to verify the signature using the signKey value for you webhook registration and make sure the API call is initiated from your quickclaim account.

\n","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}},"urlObject":{"path":["mercury","channels","webhook"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"07634184-772d-4df1-96a3-82563a119eee"},{"name":"Webhook Registration Get","id":"ec4dfc88-058f-4c2c-a712-977e491c3139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"tenant-id","value":"","type":"text"}],"url":"https://api.di.quickclaim.io/mercury/channels/webhook","description":"

Returns the current Webhook notification channel configuration that is set in your organisation:

\n
{\n    \"webhookUrl\": \"https://your-webhook-url/...[path]\",\n    \"createdAt\": \"2024-10-08T03:05:16.938Z\",\n    \"modifiedAt\": \"2024-10-08T03:05:16.938Z\",\n    \"signedKeyPair\": {\n        \"publicKey\": \"MIIBIjANBgkqhkiG9w0BAQ.....\"\n    },\n    \"tenantId\": \"your-organisation-id\",\n    \"encoding\": \"JSON\"\n}\n\n
\n

The tenant-id header is required for this API and should be set to the unique ID of the organisation.

\n

If no Webhook notification channel is found for the organisation, the endpoint responds with 404 status code.

\n","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}},"urlObject":{"path":["mercury","channels","webhook"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec4dfc88-058f-4c2c-a712-977e491c3139"},{"name":"Webhook Registration Update","id":"61b30394-6177-4bb4-b54b-5493b457f243","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"tenant-id","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"webhookUrl\": \"https://tenant-owned-domain-url/[...path]\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.di.quickclaim.io/mercury/channels/webhook","description":"

Updates Webhook notification channel in your organisation. The organisation Webhook channel URL will be set from {{webhookUrl}} within the request body.

\n

The tenant-id header is required for this API and should be set to the unique ID of the organisation.

\n","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}},"urlObject":{"path":["mercury","channels","webhook"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"61b30394-6177-4bb4-b54b-5493b457f243"},{"name":"Webhook Registration Delete","id":"37445e17-6eec-4fcc-83ca-99f6071abf20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"tenant-id","value":"","type":"text"}],"url":"https://api.di.quickclaim.io/mercury/channels/webhook","description":"

Deletes the current Webhook notification channel configuration from your organisation:

\n

The tenant-id header is required for this API and should be set to the unique ID of the organisation.

\n","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}},"urlObject":{"path":["mercury","channels","webhook"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"37445e17-6eec-4fcc-83ca-99f6071abf20"}],"id":"86a9e793-4e39-42da-b845-56b0a8dd96d3","_postman_id":"86a9e793-4e39-42da-b845-56b0a8dd96d3","description":"","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}},{"name":"provider","item":[{"name":"List Plan Managers","id":"b4c15937-4597-4d87-8ab7-e835c67abac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"tenant-id","value":"","description":"

Required

\n","type":"text"},{"key":"Authorization","value":"api-key ","description":"

Required

\n","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-managers","description":"

This endpoint retrieves a list of plan managers registered in the QC Invoice platform.

\n

Request

\n

This is a simple HTTP GET request to fetch the list of plan managers.

\n

Response

\n

The response for this request will be a JSON object with the following schema:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"version\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"pmTenantId\": {\n            \"type\": \"string\"\n          },\n          \"companyName\": {\n            \"type\": \"string\"\n          },\n          \"name\": {\n            \"type\": \"string\"\n          },\n          \"legalName\": {\n            \"type\": \"string\"\n          },\n          \"abn\": {\n            \"type\": \"string\"\n          },\n          \"phone\": {\n            \"type\": \"string\"\n          },\n          \"website\": {\n            \"type\": \"string\"\n          },\n          \"email\": {\n            \"type\": \"string\"\n          },\n          \"contactEmail\": {\n            \"type\": \"string\"\n          },\n          \"contactPerson\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n\n
\n","urlObject":{"path":["service-di","plan-managers"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[{"id":"bd9a2d1f-2950-4652-9ee3-044be7e06d9b","name":"A list of plan managers","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"tenant-id","value":"","type":"text"},{"key":"Authorization","value":"api-key ","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"\",\n \"data\": [\n {\n \"pmTenantId\": \"\",\n \"companyName\": \"\",\n \"name\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"phone\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"contactEmail\": \"\",\n \"contactPerson\": \"\"\n },\n {\n \"pmTenantId\": \"\",\n \"companyName\": \"\",\n \"name\": \"\",\n \"legalName\": \"\",\n \"name\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"phone\": \"\",\n \"website\": \"\",\n \"email\": \"\",\n \"contactEmail\": \"\",\n \"contactPerson\": \"\"\n }\n ]\n}"},{"id":"906271df-f863-4553-b305-47c08211d1c8","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"tenant-id","value":"","type":"text"},{"key":"Authorization","value":"api-key ","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-managers"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"688429d6-beaf-416d-8668-39c725981274","name":"Internal Server Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-managers?Content-Type=application/json&tenant-id=&Authorization=api-key ","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-managers"],"query":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"tenant-id","value":"","type":"text"},{"key":"Authorization","value":"api-key ","type":"text"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b4c15937-4597-4d87-8ab7-e835c67abac5"},{"name":"Send Provider Invoice","id":"17a7f701-62a4-4818-a52b-04e599316bd4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"tenant-id","value":"","description":"

(Required) Tenant Id of the provider

\n"},{"key":"pm-tenant-id","value":"","description":"

plan-manager id can can be sent via metadata in the body as well

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"api-key ","description":"

Required

\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"INV-001\",\n \"issueDate\": \"2023-10-01T00:00:00Z\",\n \"participantFirstName\": \"John\",\n \"participantLastName\": \"Doe\",\n \"participantNdisNumber\": \"123456789\"\n },\n \"items\": [\n {\n \"supportItem\": \"Support Item 1\",\n \"rate\": 500.00,\n \"unit\": 2\n }\n ],\n \"payment\": {\n \"bsb\": \"123456\",\n \"accountNumber\": \"12345678\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice","description":"

The HTTP POST request to submit and dispatch an invoice with detailed information to the specified plan-manager webhook (by using pm-tenant-id)

\n

The request body should be in raw JSON format with the follwoing schema:

\n
{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"header\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"invoiceNumber\": { \"type\": \"string\" },\n            \"issueDate\": { \"type\": \"string\", \"format\": \"date-time\" },\n            \"participantFirstName\": { \"type\": \"string\" },\n            \"participantLastName\": { \"type\": \"string\" },\n            \"participantNdisNumber\": { \"type\": \"string\" },\n            \"reference\": { \"type\": \"string\" },\n            \"dueDate\": { \"type\": \"string\", \"format\": \"date-time\" }\n          },\n          \"required\": [\n            \"invoiceNumber\",\n            \"issueDate\",\n            \"participantFirstName\",\n            \"participantLastName\",\n            \"participantNdisNumber\"\n          ]\n        },\n        \"items\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"supportItem\": { \"type\": \"string\" },\n              \"ndisClaimType\": {\n                \"type\": [\"string\", \"null\"],\n                \"enum\": [\"CANC\", \"REPW\", \"TRAN\", \"NF2F\", \"THLT\", \"IRSS\", null]\n              },\n              \"description\": { \"type\": \"string\" },\n              \"unit\": { \"type\": \"number\" },\n              \"rate\": { \"type\": \"number\" },\n              \"gstAmount\": { \"type\": \"number\" },\n              \"serviceStartDate\": { \"type\": \"string\", \"format\": \"date\" },\n              \"serviceEndDate\": { \"type\": \"string\", \"format\": \"date\" }\n            },\n            \"required\": [\n              \"supportItem\",\n              \"unit\",\n              \"rate\"\n            ]\n          }\n        },\n        \"payment\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"bsb\": { \"type\": \"string\" },\n            \"accountNumber\": { \"type\": \"string\" },\n            \"payTo\": { \"type\": \"string\" },\n            \"bank\": { \"type\": \"string\" },\n            \"website\": { \"type\": \"string\" },\n            \"phone\": { \"type\": \"string\" },\n            \"contactPerson\": { \"type\": \"string\" },\n            \"ndisRegistrationNumber\": { \"type\": \"string\" },\n            \"remittanceAdviceEmail\": { \"type\": \"string\" }\n          },\n          \"required\": []\n        }\n      },\n      \"required\": [\"header\", \"items\"]\n    }\n  },\n  \"required\": [\"data\"]\n}\n\n

The response to this request is a JSON object with the following schema:
{
\"invoiceId\": \"\",
\"message\": \"\",
\"payload\": {}
}
Where:

\n
    \n

  • invoiceId (string): The ID of the submitted invoice.

    \n
    • \n

  • message (string): Any additional message related to the submission of the invoice.

    \n
    • \n

  • payload (object): The invoice payload that is being delivered to the planmanager webhook.

    \n
    • \n
\n","urlObject":{"path":["service-di","provider","invoice"],"host":["https://api.di.quickclaim.io"],"query":[],"variable":[]}},"response":[{"id":"11388aa1-b30a-4f38-896b-bf7f0550639e","name":"Successfull - All fields","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api-key ","description":"(Required) ","type":"text"},{"key":"tenant-id","value":"","description":"(Required) Tenant Id of the provider","type":"text"},{"key":"pm-tenant-id","value":"","description":"plan-manager id can can be sent via metadata in the body as well","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"INV-12346\",\n \"reference\": \"REF-12346\",\n \"issueDate\": \"01/10/2023\",\n \"dueDate\":\"31/01/2023\",\n \"participantFirstName\": \"Jane\",\n \"participantLastName\": \"Doe\",\n \"participantNdisNumber\": \"NDIS-67891\"\n },\n \"items\": [\n {\n \"description\": \"Support item 3\",\n \"supportItem\": \"Support-3\",\n \"ndisClaimType\": \"CANC\",\n \"unit\": 1,\n \"rate\": 100,\n \"gstAmount\": 10,\n \"serviceStartDate\": \"2023-01-01\",\n \"serviceEndDate\": \"2023-01-31\"\n },\n {\n \"supportItem\": \"Support-4\",\n \"unit\": 2,\n \"rate\": 200\n }\n ],\n \"payment\": {\n \"payTo\": \"Pay To\",\n \"bank\": \"Bank\",\n \"bsb\": \"BSB\",\n \"accountNumber\": \"Account Number\",\n \"website\": \"https://payment.com\",\n \"phone\": \"1234567890\",\n \"contactPerson\": \"Payment Contact\",\n \"ndisRegistrationNumber\": \"NDIS-789\",\n \"remittanceAdviceEmail\": \"remittance@payment.com\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx\",\n \"message\": \"📤✅ Invoice(API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx) has been accepted and currently being processed for delivery to Plan Manager (qca4c110-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx)\",\n \"payload\": {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"API\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"9e3b7f98-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"providerTenantId\": \"9e3b7f98-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"pmTenantId\": \"qca4c110-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"createdAt\": \"2024-10-31T06:20:29.000Z\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"test578\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"to\": {\n \"companyName\": \"PM QuickClaim\",\n \"legalName\": \"Legal Name121\",\n \"abn\": \"12313232\",\n \"address\": \"\",\n \"website\": \"quickclaim.io\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"111\"\n },\n \"header\": {\n \"invoiceId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx\",\n \"invoiceNumber\": \"INV-12346\",\n \"reference\": \"REF-12346\",\n \"issueDate\": \"01/10/2023\",\n \"dueDate\": \"31/01/2023\",\n \"totalAmountExcludingGst\": 500,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 500,\n \"participantFirstName\": \"John\",\n \"participantLastName\": \"Doe\",\n \"ndisNumber\": \"123456789\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx-1\",\n \"serviceStartDate\": \"2023-01-01\",\n \"serviceEndDate\": \"2023-01-31\",\n \"description\": \"Support item 3\",\n \"supportItem\": \"Support-3\",\n \"ndisClaimType\": \"CANC\",\n \"unit\": 1,\n \"rate\": 100,\n \"amountExcludingGst\": 100,\n \"gstAmount\": 0,\n \"updatedBy\": \"\"\n },\n {\n \"lineId\": 2,\n \"transactionId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx-2\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\",\n \"description\": \"\",\n \"supportItem\": \"Support-4\",\n \"ndisClaimType\": \"\",\n \"unit\": 2,\n \"rate\": 200,\n \"amountExcludingGst\": 400,\n \"gstAmount\": 0,\n \"updatedBy\": \"\"\n }\n ],\n \"payment\": {\n \"payTo\": \"Pay To\",\n \"bank\": \"Bank\",\n \"bsb\": \"BSB\",\n \"accountNumber\": \"Account Number\",\n \"website\": \"https://payment.com\",\n \"phone\": \"1234567890\",\n \"contactPerson\": \"Payment Contact\",\n \"ndisRegistrationNumber\": \"NDIS-789\",\n \"remittanceAdviceEmail\": \"remittance@payment.com\"\n }\n }\n }\n}"},{"id":"f5769547-1b04-41a6-bc07-1536b7525d7b","name":"Successful - Required fieds","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"api-key ","description":"(Required) ","type":"text"},{"key":"tenant-id","value":"","description":"(Required) Tenant Id of the provider","type":"text"},{"key":"pm-tenant-id","value":"","description":"plan-manager id can can be sent via metadata in the body as well","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"INV-001\",\n \"issueDate\": \"01/10/2023\",\n \"participantFirstName\": \"John\",\n \"participantLastName\": \"Doe\",\n \"participantNdisNumber\": \"123456789\"\n },\n \"items\": [\n {\n \"supportItem\": \"Support Item 1\",\n \"rate\": 500.00,\n \"unit\": 2\n }\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"invoiceId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx\",\n \"message\": \"📤✅ Invoice(API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx) has been accepted and currently being processed for delivery to Plan Manager (qca4c110-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx)\",\n \"payload\": {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"API\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"9e3b7f98-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"providerTenantId\": \"9e3b7f98-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"pmTenantId\": \"qca4c110-xxxx-xxxx-xxxx-xxxxxxxxxxxxxxx\",\n \"createdAt\": \"2024-10-31T06:20:29.000Z\",\n \"updatedAt\": \"\",\n \"updatedBy\": \"\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"test578\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"to\": {\n \"companyName\": \"PM QuickClaim\",\n \"legalName\": \"Legal Name121\",\n \"abn\": \"12313232\",\n \"address\": \"\",\n \"website\": \"quickclaim.io\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"111\"\n },\n \"header\": {\n \"invoiceId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx\",\n \"invoiceNumber\": \"INV-001\",\n \"reference\": \"\",\n \"issueDate\": \"01/10/2023\",\n \"dueDate\": \"\",\n \"totalAmountExcludingGst\": 1000,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 1000,\n \"participantFirstName\": \"John\",\n \"participantLastName\": \"Doe\",\n \"ndisNumber\": \"123456789\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"API-xxxxxxxxxx-xxxxxx-xxxxxx-xxxxx-xxxxxxxxxxxx-1\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\",\n \"description\": \"\",\n \"supportItem\": \"Support Item 1\",\n \"ndisClaimType\": \"\",\n \"unit\": 2,\n \"rate\": 500,\n \"amountExcludingGst\": 1000,\n \"gstAmount\": 0,\n \"updatedBy\": \"\"\n }\n ],\n \"payment\": {\n \"payTo\": \"\",\n \"bank\": \"\",\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"\"\n }\n }\n }\n}"},{"id":"290dc5c0-8c7a-4298-bb8a-cec3d4aabccd","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"tenant-id","value":"","description":"(Required) Tenant Id of the provider"},{"key":"pm-tenant-id","value":"","description":"plan-manager id can can be sent via metadata in the body as well"},{"key":"Authorization","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"\",\n \"issueDate\": \"\",\n \"totalAmountIncludingGst\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\",\n \"participantNdisNumber\": \"\",\n \"reference\": \"\",\n \"dueDate\": \"\",\n \"totalAmountExcludingGst\": \"\",\n \"totalGstAmount\": \"\"\n },\n \"items\": [\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n },\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n }\n ],\n \"payment\": {\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"payTo\": \"\",\n \"bank\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"remittanceAdviceEmail\": \"\"\n },\n \"from\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n },\n \"to\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n }\n },\n \"metadata\": {\n \"messageContent\": \"\",\n \"messageSubject\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d3dbdcc1-5bd0-45cd-a0a3-6a9d1a2b6781","name":"Either tenantId, pmOrgTenantId not found","originalRequest":{"method":"POST","header":[{"key":"tenant-id","value":"","description":"(Required) Tenant Id of the provider"},{"key":"pm-tenant-id","value":"","description":"plan-manager id can can be sent via metadata in the body as well"},{"key":"Authorization","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"\",\n \"issueDate\": \"\",\n \"totalAmountIncludingGst\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\",\n \"participantNdisNumber\": \"\",\n \"reference\": \"\",\n \"dueDate\": \"\",\n \"totalAmountExcludingGst\": \"\",\n \"totalGstAmount\": \"\"\n },\n \"items\": [\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n },\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n }\n ],\n \"payment\": {\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"payTo\": \"\",\n \"bank\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"remittanceAdviceEmail\": \"\"\n },\n \"from\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n },\n \"to\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n }\n },\n \"metadata\": {\n \"messageContent\": \"\",\n \"messageSubject\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice"},"status":"Not Found","code":404,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3237d948-b07b-46f1-9412-71aeaaaad482","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"tenant-id","value":"","description":"(Required) Tenant Id of the provider"},{"key":"pm-tenant-id","value":"","description":"plan-manager id can can be sent via metadata in the body as well"},{"key":"Authorization","value":"","description":"(Required) "},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"header\": {\n \"invoiceNumber\": \"\",\n \"issueDate\": \"\",\n \"totalAmountIncludingGst\": \"\",\n \"participantFirstName\": \"\",\n \"participantLastName\": \"\",\n \"participantNdisNumber\": \"\",\n \"reference\": \"\",\n \"dueDate\": \"\",\n \"totalAmountExcludingGst\": \"\",\n \"totalGstAmount\": \"\"\n },\n \"items\": [\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n },\n {\n \"supportItem\": \"\",\n \"amountIncludingGst\": \"\",\n \"description\": \"\",\n \"unit\": \"\",\n \"rate\": \"\",\n \"amountExcludingGst\": \"\",\n \"gstAmount\": \"\",\n \"serviceStartDate\": \"\",\n \"serviceEndDate\": \"\"\n }\n ],\n \"payment\": {\n \"bsb\": \"\",\n \"accountNumber\": \"\",\n \"payTo\": \"\",\n \"bank\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"remittanceAdviceEmail\": \"\"\n },\n \"from\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n },\n \"to\": {\n \"companyName\": \"\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\",\n \"ndisRegistrationNumber\": \"\",\n \"quickclaimId\": \"\"\n }\n },\n \"metadata\": {\n \"messageContent\": \"\",\n \"messageSubject\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.di.quickclaim.io/service-di/provider/invoice"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"17a7f701-62a4-4818-a52b-04e599316bd4"},{"name":"List Invoices","id":"b6aa072e-1a78-47e1-9205-fd565e0e239a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"tenant-id","value":"","description":"

Required (provider tenant ID)

\n","type":"text"},{"key":"Authorization","value":"apikey ","description":"

Required

\n","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/provider/invoices","description":"

Retrieve a list of invoices for the Provider.

\n","urlObject":{"path":["service-di","provider","invoices"],"host":["https://api.di.quickclaim.io"],"query":[{"disabled":true,"description":{"content":"

Filter by specific invoice ID

\n","type":"text/plain"},"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8"},{"disabled":true,"description":{"content":"

Filter by sent status

\n","type":"text/plain"},"key":"isSent","value":"true"},{"disabled":true,"description":{"content":"

Filter invoices created after this date

\n","type":"text/plain"},"key":"createdAfter","value":"2024-09-11"},{"disabled":true,"description":{"content":"

Filter invoices created before this date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"disabled":true,"description":{"content":"

Filter by tags

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Page number (used if more than 100 invoices is filtered)

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"e0c1dcdb-eafe-476b-b668-ba802ea93335","name":"no-filter-pagination","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?page=2","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8","description":"Filter by specific invoice ID","disabled":true},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags","value":"","description":"Filter by tags","disabled":true},{"key":"page","value":"2","description":"Page number (used if more than 100 invoices is filtered)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 03:20:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1336"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1228a344-a2c9-4c10-b15e-f03b5be5a544"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BeWLEHpzywMEO4A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c03e0-7754c9ac7d06bd342770e8d8;Parent=1afa23ded3cfea96;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:44.000Z\",\n \"updatedAt\": \"2024-11-11T02:45:51.000Z\",\n \"updatedBy\": \"google-oauth2|10175866826021002542\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"Pa Centre\",\n \"legalName\": \"\",\n \"abn\": \"1111111111\",\n \"address\": \"7 st VIC 3019\",\n \"website\": \"\",\n \"phone\": \"03 0000000\",\n \"email\": \"\",\n \"contactPerson\": \"John Wick\"\n },\n \"to\": {\n \"companyName\": \"NowSome Plan Management\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"7 stVIC 3019\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"Miss She\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8\",\n \"invoiceNumber\": \"241003\",\n \"reference\": \"\",\n \"issueDate\": \"03/10/2024\",\n \"dueDate\": \"05/10/2024\",\n \"totalAmountExcludingGst\": 191.99,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 191.99,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Him\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8-1\",\n \"serviceStartDate\": \"20/01/2003\",\n \"serviceEndDate\": \"20/01/2003\",\n \"description\": \"Physiotherapy Consultation\",\n \"supportItem\": \"01_010_0107_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 191.99,\n \"amountExcludingGst\": 191.99,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|10175866826021002542\"\n }\n ],\n \"payment\": {\n \"payTo\": \"Dentelitst\",\n \"bank\": \"National Australia Bank\",\n \"bsb\": \"083170\",\n \"accountNumber\": \"11111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"\"\n }\n }\n },\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:50.000Z\",\n \"updatedAt\": \"2024-11-11T02:37:46.000Z\",\n \"updatedBy\": \"google-oauth2|10376475039272640424\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"MRI THERAPY PTY LTD\",\n \"legalName\": \"MRI THERAPY PTY LTD\",\n \"abn\": \"1111111111111\",\n \"address\": \"101 st VIC 3083\",\n \"website\": \"\",\n \"phone\": \"0491 999 999\",\n \"email\": \"accounts@mri.org\",\n \"contactPerson\": \"Mr M Ri\"\n },\n \"to\": {\n \"companyName\": \"Many Round Ilness\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-9\",\n \"invoiceNumber\": \"INV-001126\",\n \"reference\": \"\",\n \"issueDate\": \"20/01/2002\",\n \"dueDate\": \"20/01/2007\",\n \"totalAmountExcludingGst\": 245.98,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 245.98,\n \"participantFirstName\": \"Parwan\",\n \"participantLastName\": \"Parwan\",\n \"ndisNumber\": \"431111111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-9-1\",\n \"serviceStartDate\": \"20/01/2002\",\n \"serviceEndDate\": \"20/01/2002\",\n \"description\": \"2 Oct 2024, 60 minutes, Specialist Behavioural Intervention Support (Non-Face-To-Face) (Behaviour Support - reports) Specialist Behavioural\\nIntervention Support - \\nThis is to assist participants manage or reduce\\nbehaviours of concern. reports writing\",\n \"supportItem\": \"11_022_0110_7_3\",\n \"ndisClaimType\": \"\",\n \"unit\": 2,\n \"rate\": 122.99,\n \"amountExcludingGst\": 245.98,\n \"gstAmount\": 0,\n \"updatedBy\": \"\"\n }\n ],\n \"payment\": {\n \"payTo\": \"MRI PTY LTD\",\n \"bank\": \"063 765\",\n \"bsb\": \"111111111\",\n \"accountNumber\": \"111111111\",\n \"website\": \"\",\n \"phone\": \"0493 999 999\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"accounts@mri.org\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 2,\n \"totalPages\": 2,\n \"totalInvoices\": 102,\n \"pageSize\": 2,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {}\n }\n}"},{"id":"ac42566b-3b78-4b58-a88f-12bcb5bbad3f","name":"filter-by-id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?invoiceId=vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","description":"Filter by specific invoice ID"},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags","value":"","description":"Filter by tags","disabled":true},{"key":"page","value":"1","description":"Page number (used if more than 100 invoices is filtered)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 03:32:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"873"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4075f97c-b856-4ab4-a092-4b99b5c7609c"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BeYATEPrSwMEQzA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c06ce-48f748d41f763f9050cbf202;Parent=196c8cb5d2f28bbe;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:44.000Z\",\n \"updatedAt\": \"2024-11-11T02:45:51.000Z\",\n \"updatedBy\": \"google-oauth2|10175866826021002542\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"Pa Centre\",\n \"legalName\": \"\",\n \"abn\": \"1111111111\",\n \"address\": \"7 st VIC 3019\",\n \"website\": \"\",\n \"phone\": \"03 0000000\",\n \"email\": \"\",\n \"contactPerson\": \"John Wick\"\n },\n \"to\": {\n \"companyName\": \"NowSome Plan Management\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"7 stVIC 3019\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"Miss She\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z\",\n \"invoiceNumber\": \"241003\",\n \"reference\": \"\",\n \"issueDate\": \"03/10/2024\",\n \"dueDate\": \"05/10/2024\",\n \"totalAmountExcludingGst\": 191.99,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 191.99,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Him\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8-1\",\n \"serviceStartDate\": \"20/01/2003\",\n \"serviceEndDate\": \"20/01/2003\",\n \"description\": \"Physiotherapy Consultation\",\n \"supportItem\": \"01_010_0107_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 191.99,\n \"amountExcludingGst\": 191.99,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|10175866826021002542\"\n }\n ],\n \"payment\": {\n \"payTo\": \"Dentelitst\",\n \"bank\": \"National Australia Bank\",\n \"bsb\": \"083170\",\n \"accountNumber\": \"11111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalInvoices\": 1,\n \"pageSize\": 1,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {}\n }\n}"},{"id":"a3e0bbde-43d3-4535-8950-85c7bcfaafdb","name":"filter-by-tags","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?tags[freshdesk]=1180","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","description":"Filter by specific invoice ID","disabled":true},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags[freshdesk]","value":"1180","description":"Filter by tags"},{"key":"page","value":"1","description":"Page number (used if more than 100 invoices is filtered)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 04:25:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1030"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4244605f-bba4-4575-bdab-00b3599fcb2d"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BefyMGE5ywMEkzw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c1340-1ea794213a6239750d1d4bf0;Parent=7165979382e29f11;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"EMAIL\",\n \"reviewed\": true,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-14T04:34:56.000Z\",\n \"updatedAt\": \"2024-11-11T02:32:20.000Z\",\n \"updatedBy\": \"google-oauth2|101758668260210025428\",\n \"tags\": {\n \"freshdesk\": \"1180\"\n }\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"SoSafe Transport Australia\",\n \"legalName\": \"SoSafe Transport Australia\",\n \"abn\": \"1111111111\",\n \"address\": \"SOSAFE is a registered \\norganisation.\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"finance@sosafaitis.org.au\",\n \"contactPerson\": \"\"\n },\n \"to\": {\n \"companyName\": \"Josh Smith\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"header\": {\n \"invoiceId\": \"phd2xxxxxxxxxxxx-x\",\n \"invoiceNumber\": \"SSA-1111\",\n \"reference\": \"He Luook 4311111111\",\n \"issueDate\": \"25/09/2024\",\n \"dueDate\": \"09/10/2024\",\n \"totalAmountExcludingGst\": 999.12,\n \"totalGstAmount\": 6,\n \"totalAmountIncludingGst\": 1005.12,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Luook\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"phdxxxxxxxxxxxxxxxxxxxxx-x-1\",\n \"serviceStartDate\": \"12/09/2024\",\n \"serviceEndDate\": \"12/09/2024\",\n \"description\": \"12-09-2024 Access Community Social\\nAnd Rec Activities - Weekday Daytime\",\n \"supportItem\": \"04_104_0125_6_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 13,\n \"rate\": 65.56,\n \"amountExcludingGst\": 852.28,\n \"gstAmount\": 4,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n },\n {\n \"lineId\": 2,\n \"transactionId\": \"phxxxxxxxxxxxxxxxxxxxx-2\",\n \"serviceStartDate\": \"03/10/2024\",\n \"serviceEndDate\": \"10/10/2024\",\n \"description\": \"Activity Based Transport (PER KM)wew\",\n \"supportItem\": \"04_403_0104_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 26,\n \"rate\": 3,\n \"amountExcludingGst\": 78,\n \"gstAmount\": 2,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n },\n {\n \"lineId\": 3,\n \"transactionId\": \"phdxxxxxxxxxxxxxxxxxxxx-0-3\",\n \"serviceStartDate\": \"19/09/2024\",\n \"serviceEndDate\": \"19/09/2024\",\n \"description\": \"19-09-2024 Access Community Social\\nAnd Rec Activities - Weekday Daytime\",\n \"supportItem\": \"04_104_0125_6_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 69.56,\n \"amountExcludingGst\": 69.56,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n }\n ],\n \"payment\": {\n \"payTo\": \"SoSafe Australiaewew\",\n \"bank\": \"\",\n \"bsb\": \"63000000\",\n \"accountNumber\": \"1111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"finance@sosfafeits.org.au\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalInvoices\": 1,\n \"pageSize\": 1,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {\n \"freshdesk\": \"1180\"\n }\n }\n}"}],"_postman_id":"b6aa072e-1a78-47e1-9205-fd565e0e239a"}],"id":"a786af78-c963-487e-ac85-8e5915ac0e07","_postman_id":"a786af78-c963-487e-ac85-8e5915ac0e07","description":"","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":true,"source":{"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476","id":"42c6f20a-522c-4109-b7be-1089f4717476","name":"Digital Invoice","type":"folder"}}},{"name":"plan-manager","item":[{"name":"List Invoices","id":"1dbc41ca-8085-4bf7-be51-987df0d0d43d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"tenant-id","value":"","description":"

Required (plan-manager tenant ID)

\n","type":"text"},{"key":"Authorization","value":"apikey ","description":"

Required

\n","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-manager/invoices","description":"

Retrieve a list of invoices for the Plan Manager.

\n","urlObject":{"path":["service-di","plan-manager","invoices"],"host":["https://api.di.quickclaim.io"],"query":[{"disabled":true,"description":{"content":"

Filter by specific invoice ID

\n","type":"text/plain"},"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8"},{"disabled":true,"description":{"content":"

Filter by sent status

\n","type":"text/plain"},"key":"isSent","value":"true"},{"disabled":true,"description":{"content":"

Filter invoices created after this date

\n","type":"text/plain"},"key":"createdAfter","value":"2024-09-11"},{"disabled":true,"description":{"content":"

Filter invoices created before this date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"disabled":true,"description":{"content":"

Filter by tags

\n","type":"text/plain"},"key":"tags","value":""},{"disabled":true,"description":{"content":"

Page number (used if more than 100 invoices is filtered)

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"390380f4-5b27-419d-9f19-2630b2151d58","name":"no-filter-pagination","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?page=2","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8","description":"Filter by specific invoice ID","disabled":true},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags","value":"","description":"Filter by tags","disabled":true},{"key":"page","value":"2","description":"Page number (used if more than 100 invoices is filtered)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 03:20:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1336"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1228a344-a2c9-4c10-b15e-f03b5be5a544"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BeWLEHpzywMEO4A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c03e0-7754c9ac7d06bd342770e8d8;Parent=1afa23ded3cfea96;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:44.000Z\",\n \"updatedAt\": \"2024-11-11T02:45:51.000Z\",\n \"updatedBy\": \"google-oauth2|10175866826021002542\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"Pa Centre\",\n \"legalName\": \"\",\n \"abn\": \"1111111111\",\n \"address\": \"7 st VIC 3019\",\n \"website\": \"\",\n \"phone\": \"03 0000000\",\n \"email\": \"\",\n \"contactPerson\": \"John Wick\"\n },\n \"to\": {\n \"companyName\": \"NowSome Plan Management\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"7 stVIC 3019\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"Miss She\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8\",\n \"invoiceNumber\": \"241003\",\n \"reference\": \"\",\n \"issueDate\": \"03/10/2024\",\n \"dueDate\": \"05/10/2024\",\n \"totalAmountExcludingGst\": 191.99,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 191.99,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Him\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8-1\",\n \"serviceStartDate\": \"20/01/2003\",\n \"serviceEndDate\": \"20/01/2003\",\n \"description\": \"Physiotherapy Consultation\",\n \"supportItem\": \"01_010_0107_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 191.99,\n \"amountExcludingGst\": 191.99,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|10175866826021002542\"\n }\n ],\n \"payment\": {\n \"payTo\": \"Dentelitst\",\n \"bank\": \"National Australia Bank\",\n \"bsb\": \"083170\",\n \"accountNumber\": \"11111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"\"\n }\n }\n },\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:50.000Z\",\n \"updatedAt\": \"2024-11-11T02:37:46.000Z\",\n \"updatedBy\": \"google-oauth2|10376475039272640424\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"MRI THERAPY PTY LTD\",\n \"legalName\": \"MRI THERAPY PTY LTD\",\n \"abn\": \"1111111111111\",\n \"address\": \"101 st VIC 3083\",\n \"website\": \"\",\n \"phone\": \"0491 999 999\",\n \"email\": \"accounts@mri.org\",\n \"contactPerson\": \"Mr M Ri\"\n },\n \"to\": {\n \"companyName\": \"Many Round Ilness\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-9\",\n \"invoiceNumber\": \"INV-001126\",\n \"reference\": \"\",\n \"issueDate\": \"20/01/2002\",\n \"dueDate\": \"20/01/2007\",\n \"totalAmountExcludingGst\": 245.98,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 245.98,\n \"participantFirstName\": \"Parwan\",\n \"participantLastName\": \"Parwan\",\n \"ndisNumber\": \"431111111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-9-1\",\n \"serviceStartDate\": \"20/01/2002\",\n \"serviceEndDate\": \"20/01/2002\",\n \"description\": \"2 Oct 2024, 60 minutes, Specialist Behavioural Intervention Support (Non-Face-To-Face) (Behaviour Support - reports) Specialist Behavioural\\nIntervention Support - \\nThis is to assist participants manage or reduce\\nbehaviours of concern. reports writing\",\n \"supportItem\": \"11_022_0110_7_3\",\n \"ndisClaimType\": \"\",\n \"unit\": 2,\n \"rate\": 122.99,\n \"amountExcludingGst\": 245.98,\n \"gstAmount\": 0,\n \"updatedBy\": \"\"\n }\n ],\n \"payment\": {\n \"payTo\": \"MRI PTY LTD\",\n \"bank\": \"063 765\",\n \"bsb\": \"111111111\",\n \"accountNumber\": \"111111111\",\n \"website\": \"\",\n \"phone\": \"0493 999 999\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"accounts@mri.org\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 2,\n \"totalPages\": 2,\n \"totalInvoices\": 102,\n \"pageSize\": 2,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {}\n }\n}"},{"id":"f50ad20b-a837-48f1-9601-3f8c30152127","name":"filter-by-id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?invoiceId=vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","description":"Filter by specific invoice ID"},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags","value":"","description":"Filter by tags","disabled":true},{"key":"page","value":"1","description":"Page number (used if more than 100 invoices is filtered)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 03:32:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"873"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4075f97c-b856-4ab4-a092-4b99b5c7609c"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BeYATEPrSwMEQzA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c06ce-48f748d41f763f9050cbf202;Parent=196c8cb5d2f28bbe;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"\",\n \"reviewed\": false,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-10T10:17:44.000Z\",\n \"updatedAt\": \"2024-11-11T02:45:51.000Z\",\n \"updatedBy\": \"google-oauth2|10175866826021002542\",\n \"tags\": {}\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"Pa Centre\",\n \"legalName\": \"\",\n \"abn\": \"1111111111\",\n \"address\": \"7 st VIC 3019\",\n \"website\": \"\",\n \"phone\": \"03 0000000\",\n \"email\": \"\",\n \"contactPerson\": \"John Wick\"\n },\n \"to\": {\n \"companyName\": \"NowSome Plan Management\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"7 stVIC 3019\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"Miss She\"\n },\n \"header\": {\n \"invoiceId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z\",\n \"invoiceNumber\": \"241003\",\n \"reference\": \"\",\n \"issueDate\": \"03/10/2024\",\n \"dueDate\": \"05/10/2024\",\n \"totalAmountExcludingGst\": 191.99,\n \"totalGstAmount\": 0,\n \"totalAmountIncludingGst\": 191.99,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Him\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8-1\",\n \"serviceStartDate\": \"20/01/2003\",\n \"serviceEndDate\": \"20/01/2003\",\n \"description\": \"Physiotherapy Consultation\",\n \"supportItem\": \"01_010_0107_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 191.99,\n \"amountExcludingGst\": 191.99,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|10175866826021002542\"\n }\n ],\n \"payment\": {\n \"payTo\": \"Dentelitst\",\n \"bank\": \"National Australia Bank\",\n \"bsb\": \"083170\",\n \"accountNumber\": \"11111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalInvoices\": 1,\n \"pageSize\": 1,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {}\n }\n}"},{"id":"0bd0d96c-fef4-4cd6-b115-a010aff317ff","name":"filter-by-tags","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoices?tags[freshdesk]=1180","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoices"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","description":"Filter by specific invoice ID","disabled":true},{"key":"isSent","value":"true","description":"Filter by sent status","disabled":true},{"key":"createdAfter","value":"2024-09-11","description":"Filter invoices created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter invoices created before this date","disabled":true},{"key":"tags[freshdesk]","value":"1180","description":"Filter by tags"},{"key":"page","value":"1","description":"Page number (used if more than 100 invoices is filtered)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 04:25:37 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1030"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4244605f-bba4-4575-bdab-00b3599fcb2d"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BefyMGE5ywMEkzw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c1340-1ea794213a6239750d1d4bf0;Parent=7165979382e29f11;Sampled=0;Lineage=2:a5a5ddc9:0"}],"cookie":[],"responseTime":null,"body":"{\n \"payloads\": [\n {\n \"metadata\": {\n \"version\": \"2\",\n \"channel\": \"EMAIL\",\n \"reviewed\": true,\n \"invoiceDocumentUrl\": \"\",\n \"ownerTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"providerTenantId\": \"\",\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"createdAt\": \"2024-10-14T04:34:56.000Z\",\n \"updatedAt\": \"2024-11-11T02:32:20.000Z\",\n \"updatedBy\": \"google-oauth2|101758668260210025428\",\n \"tags\": {\n \"freshdesk\": \"1180\"\n }\n },\n \"data\": {\n \"from\": {\n \"companyName\": \"SoSafe Transport Australia\",\n \"legalName\": \"SoSafe Transport Australia\",\n \"abn\": \"1111111111\",\n \"address\": \"SOSAFE is a registered \\norganisation.\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"finance@sosafaitis.org.au\",\n \"contactPerson\": \"\"\n },\n \"to\": {\n \"companyName\": \"Josh Smith\",\n \"legalName\": \"\",\n \"abn\": \"\",\n \"address\": \"\",\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\",\n \"contactPerson\": \"\"\n },\n \"header\": {\n \"invoiceId\": \"phd2xxxxxxxxxxxx-x\",\n \"invoiceNumber\": \"SSA-1111\",\n \"reference\": \"He Luook 4311111111\",\n \"issueDate\": \"25/09/2024\",\n \"dueDate\": \"09/10/2024\",\n \"totalAmountExcludingGst\": 999.12,\n \"totalGstAmount\": 6,\n \"totalAmountIncludingGst\": 1005.12,\n \"participantFirstName\": \"He\",\n \"participantLastName\": \"Luook\",\n \"ndisNumber\": \"4311111111\"\n },\n \"lineItems\": [\n {\n \"lineId\": 1,\n \"transactionId\": \"phdxxxxxxxxxxxxxxxxxxxxx-x-1\",\n \"serviceStartDate\": \"12/09/2024\",\n \"serviceEndDate\": \"12/09/2024\",\n \"description\": \"12-09-2024 Access Community Social\\nAnd Rec Activities - Weekday Daytime\",\n \"supportItem\": \"04_104_0125_6_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 13,\n \"rate\": 65.56,\n \"amountExcludingGst\": 852.28,\n \"gstAmount\": 4,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n },\n {\n \"lineId\": 2,\n \"transactionId\": \"phxxxxxxxxxxxxxxxxxxxx-2\",\n \"serviceStartDate\": \"03/10/2024\",\n \"serviceEndDate\": \"10/10/2024\",\n \"description\": \"Activity Based Transport (PER KM)wew\",\n \"supportItem\": \"04_403_0104_1_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 26,\n \"rate\": 3,\n \"amountExcludingGst\": 78,\n \"gstAmount\": 2,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n },\n {\n \"lineId\": 3,\n \"transactionId\": \"phdxxxxxxxxxxxxxxxxxxxx-0-3\",\n \"serviceStartDate\": \"19/09/2024\",\n \"serviceEndDate\": \"19/09/2024\",\n \"description\": \"19-09-2024 Access Community Social\\nAnd Rec Activities - Weekday Daytime\",\n \"supportItem\": \"04_104_0125_6_1\",\n \"ndisClaimType\": \"\",\n \"unit\": 1,\n \"rate\": 69.56,\n \"amountExcludingGst\": 69.56,\n \"gstAmount\": 0,\n \"updatedBy\": \"google-oauth2|101758668260210025428\"\n }\n ],\n \"payment\": {\n \"payTo\": \"SoSafe Australiaewew\",\n \"bank\": \"\",\n \"bsb\": \"63000000\",\n \"accountNumber\": \"1111111111\",\n \"website\": \"\",\n \"phone\": \"\",\n \"contactPerson\": \"\",\n \"remittanceAdviceEmail\": \"finance@sosfafeits.org.au\"\n }\n }\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalInvoices\": 1,\n \"pageSize\": 1,\n \"pmTenantId\": \"qca4c110-5afc-4c09-9208-6ad218298c16\",\n \"tags\": {\n \"freshdesk\": \"1180\"\n }\n }\n}"}],"_postman_id":"1dbc41ca-8085-4bf7-be51-987df0d0d43d"},{"name":"List Messages","id":"b122dcd6-3b59-46b0-ab1f-da3f084ffd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"

Tenant Id of the provider

\n","type":"text"},{"key":"tenant-id","value":"","description":"

Required (plan-manager tenant ID)

\n","type":"text"},{"key":"Authorization","value":"api-key ","description":"

Required

\n","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-manager/messages","description":"

Retrieve a list of messages for the Plan Manager.

\n","urlObject":{"path":["service-di","plan-manager","messages"],"host":["https://api.di.quickclaim.io"],"query":[{"disabled":true,"description":{"content":"

Filter by specific message ID

\n","type":"text/plain"},"key":"messageId","value":""},{"disabled":true,"description":{"content":"

Filter by channel (EMAIL or API)

\n","type":"text/plain"},"key":"channel","value":"EMAIL"},{"disabled":true,"description":{"content":"

Filter by sender's email

\n","type":"text/plain"},"key":"from","value":"info@quickclaim.io"},{"disabled":true,"description":{"content":"

Filter by subject content

\n","type":"text/plain"},"key":"subjectContains","value":"Quick"},{"disabled":true,"description":{"content":"

Filter messages created after this date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"disabled":true,"description":{"content":"

Filter messages created before this date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"disabled":true,"description":{"content":"

Page number (used if more than 10 messages is filtered)

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"98d771bd-0359-4dc8-87cf-6638e140675c","name":"no-filter","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/messages","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","messages"],"query":[{"key":"messageId","value":"","description":"Filter by specific message ID","disabled":true},{"key":"channel","value":"EMAIL","description":"Filter by channel (EMAIL or API)","disabled":true},{"key":"from","value":"info@quickclaim.io","description":"Filter by sender's email","disabled":true},{"key":"subjectContains","value":"Quick","description":"Filter by subject content","disabled":true},{"key":"createdAfter","value":"","description":"Filter messages created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter messages created before this date","disabled":true},{"key":"page","value":"1","description":"Page number (used if more than 10 messages is filtered)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 04:10:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4852"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f96cbb6a-6ffc-41e5-9e20-4234a31a7b12"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BednYEivywMEb6A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c0fc8-5ec815317d0e79a74498c169;Parent=3531ac6443432100;Sampled=0;Lineage=2:18ac3246:0"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"EMAIL\",\n \"from\": \"info@example.com\",\n \"subject\": \"FW: Invoice #0013377 - Business Development\",\n \"body\": \"\\n________________________________\\nFrom: notifications=example.com@example.com On Behalf OfBusiness Development (via ExamplePlatform) \\nSent: Wednesday, 26 June 2024 8:40:15 pm (UTC+10:00) Canberra, Melbourne, Sydney\\nTo: Plan Management \\nSubject: Invoice #0013377 - Business Development\\n\\n\\nHello,\\n\\n​\\n\\nAttached is Invoice # 0013377 for John Doe\\n\\n​\\n\\nThank you,\\n\\n​\\n\\nBusiness Development\\n\",\n \"attachmentCount\": 0,\n \"authResult\": \"amazonses.com; spf=pass (spfCheck: domain of example.com designates 40.107.107.105 as permitted sender) client-ip=40.107.107.105; envelope-from=info@example.com; helo=example.com; dkim=pass header.i=@example.com; dmarc=pass header.from=example.com;;dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=example.com;\",\n \"authVerdict\": \"PASS\",\n \"spamVerdict\": \"PASS\",\n \"virusVerdict\": \"PASS\",\n \"isSpam\": false,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"providerTenantId\": null,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"incomingAttachmentFile\": [\n {\n \"id\": \"000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-0\",\n \"contentUri\": \"s3://bucket/incoming/files/20240911/000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/invoice-0013377.pdf\",\n \"parsingStatus\": \"PASS\",\n \"errorMessage\": null,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"isInvoice\": true\n }\n ]\n },\n {\n \"id\": \"007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"EMAIL\",\n \"from\": \"info@example.com\",\n \"subject\": \"FW: Invoice NDIS-000000159-35 from ABC Healthcare for Jane Doe\",\n \"body\": \"\\n________________________________\\nFrom: messaging-service@post.example.com On Behalf OfJohn Smith \\nSent: Monday, 1 July 2024 11:24:05 am (UTC+10:00) Canberra, Melbourne, Sydney\\nTo: Plan Management \\nSubject: Invoice NDIS-000000159-35 from ABC Healthcare for Jane Doe\\n\\n[ABC Healthcare]\\nABC Healthcare\\n$340.49 AUD\\nDue 8 Jul 2024\\nInvoice #: NDIS-000000159-35\\nView Invoice \\nHi Plan Management,\\n\\nHere's invoice NDIS-000000159-35 for AUD 340.49.\\n\\nThe amount outstanding of AUD 340.49 is due on 8 Jul 2024.\\n\\nView your bill online: https://example.com\\n\\nFrom your online bill you can print a PDF, export a CSV, or create a free login and view your outstanding bills.\\n\\nIf you have any questions, please let us know.\\n\\nThanks,\\nABC Healthcare\\nDescription Amount\\nSupport Coordination Level 2 - Date 20.03\\nSupport Coordination Level 2 - Date 40.06\\nSupport Coordination Level 2 - Date 40.06\\n+ 4 more line items\\nAmount Due\\nAUD340.49\\nView full invoice and pay \\nView Invoice \\n[Powered by ExamplePlatform]\\n\\n\",\n \"attachmentCount\": 0,\n \"authResult\": \"amazonses.com; spf=pass (spfCheck: domain of example.com designates 40.107.107.163 as permitted sender) client-ip=40.107.107.163; envelope-from=info@example.com; helo=example.com; dkim=pass header.i=@example.com; dmarc=pass header.from=example.com;;dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=example.com;\",\n \"authVerdict\": \"PASS\",\n \"spamVerdict\": \"PASS\",\n \"virusVerdict\": \"PASS\",\n \"isSpam\": false,\n \"createdAt\": \"2024-09-11T01:28:53.000Z\",\n \"updatedAt\": null,\n \"providerTenantId\": null,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"incomingAttachmentFile\": [\n {\n \"id\": \"007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-0\",\n \"contentUri\": \"s3://bucket/incoming/files/20240911/007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/invoice-ndis.pdf\",\n \"parsingStatus\": \"PASS\",\n \"errorMessage\": null,\n \"createdAt\": \"2024-09-11T01:28:53.000Z\",\n \"updatedAt\": null,\n \"isInvoice\": true\n }\n ]\n },\n {\n \"id\": \"01fxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"API\",\n \"from\": \"info@example.com\",\n \"subject\": \"Direct API post-provider-invoice\",\n \"body\": \"Direct invoice from provider e89c284d-7665-4efd-xxxx-xxxxxxxxxxx to plan manager testee0b-feff-4deb-xxx-xxxxxxxxxxxx\",\n \"attachmentCount\": 0,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"providerTenantId\": null,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"incomingAttachmentFile\": [\n {\n \"id\": \"01fxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-0\",\n \"contentUri\": \"\",\n \"parsingStatus\": \"PASS\",\n \"errorMessage\": null,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"isInvoice\": true\n }\n ]\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalMessages\": 3,\n \"pageSize\": 3,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n }\n}\n"},{"id":"03d2f1d5-806e-403f-89ae-87f42794b05f","name":"emails","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/messages?channel=EMAIL","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","messages"],"query":[{"key":"messageId","value":"","description":"Filter by specific message ID","disabled":true},{"key":"channel","value":"EMAIL","description":"Filter by channel (EMAIL or API)"},{"key":"from","value":"info@quickclaim.io","description":"Filter by sender's email","disabled":true},{"key":"subjectContains","value":"Quick","description":"Filter by subject content","disabled":true},{"key":"createdAfter","value":"","description":"Filter messages created after this date","disabled":true},{"key":"createdBefore","value":"","description":"Filter messages created before this date","disabled":true},{"key":"page","value":"1","description":"Page number (used if more than 10 messages is filtered)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 04:10:51 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"4852"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"f96cbb6a-6ffc-41e5-9e20-4234a31a7b12"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BednYEivywMEb6A="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c0fc8-5ec815317d0e79a74498c169;Parent=3531ac6443432100;Sampled=0;Lineage=2:18ac3246:0"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"EMAIL\",\n \"from\": \"info@example.com\",\n \"subject\": \"FW: Invoice #0013377 - Business Development\",\n \"body\": \"\\n________________________________\\nFrom: notifications=example.com@example.com On Behalf OfBusiness Development (via ExamplePlatform) \\nSent: Wednesday, 26 June 2024 8:40:15 pm (UTC+10:00) Canberra, Melbourne, Sydney\\nTo: Plan Management \\nSubject: Invoice #0013377 - Business Development\\n\\n\\nHello,\\n\\n​\\n\\nAttached is Invoice # 0013377 for John Doe\\n\\n​\\n\\nThank you,\\n\\n​\\n\\nBusiness Development\\n\",\n \"attachmentCount\": 0,\n \"authResult\": \"amazonses.com; spf=pass (spfCheck: domain of example.com designates 40.107.107.105 as permitted sender) client-ip=40.107.107.105; envelope-from=info@example.com; helo=example.com; dkim=pass header.i=@example.com; dmarc=pass header.from=example.com;;dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=example.com;\",\n \"authVerdict\": \"PASS\",\n \"spamVerdict\": \"PASS\",\n \"virusVerdict\": \"PASS\",\n \"isSpam\": false,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"providerTenantId\": null,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"incomingAttachmentFile\": [\n {\n \"id\": \"000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-0\",\n \"contentUri\": \"s3://bucket/incoming/files/20240911/000xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/invoice-0013377.pdf\",\n \"parsingStatus\": \"PASS\",\n \"errorMessage\": null,\n \"createdAt\": \"2024-09-11T01:28:49.000Z\",\n \"updatedAt\": null,\n \"isInvoice\": true\n }\n ]\n },\n {\n \"id\": \"007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"channel\": \"EMAIL\",\n \"from\": \"info@example.com\",\n \"subject\": \"FW: Invoice NDIS-000000159-35 from ABC Healthcare for Jane Doe\",\n \"body\": \"\\n________________________________\\nFrom: messaging-service@post.example.com On Behalf OfJohn Smith \\nSent: Monday, 1 July 2024 11:24:05 am (UTC+10:00) Canberra, Melbourne, Sydney\\nTo: Plan Management \\nSubject: Invoice NDIS-000000159-35 from ABC Healthcare for Jane Doe\\n\\n[ABC Healthcare]\\nABC Healthcare\\n$340.49 AUD\\nDue 8 Jul 2024\\nInvoice #: NDIS-000000159-35\\nView Invoice \\nHi Plan Management,\\n\\nHere's invoice NDIS-000000159-35 for AUD 340.49.\\n\\nThe amount outstanding of AUD 340.49 is due on 8 Jul 2024.\\n\\nView your bill online: https://example.com\\n\\nFrom your online bill you can print a PDF, export a CSV, or create a free login and view your outstanding bills.\\n\\nIf you have any questions, please let us know.\\n\\nThanks,\\nABC Healthcare\\nDescription Amount\\nSupport Coordination Level 2 - Date 20.03\\nSupport Coordination Level 2 - Date 40.06\\nSupport Coordination Level 2 - Date 40.06\\n+ 4 more line items\\nAmount Due\\nAUD340.49\\nView full invoice and pay \\nView Invoice \\n[Powered by ExamplePlatform]\\n\\n\",\n \"attachmentCount\": 0,\n \"authResult\": \"amazonses.com; spf=pass (spfCheck: domain of example.com designates 40.107.107.163 as permitted sender) client-ip=40.107.107.163; envelope-from=info@example.com; helo=example.com; dkim=pass header.i=@example.com; dmarc=pass header.from=example.com;;dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=example.com;\",\n \"authVerdict\": \"PASS\",\n \"spamVerdict\": \"PASS\",\n \"virusVerdict\": \"PASS\",\n \"isSpam\": false,\n \"createdAt\": \"2024-09-11T01:28:53.000Z\",\n \"updatedAt\": null,\n \"providerTenantId\": null,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"tenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"incomingAttachmentFile\": [\n {\n \"id\": \"007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-0\",\n \"contentUri\": \"s3://bucket/incoming/files/20240911/007xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/invoice-ndis.pdf\",\n \"parsingStatus\": \"PASS\",\n \"errorMessage\": null,\n \"createdAt\": \"2024-09-11T01:28:53.000Z\",\n \"updatedAt\": null,\n \"isInvoice\": true\n }\n ]\n }\n ],\n \"metadata\": {\n \"page\": 1,\n \"totalPages\": 1,\n \"totalMessages\": 2,\n \"pageSize\": 2,\n \"pmTenantId\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"channel\": \"EMAIL\"\n }\n}\n"}],"_postman_id":"b122dcd6-3b59-46b0-ab1f-da3f084ffd4d"},{"name":"Get Invoice File","id":"e4ac072c-f4b0-48f9-a71c-b46cbda8a1e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"

Tenant Id of the provider

\n","type":"text"},{"key":"tenant-id","value":"","description":"

Required (plan-manager tenant ID)

\n","type":"text"},{"key":"Authorization","value":"apikey ","description":"

Required

\n","type":"text"}],"url":"https://api.di.quickclaim.io/service-di/plan-manager/invoice-file","description":"

Get an invoice file. (redirects to a pre-singed url)

\n","urlObject":{"path":["service-di","plan-manager","invoice-file"],"host":["https://api.di.quickclaim.io"],"query":[{"disabled":true,"description":{"content":"

Filter by specific invoice ID

\n","type":"text/plain"},"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf681-8"}],"variable":[]}},"response":[{"id":"c0b280c5-01b2-4d38-9076-1248ed9b332f","name":"filter-by-id","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"Tenant Id of the provider","type":"text"},{"key":"tenant-id","value":"","description":"Required (plan-manager tenant ID)","type":"text"},{"key":"Authorization","value":"apikey ","description":"Required","type":"text"}],"url":{"raw":"https://api.di.quickclaim.io/service-di/plan-manager/invoice-file?invoiceId=vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","host":["https://api.di.quickclaim.io"],"path":["service-di","plan-manager","invoice-file"],"query":[{"key":"invoiceId","value":"vah2iidn5u3bkdgrb6247ib3fiej7ifcikoaf68z-z","description":"Filter by specific invoice ID"}]}},"status":"OK","code":302,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 19 Nov 2024 03:32:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"873"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4075f97c-b856-4ab4-a092-4b99b5c7609c"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"BeYATEPrSwMEQzA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-673c06ce-48f748d41f763f9050cbf202;Parent=196c8cb5d2f28bbe;Sampled=0;Lineage=2:a5a5ddc9:0"},{"key":"Location","value":"https://s3.amazon.com/file","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"redirect\""}],"_postman_id":"e4ac072c-f4b0-48f9-a71c-b46cbda8a1e6"}],"id":"eb01180d-14c4-4f92-a15f-c3da67cea905","description":"

Set of APIs for the Plan Manager module

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1fdd8378-a04e-461a-bea1-d5c32378567d","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"f27e6d91-6b1b-43c9-9a22-61021f8af86a","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"eb01180d-14c4-4f92-a15f-c3da67cea905"}],"id":"42c6f20a-522c-4109-b7be-1089f4717476","description":"

Set of APIs for quickclaim Digital Invoice

\n","auth":{"type":"apikey","apikey":{"key":"","value":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d06f3a2e-1f8e-462f-a559-d2dd74d9e715","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"27901dec-2493-4840-a390-0d389caba69e","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"42c6f20a-522c-4109-b7be-1089f4717476"},{"name":"Support At Home","item":[{"name":"Device","item":[{"name":"/device","id":"aa44b693-4a03-4d2c-88fe-2cce5dcbdfce","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"org-id","value":"999","disabled":false},{"key":"user-id","value":"SYSTEM","type":"text"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/device","description":"

Endpoint Description

\n

This endpoint retrieves a list of devices based on the specified query parameters. It supports pagination, filtering, and sorting.

\n

Request Parameters

\n

The request is made using the HTTP GET method and includes the following common query parameters:

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"deviceName\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example deviceName=test. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /device?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"deviceName\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Response Structure

\n

The response will be in JSON format and contains the following structure:

\n
    \n

  • version (string): The version of the response.

    \n
    • \n

  • page (integer): The current page number.

    \n
    • \n

  • totalPages (integer): The total number of pages available.

    \n
    • \n

  • pageSize (integer): The number of results returned per page.

    \n
    • \n

  • totalCount (integer): The total number of devices matching the query.

    \n
    • \n

  • data (array): An array of device objects, each containing:

    \n
      \n

    • id (string): The unique identifier for the device.

      \n
      • \n

    • orgId (integer): The organization identifier.

      \n
      • \n

    • providerId (string): The identifier for the associated provider.

      \n
      • \n

    • deviceIdExternal (string | null): An optional external identifier for the device.

      \n
      • \n

    • deviceName (string): The name of the device.

      \n
      • \n

    • deviceStatus (string | null): The current operational status of the device.

      \n
      • \n

    • activationCode (string): The activation code associated with the device.

      \n
      • \n

    • expiresAt (string | null): The expiry date/time of the device activation, in ISO 8601 format.

      \n
      • \n

    • isDeleted (boolean): Indicates whether the device has been soft-deleted.

      \n
      • \n

    • createdAt (string): The date and time the device record was created, in ISO 8601 format.

      \n
      • \n

    • updatedAt (string): The date and time the device record was last updated, in ISO 8601 format.

      \n
      • \n

    • createdByTraceId (string): The trace identifier of the user or process that created the record.

      \n
      • \n

    • updatedByTraceId (string | null): The trace identifier of the user or process that last updated the record.

      \n
      • \n
    \n
    • \n
\n

Sample Response

\n
{\n  \"version\": \"1.0.0\",\n  \"page\": 1,\n  \"totalPages\": 1,\n  \"pageSize\": 100,\n  \"totalCount\": 1,\n  \"data\": [\n    {\n      \"id\": \"dv-a3771017-b91c-4cb7-9406-c3f83cd315fe\",\n      \"orgId\": 999,\n      \"providerId\": \"p-0d70fb39-d1a4-401a-83c0-521af36bf94c\",\n      \"deviceIdExternal\": null,\n      \"deviceName\": \"test\",\n      \"deviceStatus\": null,\n      \"activationCode\": \"\",\n      \"expiresAt\": null,\n      \"isDeleted\": false,\n      \"createdAt\": \"2026-03-13T00:26:01.000Z\",\n      \"updatedAt\": \"2026-03-13T00:26:01.000Z\",\n      \"createdByTraceId\": \"u101758-019ce495-ffb4-730d-8f22-f0cacc9258b2\",\n      \"updatedByTraceId\": null\n    }\n  ]\n}\n\n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["device"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[],"variable":[]}},"response":[{"id":"dc009e34-0cc5-42d5-8101-d8d0f214164a","name":"/device","originalRequest":{"method":"GET","header":[{"key":"authorization","value":"","disabled":false},{"key":"org-id","value":"999","disabled":false},{"key":"user-id","value":"SYSTEM","type":"text"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/device"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Mar 2026 08:12:09 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"1a562d87-a932-4baa-822c-c4ee75ed2695"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"x-amz-apigw-id","value":"aaOuCF-XywMFy0A="}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"page\": 1,\n \"totalPages\": 1,\n \"pageSize\": 100,\n \"totalCount\": 1,\n \"data\": [\n {\n \"id\": \"dv-a3771017-b91c-4cb7-9406-c3f83cd315fe\",\n \"orgId\": 999,\n \"providerId\": \"p-0d70fb39-d1a4-401a-83c0-521af36bf94c\",\n \"deviceIdExternal\": null,\n \"deviceName\": \"test\",\n \"deviceStatus\": null,\n \"activationCode\": \"\",\n \"expiresAt\": null,\n \"isDeleted\": false,\n \"createdAt\": \"2026-03-13T00:26:01.000Z\",\n \"updatedAt\": \"2026-03-13T00:26:01.000Z\",\n \"createdByTraceId\": \"u101758-019ce495-ffb4-730d-8f22-f0cacc9258b2\",\n \"updatedByTraceId\": null\n }\n ]\n}"}],"_postman_id":"aa44b693-4a03-4d2c-88fe-2cce5dcbdfce"},{"name":"/device/:id","id":"f0cabb9a-837f-4222-88f6-7da380ed6d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"{{orgId}}","disabled":false}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/provider/device/:id","description":"

Retrieve Device Details

\n

This endpoint allows you to retrieve detailed information about a specific device using its unique identifier.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/provider/provider/device/:id

    \n
    • \n

  • Path Parameter:

    \n
      \n
    • id (string): The unique identifier of the device you wish to retrieve.
      • \n
    \n
    • \n
\n

Response

\n

On a successful request, the response will include the following structure:

\n
{\n  \"version\": \"\",\n  \"data\": {\n    \"id\": \"\",\n    \"orgId\": 0,\n    \"providerId\": \"\",\n    \"deviceIdExternal\": null,\n    \"deviceName\": \"\",\n    \"deviceStatus\": null,\n    \"activationCode\": \"\",\n    \"expiresAt\": null,\n    \"isDeleted\": false,\n    \"createdAt\": \"\",\n    \"updatedAt\": \"\",\n    \"createdByTraceId\": \"\",\n    \"updatedByTraceId\": null\n  }\n}\n
\n
    \n

  • Response Fields:

    \n
      \n

    • version (string): The version of the response format.

      \n
      • \n

    • data (object): Contains detailed information about the device.

      \n
        \n

      • id (string): The unique identifier of the device.

        \n
        • \n

      • orgId (integer): The identifier for the organization associated with the device.

        \n
        • \n

      • providerId (string): The identifier for the associated provider.

        \n
        • \n

      • deviceIdExternal (string | null): An optional external identifier for the device.

        \n
        • \n

      • deviceName (string): The name of the device.

        \n
        • \n

      • deviceStatus (string | null): The current operational status of the device.

        \n
        • \n

      • activationCode (string): The activation code associated with the device.

        \n
        • \n

      • expiresAt (string | null): The expiry date/time of the device activation, in ISO 8601 format.

        \n
        • \n

      • isDeleted (boolean): Indicates whether the device has been soft-deleted.

        \n
        • \n

      • createdAt (string): The date and time the device record was created, in ISO 8601 format.

        \n
        • \n

      • updatedAt (string): The date and time the device record was last updated, in ISO 8601 format.

        \n
        • \n

      • createdByTraceId (string): The trace identifier of the user or process that created the record.

        \n
        • \n

      • updatedByTraceId (string | null): The trace identifier of the user or process that last updated the record.

        \n
        • \n
      \n
      • \n
    \n
    • \n
\n

Sample Response

\n
{\n  \"version\": \"1.0.0\",\n  \"data\": {\n    \"id\": \"dv-a3771017-b91c-4cb7-9406-c3f83cd315fe\",\n    \"orgId\": 999,\n    \"providerId\": \"p-0d70fb39-d1a4-401a-83c0-521af36bf94c\",\n    \"deviceIdExternal\": null,\n    \"deviceName\": \"test\",\n    \"deviceStatus\": null,\n    \"activationCode\": \"\",\n    \"expiresAt\": null,\n    \"isDeleted\": false,\n    \"createdAt\": \"2026-03-13T00:26:01.000Z\",\n    \"updatedAt\": \"2026-03-13T00:26:01.000Z\",\n    \"createdByTraceId\": \"u101758-019ce495-ffb4-730d-8f22-f0cacc9258b2\",\n    \"updatedByTraceId\": null\n  }\n}\n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["provider","device",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[{"id":"c2fffdba-e903-4726-b78e-a945354671be","name":"/device/:id","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"{{orgId}}","disabled":false}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/provider/device/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["provider","device",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Mar 2026 08:13:27 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"3aaf0c52-afed-4499-b59e-39f4d9ad37fe"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"x-amz-apigw-id","value":"aaO6KHCRSwMFemQ="}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"dv-a3771017-b91c-4cb7-9406-c3f83cd315fe\",\n \"orgId\": 999,\n \"providerId\": \"p-0d70fb39-d1a4-401a-83c0-521af36bf94c\",\n \"deviceIdExternal\": null,\n \"deviceName\": \"test\",\n \"deviceStatus\": null,\n \"activationCode\": \"\",\n \"expiresAt\": null,\n \"isDeleted\": false,\n \"createdAt\": \"2026-03-13T00:26:01.000Z\",\n \"updatedAt\": \"2026-03-13T00:26:01.000Z\",\n \"createdByTraceId\": \"u101758-019ce495-ffb4-730d-8f22-f0cacc9258b2\",\n \"updatedByTraceId\": null,\n \"provider\": {\n \"legalEntityId\": 6,\n \"name\": null,\n \"sahProviderName\": \"test\",\n \"sahProviderId\": \"test\",\n \"sahProviderNapsId\": \"\",\n \"prodaSahProductId\": \"\",\n \"prodaRa\": \"\",\n \"prodaClientId\": \"\",\n \"addresses\": [],\n \"isDeleted\": false,\n \"createdAt\": \"2026-03-13T00:26:01.000Z\",\n \"updatedAt\": \"2026-03-13T00:26:01.000Z\",\n \"createdByTraceId\": \"u101758-019ce495-ffb4-730d-8f22-f0cacc9258b2\",\n \"updatedByTraceId\": null,\n \"legalEntity\": {\n \"legalEntityId\": 6,\n \"orgId\": 131121,\n \"abn\": \"84378990136\",\n \"acn\": null,\n \"legalName\": \"RISE NETWORK INC\",\n \"tradingName\": \"Rise\",\n \"abnStatus\": null,\n \"address\": \"41A Great Northern Highway Middle Swan WA 6056\",\n \"phone\": \"+61 2 5555 1234\",\n \"contactPerson\": \"Arash\",\n \"emailGeneral\": \"hello@quickclaim.io\",\n \"emailContact\": null,\n \"emailAccounts\": \"accounts@quickclaim.com.au\",\n \"lastSuccessfulSyncDate\": null,\n \"logo\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA3kAAAHqCAYAAAC5nYcRAACAAElEQVR4Xuy9ebhlSVHubTdNMyMynwMiCHpF9NoginpVuBdxAlHEAS8OXHapnPKDBxUUB7RLHwG9ekFFERFFnFDEaicERAUHQBQFZwShBEQQpDc0CDTd8MUaMtcbb0SuvU911T7Dfv/41VoZGRGZGZlrnYxae6/9YR/60Ic+TAghhBBCCCHE8SAIhBBCCCHEwbK8dPci4z7G9y4v3XmS8QQ7\",\n \"deletedAt\": null,\n \"isDeleted\": 0\n },\n \"serviceProviders\": []\n }\n }\n}"}],"_postman_id":"f0cabb9a-837f-4222-88f6-7da380ed6d64"}],"id":"ba055b45-c1e1-4e05-a51a-403a395987f7","description":"

Public API to retrieve device data. It allows clients to list and fetch device records using straightforward headers and query parameters, returning consistent, versioned responses.

\n","_postman_id":"ba055b45-c1e1-4e05-a51a-403a395987f7","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Service Provider","item":[{"name":"/service-provider","event":[{"listen":"test","script":{"id":"6ca17612-491d-48df-83a9-82ccd44238fd","exec":["var template = `","","",""," "," "," "," "," "," "," "," "," "," "," "," "," {{#each response.data}}"," "," "," "," "," "," "," "," "," "," "," "," {{/each}}","
IDOrganization IDProvider IDNameService Provider IDService Provider NameService Naps IDCare Type CodeOperational Status
{{id}}{{orgId}}{{providerId}}{{name}}{{sahServiceProviderId}}{{sahServiceProviderName}}{{sahServiceNapsId}}{{careTypeCode}}{{operationalStatus}}
","`;","","function constructVisualizerPayload() {"," var res = pm.response.json();"," return {response: res};","}","","pm.visualizer.set(template, constructVisualizerPayload());"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ab193248-b95c-4d89-a457-cb371747cab6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true,"accept-encoding":true,"accept":true,"user-agent":true}},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization identifier. Must be a number.

\n"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider","description":"

Endpoint Description

\n

This endpoint retrieves a list of service providers based on the specified query parameters. It allows for pagination, sorting, and filtering of the results.

\n

Request Parameters

\n

The request is made using the HTTP GET method and includes the following query parameters:

\n
    \n

  • id (string): The unique identifier for the service provider.

    \n
    • \n

  • providerId (string): The identifier for the provider.

    \n
    • \n

  • sahServiceProviderId (string): The identifier for the SAH service provider.

    \n
    • \n

  • careTypeCode (string): The code representing the type of care.

    \n
    • \n

  • operationalStatus (string): The operational status of the service provider.

    \n
    • \n
\n

Response Structure

\n

The response will be in JSON format and contains the following structure:

\n
    \n

  • version (string): The version of the response.

    \n
    • \n

  • data (array): An array of service provider objects, each containing:

    \n
      \n

    • id (string): The unique identifier for the service provider.

      \n
      • \n

    • orgId (integer): The organization identifier.

      \n
      • \n

    • providerId (string): The identifier for the provider.

      \n
      • \n

    • name (string): The name of the service provider.

      \n
      • \n

    • sahServiceProviderId (string): The SAH service provider identifier.

      \n
      • \n

    • sahServiceProviderName (string): The name of the SAH service provider.

      \n
      • \n

    • sahServiceNapsId (string): The NAPS identifier for the service.

      \n
      • \n

    • careTypeCode (string): The code for the type of care.

      \n
      • \n

    • operationalStatus (string): The operational status of the service provider.

      \n
      • \n

    • addresses (array): A list of addresses associated with the service provider.

      \n
      • \n

    • registrationCategories (array): The registration categories for the service provider.

      \n
      • \n

    • registeredServiceTypes (array): The types of services registered by the provider.

      \n
      • \n
    \n
    • \n

  • page (integer): The current page number of the results.

    \n
    • \n

  • pageSize (integer): The number of results per page.

    \n
    • \n

  • totalCount (integer): The total number of service providers available.

    \n
    • \n

  • totalPages (integer): The total number of pages available based on the pagination.

    \n
    • \n
\n

This endpoint is useful for applications that need to display or manage service providers efficiently by allowing users to navigate through large datasets with ease.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["service-provider"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[{"disabled":true,"description":{"content":"

Page number (1-based).

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Items per page (max 1000).

\n","type":"text/plain"},"key":"pageSize","value":"100"},{"disabled":true,"description":{"content":"

Sort instructions. Supported formats: JSON array (e.g. ([\"createdAt\",\"ASC\"]) or comma-separated string (e.g. createdAt:desc,id:asc).

\n","type":"text/plain"},"key":"sort","value":"string"},{"disabled":true,"description":{"content":"

Optional default order direction when a single field string is provided in sort.

\n","type":"text/plain"},"key":"sortOrder","value":"asc"},{"disabled":true,"description":{"content":"

Filter by provider ID.

\n","type":"text/plain"},"key":"providerId","value":"string"},{"disabled":true,"description":{"content":"

Filter by SAH service provider ID.

\n","type":"text/plain"},"key":"sahServiceProviderId","value":"string"},{"disabled":true,"description":{"content":"

Filter by care type code.

\n","type":"text/plain"},"key":"careTypeCode","value":"string"},{"disabled":true,"description":{"content":"

Filter by operational status.

\n","type":"text/plain"},"key":"operationalStatus","value":"string"}],"variable":[]}},"response":[{"id":"6edae305-a55c-49f1-b7be-f10927fca876","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"3141","description":"(Required) Organization identifier. Must be a number."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["service-provider"],"query":[{"key":"page","value":"1","description":"Page number (1-based).","disabled":true},{"key":"pageSize","value":"100","description":"Items per page (max 1000).","disabled":true},{"key":"sort","value":"string","description":"Sort instructions. Supported formats: JSON array (e.g. [{\"colId\":\"createdAt\",\"sort\":\"asc\"}] or [[\"createdAt\",\"ASC\"]]) or comma-separated string (e.g. createdAt:desc,id:asc).","disabled":true},{"key":"sortOrder","value":"asc","description":"Optional default order direction when a single field string is provided in sort.","disabled":true},{"key":"providerId","value":"string","description":"Filter by provider ID.","disabled":true},{"key":"sahServiceProviderId","value":"string","description":"Filter by SAH service provider ID.","disabled":true},{"key":"careTypeCode","value":"string","description":"Filter by care type code.","disabled":true},{"key":"operationalStatus","value":"string","description":"Filter by operational status.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": [\n {\n \"id\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"orgId\": 999,\n \"providerId\": \"8e1e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"name\": \"Testing Provider SP\",\n \"sahServiceProviderId\": \"12341234\",\n \"sahServiceProviderName\": \"Testing Provider SP\",\n \"sahServiceNapsId\": \"00000\",\n \"careTypeCode\": \"DEFAULT\",\n \"operationalStatus\": \"ACTIVE\",\n \"addresses\": [],\n \"registrationCategories\": [],\n \"registeredServiceTypes\": []\n }\n ],\n \"page\": 1,\n \"pageSize\": 100,\n \"totalCount\": 1,\n \"totalPages\": 1\n}"},{"id":"bcd1221e-15ff-4084-857b-40208da23b79","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"3141","description":"(Required) Organization identifier. Must be a number."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider?page=2418&pageSize=238&sort=string&sortOrder=asc&filters=string&id=string&providerId=string&sahServiceProviderId=string&careTypeCode=string&operationalStatus=string","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["service-provider"],"query":[{"key":"page","value":"2418","description":"Page number (1-based)."},{"key":"pageSize","value":"238","description":"Items per page (max 1000)."},{"key":"sort","value":"string","description":"Sort instructions. Supported formats: JSON array (e.g. [{\"colId\":\"createdAt\",\"sort\":\"asc\"}] or [[\"createdAt\",\"ASC\"]]) or comma-separated string (e.g. createdAt:desc,id:asc)."},{"key":"sortOrder","value":"asc","description":"Optional default order direction when a single field string is provided in sort."},{"key":"filters","value":"string","description":"AG Grid filter model as JSON string. See https://www.ag-grid.com/javascript-data-grid/filter-api/."},{"key":"id","value":"string","description":"Filter by service provider ID."},{"key":"providerId","value":"string","description":"Filter by provider ID."},{"key":"sahServiceProviderId","value":"string","description":"Filter by SAH service provider ID."},{"key":"careTypeCode","value":"string","description":"Filter by care type code."},{"key":"operationalStatus","value":"string","description":"Filter by operational status."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"ab193248-b95c-4d89-a457-cb371747cab6"},{"name":"/service-provider/:id","id":"97086f24-3469-425c-8f4d-8bc959744a33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization identifier. Must be a number.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider/:id","description":"

Retrieve Service Provider Details

\n

This endpoint allows you to retrieve detailed information about a specific service provider using their unique identifier.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider/:id

    \n
    • \n

  • Path Parameter:

    \n
      \n
    • id (string): The unique identifier of the service provider you wish to retrieve.
      • \n
    \n
    • \n
\n

Response

\n

On a successful request, the response will include the following structure:

\n
{\n  \"version\": \"\",\n  \"data\": {\n    \"id\": \"\",\n    \"orgId\": 0,\n    \"providerId\": \"\",\n    \"name\": \"\",\n    \"sahServiceProviderId\": \"\",\n    \"sahServiceProviderName\": \"\",\n    \"sahServiceNapsId\": \"\",\n    \"careTypeCode\": \"\",\n    \"operationalStatus\": \"\",\n    \"addresses\": [],\n    \"registrationCategories\": [],\n    \"registeredServiceTypes\": []\n  }\n}\n\n
\n
    \n

  • Response Fields:

    \n
      \n

    • version (string): The version of the response format.

      \n
      • \n

    • data (object): Contains detailed information about the service provider.

      \n
        \n

      • id (string): The unique identifier of the service provider.

        \n
        • \n

      • orgId (integer): The identifier for the organization associated with the provider.

        \n
        • \n

      • providerId (string): The provider's ID.

        \n
        • \n

      • name (string): The name of the service provider.

        \n
        • \n

      • sahServiceProviderId (string): The specific service provider ID used in the system.

        \n
        • \n

      • sahServiceProviderName (string): The name used for the service provider in the system.

        \n
        • \n

      • sahServiceNapsId (string): The NAPS ID associated with the service provider.

        \n
        • \n

      • careTypeCode (string): The code representing the type of care provided.

        \n
        • \n

      • operationalStatus (string): The current operational status of the service provider.

        \n
        • \n

      • addresses (array): A list of addresses associated with the service provider.

        \n
        • \n

      • registrationCategories (array): Categories under which the service provider is registered.

        \n
        • \n

      • registeredServiceTypes (array): Types of services registered by the provider.

        \n
        • \n
      \n
      • \n
    \n
    • \n
\n

Notes

\n
    \n

  • Ensure that the id parameter is valid to retrieve the correct service provider details.

    \n
    • \n

  • The response may include empty fields if certain information is not available for the provider.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["service-provider",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[],"variable":[{"description":{"content":"

(Required) Service provider ID (e.g. sp-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"11d9ebb1-c1d8-43fa-a2d7-ca87e4bce5f9","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"3141","description":"(Required) Organization identifier. Must be a number."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["service-provider",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"sp-111e7c2a-1234-4b5a-8c1d-abcdef123459\",\n \"orgId\": 999,\n \"providerId\": \"9e1e7c2a-1234-4b5a-8c1d-abcdef123459\",\n \"name\": \"Testing Provider SP\",\n \"sahServiceProviderId\": \"t404005059\",\n \"sahServiceProviderName\": \"Testing Provider SP\",\n \"sahServiceNapsId\": \"00000\",\n \"careTypeCode\": \"DEFAULT\",\n \"operationalStatus\": \"ACTIVE\",\n \"addresses\": [],\n \"registrationCategories\": [],\n \"registeredServiceTypes\": []\n }\n}"},{"id":"e330e872-28ab-4cbd-9b20-1d941a880271","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"3141","description":"(Required) Organization identifier. Must be a number."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["service-provider",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"2d11b30a-acfc-4cc7-a0d1-e51bb2b0d1c9","name":"Not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"3141","description":"(Required) Organization identifier. Must be a number."},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/service-provider/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["service-provider",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"97086f24-3469-425c-8f4d-8bc959744a33"}],"id":"2021585a-a90d-4fed-aba3-f451c6269d7b","description":"

Public API to retrieve service provider data. It allows clients to list and fetch provider records using straightforward headers and query parameters, returning consistent, versioned responses.

\n","_postman_id":"2021585a-a90d-4fed-aba3-f451c6269d7b","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Pricing","item":[{"name":"/pricing","id":"228389e7-82dc-4b7a-b028-35e238102cee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing","description":"

Pricing Records Retrieval

\n

This API endpoint allows you to retrieve a list of pricing records. It supports various query parameters for filtering and sorting the results based on specific criteria.

\n

Request Parameters

\n
    \n

  • id (string): A unique identifier for the pricing record.

    \n
    • \n

  • pricingId (string): The identifier associated with the pricing record you want to retrieve.

    \n
    • \n

  • serviceId (string): The identifier for the service related to the pricing.

    \n
    • \n

  • name (string): The name associated with the pricing record.

    \n
    • \n

  • rate (number): The rate for the pricing record.

    \n
    • \n

  • createdAt (string, ISO 8601 format): The timestamp when the record was created.

    \n
    • \n

  • updatedAt (string, ISO 8601 format): The timestamp when the record was last updated.

    \n
    • \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"serviceId\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"SERV-006\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example serviceId=test. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /pricing?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"serviceId\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Response Structure

\n

The response will be in JSON format and will contain the following fields:

\n
    \n

  • version (string): The version of the API response.

    \n
    • \n

  • data (array): An array of pricing records, where each record includes:

    \n
      \n

    • id (string): The unique identifier for the pricing record.

      \n
      • \n

    • orgId (number): The organization ID associated with the pricing record.

      \n
      • \n

    • name (string): The name of the pricing record.

      \n
      • \n

    • pricingId (string): The identifier for the pricing.

      \n
      • \n

    • serviceId (string): The identifier for the service.

      \n
      • \n

    • rate (number): The rate associated with the pricing record.

      \n
      • \n

    • createdByTraceId (string): The trace ID of the creator.

      \n
      • \n

    • updatedByTraceId (string|null): The trace ID of the last updater (can be null).

      \n
      • \n

    • createdAt (string): The creation timestamp.

      \n
      • \n

    • updatedAt (string|null): The last updated timestamp (can be null).

      \n
      • \n
    \n
    • \n
\n

This endpoint is useful for applications that need to display or manage pricing records based on various filters and sorting options.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["pricing"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"query":[{"disabled":true,"description":{"content":"

Filter by business pricing identifier

\n","type":"text/plain"},"key":"pricingId","value":"SERV-0002-CmUyAJU"},{"disabled":true,"description":{"content":"

Filter by service identifier

\n","type":"text/plain"},"key":"serviceId","value":"SERV-0002"},{"disabled":true,"description":{"content":"

Filter by name (contains)

\n","type":"text/plain"},"key":"name","value":"string"},{"disabled":true,"description":{"content":"

Filter by rate (exact match)

\n","type":"text/plain"},"key":"rate","value":"10"},{"disabled":true,"description":{"content":"

Filter by creation timestamp (RFC 3339)

\n","type":"text/plain"},"key":"createdAt","value":"1995-05-17T23:28:43.437Z"},{"disabled":true,"description":{"content":"

Filter by update timestamp (RFC 3339)

\n","type":"text/plain"},"key":"updatedAt","value":"1995-05-17T23:28:43.437Z"},{"disabled":true,"description":{"content":"

JSON-encoded sort (e.g., [%7B\"\"rate\":\"asc\"%7D])

\n","type":"text/plain"},"key":"sort","value":"string"},{"disabled":true,"key":"page","value":"1"},{"disabled":true,"key":"pageSize","value":"100"}],"variable":[]}},"response":[{"id":"ed82a22c-7e4e-4915-a420-bc608841ba75","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string","description":"Filter by record ID","disabled":true},{"key":"pricingId","value":"SERV-4751-CmUyAJU","description":"Filter by business pricing identifier","disabled":true},{"key":"serviceId","value":"SERV-6983","description":"Filter by service identifier","disabled":true},{"key":"name","value":"string","description":"Filter by name (contains)","disabled":true},{"key":"rate","value":"9213.533694517693","description":"Filter by rate (exact match)","disabled":true},{"key":"sort","value":"string","description":"JSON-encoded sort (e.g., [%7B\"colId\":\"rate\",\"sort\":\"asc\"%7D])","disabled":true},{"key":"page","value":"1","disabled":true},{"key":"pageSize","value":"100","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": [\n {\n \"id\": \"prc-123\",\n \"orgId\": 999,\n \"name\": \"Standard rate\",\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 100,\n \"createdByTraceId\": \"trace-abc\",\n \"updatedByTraceId\": null,\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": null\n }\n ]\n}"},{"id":"6b75eae3-afb2-4f3c-b708-0654005b0643","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing?id=string&pricingId=SERV-4751-CmUyAJU&serviceId=SERV-6983&name=string&rate=9213.533694517693&createdByTraceId=string&updatedByTraceId=string&createdAt=1995-05-17T23:28:43.437Z&updatedAt=1995-05-17T23:28:43.437Z&sort=string&filters=string&page=2754&pageSize=159","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string"},{"key":"pricingId","value":"SERV-4751-CmUyAJU"},{"key":"serviceId","value":"SERV-6983"},{"key":"name","value":"string"},{"key":"rate","value":"9213.533694517693"},{"key":"createdByTraceId","value":"string"},{"key":"updatedByTraceId","value":"string"},{"key":"createdAt","value":"1995-05-17T23:28:43.437Z"},{"key":"updatedAt","value":"1995-05-17T23:28:43.437Z"},{"key":"sort","value":"string"},{"key":"filters","value":"string"},{"key":"page","value":"2754"},{"key":"pageSize","value":"159"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Bad request, please check your inputs\"\n}"},{"id":"b9bdc472-c0bb-4eed-b411-f6727b1c7ed7","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing?id=string&pricingId=SERV-4751-CmUyAJU&serviceId=SERV-6983&name=string&rate=9213.533694517693&createdByTraceId=string&updatedByTraceId=string&createdAt=1995-05-17T23:28:43.437Z&updatedAt=1995-05-17T23:28:43.437Z&sort=string&filters=string&page=2754&pageSize=159","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string","description":"Filter by record ID"},{"key":"pricingId","value":"SERV-4751-CmUyAJU","description":"Filter by business pricing identifier"},{"key":"serviceId","value":"SERV-6983","description":"Filter by service identifier"},{"key":"name","value":"string","description":"Filter by name (contains)"},{"key":"rate","value":"9213.533694517693","description":"Filter by rate (exact match)"},{"key":"createdByTraceId","value":"string","description":"Filter by creator trace ID"},{"key":"updatedByTraceId","value":"string","description":"Filter by updater trace ID"},{"key":"createdAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by creation timestamp (RFC 3339)"},{"key":"updatedAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by update timestamp (RFC 3339)"},{"key":"sort","value":"string","description":"JSON-encoded sort (e.g., [%7B\"colId\":\"rate\",\"sort\":\"asc\"%7D])"},{"key":"filters","value":"string","description":"JSON-encoded ag-Grid filters object"},{"key":"page","value":"2754"},{"key":"pageSize","value":"159"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Unauthorized, please check your inputs\"\n}"},{"id":"2a542865-fda6-4cff-9385-048840c0ce41","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing?id=string&pricingId=SERV-4751-CmUyAJU&serviceId=SERV-6983&name=string&rate=9213.533694517693&createdByTraceId=string&updatedByTraceId=string&createdAt=1995-05-17T23:28:43.437Z&updatedAt=1995-05-17T23:28:43.437Z&sort=string&filters=string&page=2754&pageSize=159","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string","description":"Filter by record ID"},{"key":"pricingId","value":"SERV-4751-CmUyAJU","description":"Filter by business pricing identifier"},{"key":"serviceId","value":"SERV-6983","description":"Filter by service identifier"},{"key":"name","value":"string","description":"Filter by name (contains)"},{"key":"rate","value":"9213.533694517693","description":"Filter by rate (exact match)"},{"key":"createdByTraceId","value":"string","description":"Filter by creator trace ID"},{"key":"updatedByTraceId","value":"string","description":"Filter by updater trace ID"},{"key":"createdAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by creation timestamp (RFC 3339)"},{"key":"updatedAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by update timestamp (RFC 3339)"},{"key":"sort","value":"string","description":"JSON-encoded sort (e.g., [%7B\"colId\":\"rate\",\"sort\":\"asc\"%7D])"},{"key":"filters","value":"string","description":"JSON-encoded ag-Grid filters object"},{"key":"page","value":"2754"},{"key":"pageSize","value":"159"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Forbidden, please check your inputs\"\n}"},{"id":"cc71dc60-f37a-449c-9df3-6b5624a014aa","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing?id=string&pricingId=SERV-4751-CmUyAJU&serviceId=SERV-6983&name=string&rate=9213.533694517693&createdByTraceId=string&updatedByTraceId=string&createdAt=1995-05-17T23:28:43.437Z&updatedAt=1995-05-17T23:28:43.437Z&sort=string&filters=string&page=2754&pageSize=159","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string","description":"Filter by record ID"},{"key":"pricingId","value":"SERV-4751-CmUyAJU","description":"Filter by business pricing identifier"},{"key":"serviceId","value":"SERV-6983","description":"Filter by service identifier"},{"key":"name","value":"string","description":"Filter by name (contains)"},{"key":"rate","value":"9213.533694517693","description":"Filter by rate (exact match)"},{"key":"createdByTraceId","value":"string","description":"Filter by creator trace ID"},{"key":"updatedByTraceId","value":"string","description":"Filter by updater trace ID"},{"key":"createdAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by creation timestamp (RFC 3339)"},{"key":"updatedAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by update timestamp (RFC 3339)"},{"key":"sort","value":"string","description":"JSON-encoded sort (e.g., [%7B\"colId\":\"rate\",\"sort\":\"asc\"%7D])"},{"key":"filters","value":"string","description":"JSON-encoded ag-Grid filters object"},{"key":"page","value":"2754"},{"key":"pageSize","value":"159"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Item not found, please check your inputs\"\n}"},{"id":"f111807e-c5ff-4084-91f1-25177046b708","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing?id=string&pricingId=SERV-4751-CmUyAJU&serviceId=SERV-6983&name=string&rate=9213.533694517693&createdByTraceId=string&updatedByTraceId=string&createdAt=1995-05-17T23:28:43.437Z&updatedAt=1995-05-17T23:28:43.437Z&sort=string&filters=string&page=2754&pageSize=159","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing"],"query":[{"key":"id","value":"string","description":"Filter by record ID"},{"key":"pricingId","value":"SERV-4751-CmUyAJU","description":"Filter by business pricing identifier"},{"key":"serviceId","value":"SERV-6983","description":"Filter by service identifier"},{"key":"name","value":"string","description":"Filter by name (contains)"},{"key":"rate","value":"9213.533694517693","description":"Filter by rate (exact match)"},{"key":"createdByTraceId","value":"string","description":"Filter by creator trace ID"},{"key":"updatedByTraceId","value":"string","description":"Filter by updater trace ID"},{"key":"createdAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by creation timestamp (RFC 3339)"},{"key":"updatedAt","value":"1995-05-17T23:28:43.437Z","description":"Filter by update timestamp (RFC 3339)"},{"key":"sort","value":"string","description":"JSON-encoded sort (e.g., [%7B\"colId\":\"rate\",\"sort\":\"asc\"%7D])"},{"key":"filters","value":"string","description":"JSON-encoded ag-Grid filters object"},{"key":"page","value":"2754"},{"key":"pageSize","value":"159"}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Too many requests\"\n}"}],"_postman_id":"228389e7-82dc-4b7a-b028-35e238102cee"},{"name":"/pricing","id":"e429e60d-aee9-4edf-966e-0e4107691f4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing","description":"

Creates a pricing record using v1 input schema.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["pricing"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"query":[],"variable":[]}},"response":[{"id":"b6d9152f-d1a1-4a6d-96de-3245177d3a9a","name":"Created","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"prc-123\",\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\",\n \"createdByTraceId\": \"trace-abc\",\n \"updatedByTraceId\": null,\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": null\n }\n}"},{"id":"7bc3fb03-5e04-4838-ac14-fa570ec0649c","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"0af3362a-e35d-4a7b-bbd5-1c1c2c07efcf","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"0712fa1b-3932-45bc-a095-df4e90c37042","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"0218f979-7abe-471d-b9c8-f5a46549bbe3","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"03db8185-266c-4916-a93e-daa9a5d50611","name":"Precondition Failed","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 120,\n \"name\": \"Standard rate\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"e429e60d-aee9-4edf-966e-0e4107691f4a"},{"name":"/pricing/:id","id":"f87073a6-30af-4778-9959-439c0cdf207b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","description":"

Retrieves a single pricing record using versioned v1 schemas.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["pricing",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"query":[],"variable":[{"description":{"content":"

(Required) Pricing ID

\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"869aaf6f-2fc6-4ec4-a961-b1e6c66edce0","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 100\n }\n}"},{"id":"d93834b8-a16e-4801-afc9-37796dd05da3","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Bad request, please check your inputs\"\n}"},{"id":"617e789e-3782-4632-969c-9f372477560f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Unauthorized, please check your inputs\"\n}"},{"id":"a626b15a-c619-4ea4-9a50-3b96dc64873c","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Forbidden, please check your inputs\"\n}"},{"id":"e45b1c21-d5fc-4df6-b6e1-c4614bb9bd8b","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Item not found, please check your inputs\"\n}"},{"id":"eb7b90b6-71c4-4e28-982e-27619e08e595","name":"Too Many Requests","originalRequest":{"method":"GET","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Too many requests\"\n}"}],"_postman_id":"f87073a6-30af-4778-9959-439c0cdf207b"},{"name":"/pricing/:id","id":"6dde48c3-8598-40d0-a744-db10a451ae4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","description":"

Updates a pricing record by ID using v1 input schema.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["pricing",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"query":[],"variable":[{"description":{"content":"

(Required) Pricing ID

\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"d3a5d2e4-07db-44ab-a0eb-57c572699813","name":"Updated","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"prc-123\",\n \"orgId\": 999,\n \"pricingId\": \"SERV-0001-TEST\",\n \"serviceId\": \"SERV-0001\",\n \"rate\": 130,\n \"name\": \"Updated standard rate\",\n \"createdByTraceId\": \"trace-abc\",\n \"updatedByTraceId\": \"trace-def\",\n \"createdAt\": \"2024-01-01T00:00:00Z\",\n \"updatedAt\": \"2024-02-01T00:00:00Z\"\n }\n}"},{"id":"53093523-92b0-4d8f-99bf-7d5855d79e25","name":"Bad Request","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"d4b41aa5-8b9d-4dd7-abc9-08e73811b5d5","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"adca4d5d-1411-4ef7-a8cd-273e27cfef4d","name":"Forbidden","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"81f1bb66-2c0c-4279-9c08-b90c6f7aebfd","name":"Not Found","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"e9e68f3f-4bce-457e-a81c-88baeae36dab","name":"Conflict","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"6e7acc18-0614-4102-a649-fae84b3d096a","name":"Precondition Failed","originalRequest":{"method":"PUT","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"orgId\": 999,\n \"name\": \"Updated standard rate\",\n \"rate\": 130\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"6dde48c3-8598-40d0-a744-db10a451ae4f"},{"name":"/pricing/:id","id":"f73fada4-5736-4cd0-95c7-9c3542ad54b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","description":"

Deletes a pricing record by ID

\n

Note that the records for main default pricing IDs (the ones that match exactly serviceId, e.g., SERV-0001) will have their rate unset (null).

\n

Responses

\n
    \n

  • Success Response:

    \n
      \n

    • Code: 200 OK

      \n
      • \n

    • { \"version\": \"\", \"message\": \"\"}

      \n
      • \n
    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["pricing",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"query":[],"variable":[{"description":{"content":"

(Required) Pricing ID

\n","type":"text/plain"},"type":"any","value":"string","key":"id"}]}},"response":[{"id":"d3051f1c-6691-4791-a6ac-ecad2c4969ae","name":"Deleted","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Pricing (prc-123) deleted successfully\"\n}"},{"id":"ef862aa7-37a0-4b1b-8249-a8eb8239bbb2","name":"Bad Request","originalRequest":{"method":"DELETE","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"40a72c4a-c83b-42a8-931a-d9b4ff1b0d26","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"d5645c7b-2b3e-499d-875f-5e76358ed1a7","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"9788030e-04a0-43a1-a8c8-f1862a9adfb8","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"063be4c6-e6ca-47f0-9718-d033e3084b46","name":"Too Many Requests","originalRequest":{"method":"DELETE","header":[{"key":"user-id","value":"string","description":"(Required) "},{"key":"org-id","value":"4097","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/catalog/pricing/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/catalog"],"path":["pricing",":id"],"variable":[{"key":"id","value":""}]}},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"f73fada4-5736-4cd0-95c7-9c3542ad54b0"}],"id":"d1d9c281-e343-40c9-87d7-f2540c6c5e56","description":"

The Pricing API lets you define, fetch, update, and remove default prices for services in the Support at Home catalog. Each price is uniquely tied to a single service via a custom pricingId that is prefixed with the matching serviceId, ensuring one price maps to one service. Use it to set standard rates and adjust them as needs change.

\n","_postman_id":"d1d9c281-e343-40c9-87d7-f2540c6c5e56","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Care Recipient","item":[{"name":"/","id":"2c76e4d8-dbb1-4348-8c4d-cfa1d71e3250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient","description":"

Endpoint Description

\n

This endpoint retrieves a paginated list of care recipients from the service. It allows clients to specify the page number, the number of items per page, and the sorting order of the results.

\n

Request Parameters

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"firstName\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example firstName=Ali. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /care-recipient?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"firstName\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Sync Statuses

\n

The following sync statuses may be relevant when handling care recipients:

\n
    \n

  • NEW: Care recipient is added but not yet synced.

    \n
    • \n

  • PENDING_SYNC: Care recipient is flagged to be synced.

    \n
    • \n

  • NOT_FOUND: The specified careRecipientId is not found in the system.

    \n
    • \n

  • MISMATCH: The careRecipientId is found in the system, but some data differs.

    \n
    • \n

  • SYNCED: The careRecipientId is found, data matches, and it is synced.

    \n
    • \n
\n

Response Structure

\n

The response will be a JSON object containing the following fields:

\n
    \n

  • version (string): Indicates the version of the API.

    \n
    • \n

  • message (string): A message providing additional context about the response.

    \n
    • \n

  • data (array): Contains list of care recipients.

    \n
    • \n

  • page (integer): The current page number of the results.

    \n
    • \n

  • totalPages (integer): The total number of pages available based on the request parameters.

    \n
    • \n

  • pageSize (integer): The number of items per page as requested.

    \n
    • \n

  • totalCount (integer): The total number of care recipients available.

    \n
    • \n
\n

Example Response

\n
{\n  \"version\": \"1.0.0\",\n  \"page\": 1,\n  \"pageSize\": 2,\n  \"totalPages\": 1,\n  \"totalCount\": 2,\n  \"data\": [\n    {\n      \"id\": \"cr-11111111-1111-1111-1111-111111111111\",\n      \"orgId\": 999,\n      \"serviceProviderId\": \"sp-00001\",\n      \"sahCareRecipientId\": \"12341234\",\n      \"birthDate\": \"1985-05-15\",\n      \"firstName\": \"John\",\n      \"lastName\": \"Smith\",\n      \"gender\": \"MALE\",\n      \"isActive\": true,\n      \"isDeleted\": false,\n      \"status\": \"NEW\",\n      \"createdAt\": \"2025-01-01T00:00:00Z\",\n      \"updatedAt\": \"2025-01-01T00:00:00Z\",\n      \"createdByTraceId\": \"11111111-2222-3333-4444-555555555555\"\n    },\n    {\n      \"id\": \"cr-22222222-2222-2222-2222-222222222222\",\n      \"orgId\": 999,\n      \"serviceProviderId\": \"sp-00002\",\n      \"sahCareRecipientId\": \"87654321\",\n      \"birthDate\": \"1948-11-27\",\n      \"firstName\": \"Vicky\",\n      \"lastName\": \"Ahwong\",\n      \"gender\": \"FEMALE\",\n      \"isActive\": true,\n      \"isDeleted\": false,\n      \"status\": \"NEW\",\n      \"createdAt\": \"2025-01-01T00:00:00Z\",\n      \"updatedAt\": \"2025-01-02T00:00:00Z\",\n      \"createdByTraceId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n    }\n  ]\n}\n\n
\n

This structure ensures that clients can easily navigate through the paginated results and understand the context of the data returned.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[{"disabled":true,"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Items per page

\n","type":"text/plain"},"key":"pageSize","value":"100"}],"variable":[]}},"response":[{"id":"d44c3d71-4d73-4f46-ac42-6fd8d9f5d212","name":"Successful list","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/?page=1&pageSize=100","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[""],"query":[{"key":"page","value":"1","description":"Page number"},{"key":"pageSize","value":"100","description":"Items per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"page\": 1,\n \"pageSize\": 2,\n \"totalPages\": 1,\n \"totalCount\": 2,\n \"data\": [\n {\n \"id\": \"cr-11111111-1111-1111-1111-111111111111\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-00001\",\n \"sahCareRecipientId\": \"12341234\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"gender\": \"MALE\",\n \"isActive\": true,\n \"isDeleted\": false,\n \"status\": \"NEW\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-01T00:00:00Z\",\n \"createdByTraceId\": \"11111111-2222-3333-4444-555555555555\"\n },\n {\n \"id\": \"cr-22222222-2222-2222-2222-222222222222\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-00002\",\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1948-11-27\",\n \"firstName\": \"Vicky\",\n \"lastName\": \"Ahwong\",\n \"gender\": \"FEMALE\",\n \"isActive\": true,\n \"isDeleted\": false,\n \"status\": \"NEW\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-02T00:00:00Z\",\n \"createdByTraceId\": \"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee\"\n }\n ]\n}"},{"id":"f2663c15-b4e6-49bd-96d1-d15909a33577","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/?page=8766&pageSize=368&sort=string&filters=string","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[""],"query":[{"key":"page","value":"8766","description":"Page number"},{"key":"pageSize","value":"368","description":"Items per page"},{"key":"sort","value":"string","description":"Sort expression; supports AG Grid sort JSON, tuple arrays, or comma-separated"},{"key":"filters","value":"string","description":"AG Grid filters JSON string"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"39319254-fd00-4ae1-aab7-328efabc13d2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/?page=8766&pageSize=368&sort=string&filters=string","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[""],"query":[{"key":"page","value":"8766","description":"Page number"},{"key":"pageSize","value":"368","description":"Items per page"},{"key":"sort","value":"string","description":"Sort expression; supports AG Grid sort JSON, tuple arrays, or comma-separated"},{"key":"filters","value":"string","description":"AG Grid filters JSON string"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"a26bc6fe-44a0-4eca-9063-680015134ac8","name":"Forbidden or missing authentication token","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/?page=8766&pageSize=368&sort=string&filters=string","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[""],"query":[{"key":"page","value":"8766","description":"Page number"},{"key":"pageSize","value":"368","description":"Items per page"},{"key":"sort","value":"string","description":"Sort expression; supports AG Grid sort JSON, tuple arrays, or comma-separated"},{"key":"filters","value":"string","description":"AG Grid filters JSON string"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Origin","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Methods","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Expose-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"2c76e4d8-dbb1-4348-8c4d-cfa1d71e3250"},{"name":"/","id":"62481fe8-522b-43d7-a836-ac6f38e2549d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[]}},"response":[{"id":"0cb4358c-790b-411d-824b-47a59eb52ebd","name":"Created successfully","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"string\",\n \"orgId\": 7787,\n \"sahCareRecipientId\": \"string\",\n \"isDeleted\": true,\n \"status\": \"NOT_FOUND\",\n \"createdAt\": \"1977-02-09T04:44:27.730Z\",\n \"createdByTraceId\": \"string\",\n \"serviceProviderId\": \"string\",\n \"birthDate\": \"1981-04-08\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"OTHER\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 1389,\n \"categoryYId\": 5499,\n \"contactId\": 4733,\n \"isActive\": false,\n \"errorMessage\": \"string\",\n \"metadata\": {\n \"description\": \"Metadata\"\n },\n \"messages\": {\n \"description\": \"Messages\"\n },\n \"updatedAt\": \"1996-05-31T17:27:08.212Z\",\n \"updatedByTraceId\": \"string\",\n \"updatedAtDateTimeExternal\": \"1979-11-30T17:35:51.311Z\",\n \"categoryX\": {\n \"description\": \"Category X object\"\n },\n \"categoryY\": {\n \"description\": \"Category Y object\"\n },\n \"contact\": {\n \"description\": \"Contact object\"\n },\n \"serviceProvider\": {\n \"description\": \"Service provider object\"\n }\n },\n \"page\": 5314.056758977842,\n \"totalPages\": 9220.184861773017,\n \"pageSize\": 424.6596283946735,\n \"totalCount\": 7085.548900114835\n}"},{"id":"7347b6ba-dc0e-4c87-b8e6-c576c40f012f","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"c0992720-9617-475b-b3b6-f961e47b8d78","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"3c1f62b6-6eb3-4f1b-9311-d7812d015c41","name":"Forbidden or missing authentication token","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Origin","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Methods","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Expose-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"eb8be53b-d9c1-45e7-96fe-8e945b95f01c","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"sahCareRecipientId\": \"87654321\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"lastName\": \"Smith\",\n \"middleName\": \"Michael\",\n \"gender\": \"MALE\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"62481fe8-522b-43d7-a836-ac6f38e2549d"},{"name":"/","id":"b6788da7-22e0-4621-9651-61f78b9c19a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[]}},"response":[{"id":"502f3a5b-2b8f-4a1e-a49c-ac6da5439a94","name":"Bulk update result","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"updatedCount\": 1953,\n \"requestedCount\": 4219\n },\n \"page\": 4651.83316319981,\n \"totalPages\": 7831.7396189897445,\n \"pageSize\": 4409.330226617467,\n \"totalCount\": 7560.509792542645\n}"},{"id":"1e27ba3e-9b38-41c4-a462-7bcafefe273a","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"54115d67-39af-479b-8804-09788598a5ff","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"3ce5715b-fa60-43bd-b676-1dc0112c56c0","name":"Forbidden or missing authentication token","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Origin","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Methods","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Expose-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"c826d8b1-b7fa-408d-99ce-65228d46396c","name":"Conflict","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"89ef87db-4f9e-412b-b4d3-2feadd3a05de","name":"Precondition failed","originalRequest":{"method":"PUT","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"stringstringstringstringstringstring\"\n ],\n \"data\": {\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"2006-12-12\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"FEMALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 8380,\n \"categoryYId\": 7663,\n \"contactId\": 2593,\n \"isActive\": false\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"b6788da7-22e0-4621-9651-61f78b9c19a5"},{"name":"/:id","id":"d684f017-4fff-4e92-b8f3-fe78a37319eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":[":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[{"description":{"content":"

(Required) Care recipient ID

\n","type":"text/plain"},"type":"any","value":"stringstringstringstringstringstring","key":"id"}]}},"response":[{"id":"30de5aec-429b-4f9e-9f45-44a9d8ff2a76","name":"Found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"cr-fcf3ec09-dd68-4e48-946a-34d663f8b8f7\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-00001\",\n \"sahCareRecipientId\": \"12341234\",\n \"birthDate\": \"1985-05-15\",\n \"firstName\": \"John\",\n \"middleName\": \"Michael\",\n \"lastName\": \"Smith\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"AC12345678\",\n \"sparcId\": \"1968778\",\n \"isActive\": true,\n \"isDeleted\": false,\n \"status\": \"NEW\",\n \"createdAt\": \"2025-01-01T00:00:00Z\",\n \"updatedAt\": \"2025-01-02T12:00:00Z\",\n \"createdByTraceId\": \"11111111-2222-3333-4444-555555555555\",\n \"updatedByTraceId\": \"66666666-7777-8888-9999-000000000000\",\n \"updatedAtDateTimeExternal\": \"2025-01-02T12:00:00Z\",\n \"packages\": [],\n \"assessments\": [],\n \"approvedServices\": [],\n \"supplements\": []\n }\n}"},{"id":"6a2a5988-b24c-4c0d-91c7-d470c0f88432","name":"Bad request","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"ee611a45-ae5a-434d-8958-71f7ab313403","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"bd4ed956-4cc6-4260-b317-781c72e65f00","name":"Forbidden or missing authentication token","originalRequest":{"method":"GET","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Expose-Headers","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"20accbff-5540-4809-ac3a-d732b41df30f","name":"Resource not found","originalRequest":{"method":"GET","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"d684f017-4fff-4e92-b8f3-fe78a37319eb"},{"name":"/:id","id":"9a20fa5b-04cd-4038-82b2-4b0f4ae7f5b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":[":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[{"description":{"content":"

(Required) Care recipient ID

\n","type":"text/plain"},"type":"any","value":"stringstringstringstringstringstring","key":"id"}]}},"response":[{"id":"60237c5d-f407-4b7b-92f3-4784a54a84ed","name":"Updated successfully","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"string\",\n \"orgId\": 7787,\n \"sahCareRecipientId\": \"string\",\n \"isDeleted\": true,\n \"status\": \"NOT_FOUND\",\n \"createdAt\": \"1977-02-09T04:44:27.730Z\",\n \"createdByTraceId\": \"string\",\n \"serviceProviderId\": \"string\",\n \"birthDate\": \"1981-04-08\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"OTHER\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 1389,\n \"categoryYId\": 5499,\n \"contactId\": 4733,\n \"isActive\": false,\n \"errorMessage\": \"string\",\n \"metadata\": {\n \"description\": \"Metadata\"\n },\n \"messages\": {\n \"description\": \"Messages\"\n },\n \"updatedAt\": \"1996-05-31T17:27:08.212Z\",\n \"updatedByTraceId\": \"string\",\n \"updatedAtDateTimeExternal\": \"1979-11-30T17:35:51.311Z\",\n \"categoryX\": {\n \"description\": \"Category X object\"\n },\n \"categoryY\": {\n \"description\": \"Category Y object\"\n },\n \"contact\": {\n \"description\": \"Contact object\"\n },\n \"serviceProvider\": {\n \"description\": \"Service provider object\"\n }\n },\n \"page\": 5314.056758977842,\n \"totalPages\": 9220.184861773017,\n \"pageSize\": 424.6596283946735,\n \"totalCount\": 7085.548900114835\n}"},{"id":"a455ec12-84ea-4739-bab9-8332c125eff3","name":"Bad request","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"e2b28cd2-a575-4b9d-94ba-43af1524cc7c","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"8bd524e8-f0e0-4a1b-893f-6b5712826a1b","name":"Forbidden or missing authentication token","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Expose-Headers","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"5d6a3dba-ee96-4f9e-bd0c-a15b02227192","name":"Resource not found","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"32eb8f71-70e4-4318-9b15-19ad193e606b","name":"Conflict","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"string\",\n \"sahCareRecipientId\": \"string\",\n \"birthDate\": \"1960-01-04\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"MALE\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 9011,\n \"categoryYId\": 121,\n \"contactId\": 3983,\n \"isActive\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"9a20fa5b-04cd-4038-82b2-4b0f4ae7f5b4"},{"name":"/:id","id":"772d0428-aa17-42ce-8f6d-953da5c875d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":[":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[{"description":{"content":"

(Required) Care recipient ID

\n","type":"text/plain"},"type":"any","value":"stringstringstringstringstringstring","key":"id"}]}},"response":[{"id":"460bffdf-a988-4341-b699-b15cc2cd7fe7","name":"Deleted successfully","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Payload data\"\n },\n \"page\": 1402.907148465483,\n \"totalPages\": 2347.193242253829,\n \"pageSize\": 1818.2724535047746,\n \"totalCount\": 8900.050332398641\n}"},{"id":"cb29c3ad-95a0-45c5-b445-67f2df2a48be","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"c25dda3f-6685-4e09-a6ad-9c1affd5c37f","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"06aafd55-61dd-4ad2-958c-95b755d478f9","name":"Forbidden or missing authentication token","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Expose-Headers","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"266a7d4e-39f6-4e74-9a32-e0e18aed4494","name":"Resource not found","originalRequest":{"method":"DELETE","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/:id","host":["https://api.quickclaim.io/public"],"path":[":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"772d0428-aa17-42ce-8f6d-953da5c875d7"},{"name":"/sync","id":"77c98d6d-6e8a-4616-8fa8-6994759791ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync","description":"

DELETE /:id

\n

This endpoint is used to delete a care recipient from the system based on the provided id.

\n

Request Parameters

\n
    \n
  • id (path parameter): The unique identifier of the care recipient to be deleted.
    • \n
\n

Response Structure

\n

Upon successful deletion, the response will contain the following fields:

\n
    \n

  • version: The version of the response.

    \n
    • \n

  • message: A message indicating the result of the operation.

    \n
    • \n

  • data: An object containing additional details about the operation.

    \n
      \n
    • description: A description of the operation's result.
      • \n
    \n
    • \n

  • page: The current page number of the response.

    \n
    • \n

  • totalPages: The total number of pages available.

    \n
    • \n

  • pageSize: The size of each page.

    \n
    • \n

  • totalCount: The total number of care recipients.

    \n
    • \n
\n

Sync Statuses

\n

The following sync statuses may be relevant when handling care recipients:

\n
    \n

  • NEW: Care recipient is added but not yet synced.

    \n
    • \n

  • PENDING_SYNC: Care recipient is flagged to be synced.

    \n
    • \n

  • NOT_FOUND: The specified careRecipientId is not found in the system.

    \n
    • \n

  • MISMATCH: The careRecipientId is found in the system, but some data differs.

    \n
    • \n

  • SYNCED: The careRecipientId is found, data matches, and it is synced.

    \n
    • \n
\n

These statuses can help in understanding the state of the care recipient in relation to the system during operations.

\n

This endpoint is used to delete a care recipient from the system. The request requires a specific care recipient ID, which must be found in the remote SAH (Service Access Hub) to successfully submit the transaction.

\n

Request Parameters

\n
    \n
  • id (path parameter): The unique identifier of the care recipient that you wish to delete.
    • \n
\n

Response Structure

\n

Upon successful deletion, the response will provide the following structure:

\n
    \n

  • version: Indicates the version of the response.

    \n
    • \n

  • message: A message detailing the result of the operation.

    \n
    • \n

  • data: Contains additional information, including:

    \n
      \n
    • description: A description related to the deletion operation.
      • \n
    \n
    • \n

  • page, totalPages, pageSize, totalCount: Pagination details that may be relevant for tracking the state of the operation.

    \n
    • \n
\n

Successfull Sync Status

\n

The care recipient's sync status is crucial for determining the outcome of the delete operation:

\n
    \n

  • SYNCED: Indicates that the care recipient's data is consistent with the remote SAH. Deleting a synced recipient is straightforward.

    \n
    • \n

  • MISMATCH: Indicates that there is a discrepancy between the local and remote data. Despite this mismatch, it is still possible to submit transactions for deletion.

    \n
    • \n
\n

Additionally, for scheduled transactions, the system will automatically trigger a sync action to ensure that any pending operations are updated in line with the latest data from the remote SAH.

\n

This endpoint is essential for maintaining the integrity of care recipient records and ensuring that the system reflects accurate and up-to-date information.

\n

This endpoint is used to synchronize care recipient data with the system. By sending a request to this endpoint, you can trigger the synchronization process, which can be useful for ensuring that the latest care recipient information is available.

\n

Request

\n
    \n

  • Method: POST

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync

    \n
    • \n

  • Request Body: The request must include a JSON payload in the following format:

    \n
    • \n
\n
{\n  \"syncAll\": true\n}\n\n
\n
    \n

  • Parameters:

    \n
      \n
    • syncAll (boolean, required): A flag indicating whether to synchronize all care recipients. Set this to true to synchronize all data.
      • \n
    \n
    • \n
\n

Response

\n

The response from the server will be in JSON format and will contain the following structure:

\n
{\n  \"version\": \"\",\n  \"message\": \"\",\n  \"data\": {\n    \"count\": 0,\n    \"orgId\": 0,\n    \"serviceProviderId\": \"\",\n    \"syncAll\": true,\n    \"careRecipientIds\": [\"\"]\n  },\n  \"page\": 0,\n  \"totalPages\": 0,\n  \"pageSize\": 0,\n  \"totalCount\": 0\n}\n\n
\n
    \n

  • Response Fields:

    \n
      \n

    • version (string): The version of the API.

      \n
      • \n

    • message (string): A message regarding the request status.

      \n
      • \n

    • data (object): Contains the details of the synchronization.

      \n
        \n

      • count (integer): The number of care recipients processed.

        \n
        • \n

      • orgId (integer): The organization ID associated with the request.

        \n
        • \n

      • serviceProviderId (string): The service provider ID.

        \n
        • \n

      • syncAll (boolean): Echoes the value sent in the request.

        \n
        • \n

      • careRecipientIds (array of strings): An array of care recipient IDs that were synchronized.

        \n
        • \n
      \n
      • \n

    • page (integer): The current page of results.

      \n
      • \n

    • totalPages (integer): The total number of pages available.

      \n
      • \n

    • pageSize (integer): The number of items per page.

      \n
      • \n

    • totalCount (integer): The total number of care recipients available.

      \n
      • \n
    \n
    • \n
\n

This endpoint is essential for maintaining up-to-date care recipient information in your system.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["sync"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[{"disabled":true,"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Items per page

\n","type":"text/plain"},"key":"pageSize","value":"100"},{"disabled":true,"description":{"content":"

Sort expression; supports AG Grid sort JSON, tuple arrays, or comma-separated

\n","type":"text/plain"},"key":"sort","value":"string"}],"variable":[]}},"response":[{"id":"748e6057-e3c8-4054-87dd-196d239ee1b0","name":"syncAll","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"count\": 923,\n \"orgId\": 9500,\n \"serviceProviderId\": \"string\",\n \"syncAll\": false,\n \"careRecipientIds\": [\n \"string\",\n \"string\"\n ]\n },\n \"page\": 6280.539256600577,\n \"totalPages\": 6024.358959931424,\n \"pageSize\": 3706.375792210246,\n \"totalCount\": 5971.483867267292\n}"},{"id":"ae2f2183-7990-41fa-b117-7695ccc4ad21","name":"byIds","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"cr-00000000-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"count\": 923,\n \"orgId\": 9500,\n \"serviceProviderId\": \"string\",\n \"syncAll\": false,\n \"careRecipientIds\": [\n \"string\",\n \"string\"\n ]\n },\n \"page\": 6280.539256600577,\n \"totalPages\": 6024.358959931424,\n \"pageSize\": 3706.375792210246,\n \"totalCount\": 5971.483867267292\n}"},{"id":"40e4277a-74b9-479d-862f-028924603970","name":"400","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"f96270a7-b335-47ca-a1fd-d107491b690b","name":"400","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"cr-00000000-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"381998ae-dca6-4c4d-a413-b926eac73ca2","name":"401","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"f7ae8c59-780d-42d1-9202-a6e5e2905efc","name":"401","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"cr-00000000-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"420d50b6-ff15-443e-81ae-ad4064d04140","name":"403","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Expose-Headers","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"10d2c563-0a18-44a3-8358-7982cf0e02b2","name":"403","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"cr-00000000-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Origin","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Headers","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Allow-Methods","value":"string"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"Access-Control-Expose-Headers","value":"string"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"3b3344c2-e253-434e-a632-dcb26cbccde0","name":"412","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"e05c512b-555e-497e-aedc-1acdc51de234","name":"412","originalRequest":{"method":"POST","header":[{"description":"(Required) Organization ID (numeric)","key":"org-id","value":"87923778"},{"description":"User identifier","key":"user-id","value":"string"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"cr-00000000-0000-0000-0000-000000000000\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/public/sync"},"status":"Precondition Failed","code":412,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"x-trace-id","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"77c98d6d-6e8a-4616-8fa8-6994759791ff"},{"name":"/search","id":"7ea91815-ff6b-4f7f-95d4-790dfde636d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": \"9000000001\",\n \"lastName\": \"SMITH\",\n \"birthDate\": \"1980-01-01\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/search","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["search"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[]}},"response":[{"id":"0e880f99-d59f-46aa-85ef-5e7c4e4306bc","name":"Search results","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": \"12341234\",\n \"lastName\": \"Smith\",\n \"birthDate\": \"1985-05-15\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": [\n {\n \"id\": \"string\",\n \"orgId\": 5530,\n \"sahCareRecipientId\": \"string\",\n \"isDeleted\": true,\n \"status\": \"SYNCED\",\n \"createdAt\": \"1990-07-20T06:18:40.386Z\",\n \"createdByTraceId\": \"string\",\n \"serviceProviderId\": \"string\",\n \"birthDate\": \"1981-12-14\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"OTHER\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 5123,\n \"categoryYId\": 1139,\n \"contactId\": 9064,\n \"isActive\": false,\n \"errorMessage\": \"string\",\n \"metadata\": {\n \"description\": \"Metadata\"\n },\n \"messages\": {\n \"description\": \"Messages\"\n },\n \"updatedAt\": \"1948-04-18T07:55:20.392Z\",\n \"updatedByTraceId\": \"string\",\n \"updatedAtDateTimeExternal\": \"2018-04-21T07:38:08.607Z\",\n \"categoryX\": {\n \"description\": \"Category X object\"\n },\n \"categoryY\": {\n \"description\": \"Category Y object\"\n },\n \"contact\": {\n \"description\": \"Contact object\"\n },\n \"serviceProvider\": {\n \"description\": \"Service provider object\"\n }\n },\n {\n \"id\": \"string\",\n \"orgId\": 8909,\n \"sahCareRecipientId\": \"string\",\n \"isDeleted\": true,\n \"status\": \"SYNCED\",\n \"createdAt\": \"1954-08-30T08:52:22.879Z\",\n \"createdByTraceId\": \"string\",\n \"serviceProviderId\": \"string\",\n \"birthDate\": \"1974-01-28\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"gender\": \"OTHER\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"careExtensions\": {\n \"description\": \"Additional care extension data\"\n },\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"userField1\": \"string\",\n \"userField2\": \"string\",\n \"userField3\": \"string\",\n \"userField4\": \"string\",\n \"userField5\": \"string\",\n \"userField6\": \"string\",\n \"userField7\": \"string\",\n \"userField8\": \"string\",\n \"userField9\": \"string\",\n \"userField10\": \"string\",\n \"categoryXId\": 6784,\n \"categoryYId\": 9204,\n \"contactId\": 9229,\n \"isActive\": true,\n \"errorMessage\": \"string\",\n \"metadata\": {\n \"description\": \"Metadata\"\n },\n \"messages\": {\n \"description\": \"Messages\"\n },\n \"updatedAt\": \"1974-11-03T07:16:27.335Z\",\n \"updatedByTraceId\": \"string\",\n \"updatedAtDateTimeExternal\": \"1953-09-30T00:06:46.069Z\",\n \"categoryX\": {\n \"description\": \"Category X object\"\n },\n \"categoryY\": {\n \"description\": \"Category Y object\"\n },\n \"contact\": {\n \"description\": \"Contact object\"\n },\n \"serviceProvider\": {\n \"description\": \"Service provider object\"\n }\n }\n ],\n \"page\": 7741.354063029995,\n \"totalPages\": 1811.474286539414,\n \"pageSize\": 7025.207096558682,\n \"totalCount\": 3814.145645299759\n}"},{"id":"790e6abc-07ce-4f19-9eb5-6f62fac46774","name":"Bad request","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/search"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"77b0d3f8-e210-48af-a4f4-cfd14178667d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/search"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"013e17ff-a38f-4476-9b4f-a066523776da","name":"Forbidden or missing authentication token","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"87923778","description":"(Required) Organization ID (numeric)"},{"key":"user-id","value":"string","description":"User identifier"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/search"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Origin","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Allow-Methods","value":"string","description":{"content":"","type":"text/plain"},"disabled":false},{"key":"Access-Control-Expose-Headers","value":"string","description":{"content":"","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"3.2.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"7ea91815-ff6b-4f7f-95d4-790dfde636d5"},{"name":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync","id":"d64497ff-519a-4300-8750-2e63558a3b24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID (numeric)

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient/sync","urlObject":{"path":["sync"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"],"query":[],"variable":[]}},"response":[],"_postman_id":"d64497ff-519a-4300-8750-2e63558a3b24"}],"id":"f98e7791-32e5-4ba0-a735-f499293bf520","description":"

Enables organizations to access and manage care recipient records and initiate data synchronization from SAH remote integration, providing reliable retrieval, creation, update, bulk update, search, and deletion capabilities with consistent responses and traceability.

\n","_postman_id":"f98e7791-32e5-4ba0-a735-f499293bf520","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Budget","item":[{"name":"/","id":"72dd4c7b-e0ed-44b4-aed8-7cf059e39332","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"?page=1&pageSize=50","description":"

Endpoint Description

\n

This endpoint retrieves a paginated list of budget information related to service providers and care recipients. It allows users to specify the page number and the number of entries per page through query parameters.

\n

Request

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: ?page=1&pageSize=50

    \n
    • \n
\n

Request Parameters

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"sahBudgetId\":{\"filterType\":\"text\",\"type\":\"equals\",\"filter\":\"253144141422\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example sahBudgetId=test. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /budget?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"sahBudgetId\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"test\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Response

\n

The response is returned in JSON format and contains the following structure:

\n
    \n

  • version: A string indicating the version of the API.

    \n
    • \n

  • page: An integer representing the current page number.

    \n
    • \n

  • totalPages: An integer indicating the total number of pages available.

    \n
    • \n

  • pageSize: An integer indicating the number of entries per page.

    \n
    • \n

  • totalCount: An integer representing the total number of entries available across all pages.

    \n
    • \n

  • data: An array of budget objects, each containing the following fields:

    \n
      \n

    • id: A unique identifier for the budget entry.

      \n
      • \n

    • orgId: An integer representing the organization ID.

      \n
      • \n

    • serviceProviderId: A string representing the service provider ID.

      \n
      • \n

    • careRecipientId: A nullable field that may contain the care recipient's ID.

      \n
      • \n

    • sahBudgetId: A string representing the SAH budget ID.

      \n
      • \n

    • sahCareRecipientId: A nullable field for the SAH care recipient ID.

      \n
      • \n

    • careRecipientName: A nullable string for the care recipient's name.

      \n
      • \n

    • entryDate: A string representing the date of the entry.

      \n
      • \n

    • budgetTypeCode: A string for the budget type code.

      \n
      • \n

    • budgetType: A string for the budget type description.

      \n
      • \n

    • startDate: A string representing the start date of the budget.

      \n
      • \n

    • endDate: A string representing the end date of the budget.

      \n
      • \n

    • total: A numeric value indicating the total budget amount.

      \n
      • \n

    • available: A numeric value indicating the available budget amount.

      \n
      • \n

    • used: A numeric value indicating the amount of budget used.

      \n
      • \n

    • writeOff: A numeric value indicating any write-off amounts.

      \n
      • \n

    • rolloverDeduction: A numeric value for any rollover deductions.

      \n
      • \n

    • status: A string representing the status of the budget.

      \n
      • \n

    • errorMessage: A nullable string for any error messages.

      \n
      • \n

    • createdAtDateTimeExternal: A string indicating when the budget was created externally.

      \n
      • \n

    • updatedAtDateTimeExternal: A string indicating when the budget was last updated externally.

      \n
      • \n

    • createdAt: A string indicating when the budget was created.

      \n
      • \n

    • updatedAt: A string indicating when the budget was last updated.

      \n
      • \n
    \n
    • \n
\n

Example Response

\n
{\n  \"version\": \"\",\n  \"page\": 0,\n  \"totalPages\": 0,\n  \"pageSize\": 0,\n  \"totalCount\": 0,\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"orgId\": 0,\n      \"serviceProviderId\": \"\",\n      \"careRecipientId\": null,\n      \"sahBudgetId\": \"\",\n      \"sahCareRecipientId\": null,\n      \"careRecipientName\": null,\n      \"entryDate\": \"\",\n      \"budgetTypeCode\": \"\",\n      \"budgetType\": \"\",\n      \"startDate\": \"\",\n      \"endDate\": \"\",\n      \"total\": 0,\n      \"available\": 0,\n      \"used\": 0,\n      \"writeOff\": 0,\n      \"rolloverDeduction\": 0,\n      \"status\": \"\",\n      \"errorMessage\": null,\n      \"createdAtDateTimeExternal\": \"\",\n      \"updatedAtDateTimeExternal\": \"\",\n      \"createdAt\": \"\",\n      \"updatedAt\": \"\"\n    }\n  ]\n}\n\n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"host":[""],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"50"},{"disabled":true,"key":"sort","value":"[[\"createdAt\",\"desc\"]]"}],"variable":[]}},"response":[{"id":"848b1043-85c0-492a-8d18-c3bb48212584","name":"/list of budgets","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"}],"url":{"raw":"?page=1&pageSize=50","host":[""],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"50"},{"key":"sort","value":"[[\"createdAt\",\"desc\"]]","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 29 Sep 2025 10:06:11 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"540"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"15a9be75-fb96-47e1-b840-d807f35446b8"},{"key":"content-encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"RqMC-H-ASwMF0AA="},{"key":"x-trace-id","value":"api-019994ef-d97b-70ab-9f1b-ef5c0804fef2"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68da5a12-2af973f8056cba5a12cce099;Parent=5494fc193cc45fb8;Sampled=0;Lineage=2:e4e2c13f:0"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"page\": 1,\n \"totalPages\": 1,\n \"pageSize\": 50,\n \"totalCount\": 2,\n \"data\": [\n {\n \"id\": \"b-d93f1600-796b-4caa-be4f-bfe84f972aee\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": null,\n \"sahBudgetId\": \"1000000001\",\n \"sahCareRecipientId\": null,\n \"careRecipientName\": null,\n \"entryDate\": \"2025-06-01\",\n \"budgetTypeCode\": \"CU\",\n \"budgetType\": \"Commonwealth unspent funds\",\n \"startDate\": \"2025-07-01T00:00:00.000Z\",\n \"endDate\": \"2025-09-30T00:00:00.000Z\",\n \"total\": 3329.54,\n \"available\": 717.31,\n \"used\": 2612.23,\n \"writeOff\": 40.02,\n \"rolloverDeduction\": 195.01,\n \"status\": \"OPEN\",\n \"errorMessage\": null,\n \"createdAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"updatedAtDateTimeExternal\": \"2025-07-10T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"id\": \"b-765594b3-bb52-4da3-9ef6-5bcd1401d74e\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": null,\n \"sahBudgetId\": \"1000000002\",\n \"sahCareRecipientId\": null,\n \"careRecipientName\": null,\n \"entryDate\": \"2025-06-01\",\n \"budgetTypeCode\": \"AS\",\n \"budgetType\": \"Assistive technology specified needs\",\n \"startDate\": \"2025-07-01T00:00:00.000Z\",\n \"endDate\": \"2025-09-30T00:00:00.000Z\",\n \"total\": 4122.8,\n \"available\": 2803.3,\n \"used\": 1319.5,\n \"writeOff\": 195.01,\n \"rolloverDeduction\": 151.45,\n \"status\": \"OPEN\",\n \"errorMessage\": null,\n \"createdAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"updatedAtDateTimeExternal\": \"2025-07-10T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n }\n ]\n}"},{"id":"9a31ecf3-d9d1-4255-b0ce-39a708a35441","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":[""],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"6eabf735-bcc8-480a-b89b-549a61430770","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":[""],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"72dd4c7b-e0ed-44b4-aed8-7cf059e39332"},{"name":"/:id","id":"b5e64bf8-1328-4fd2-8254-5941a8c502fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"/:id","description":"

Retrieve a specific budget by ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":[":id"],"host":[""],"query":[],"variable":[{"description":{"content":"

(Required) Invoice ID

\n","type":"text/plain"},"type":"any","value":"b-d93f1600-796b-4caa-be4f-bfe84f972aee","key":"id"}]}},"response":[{"id":"2ab32658-4845-4aad-815c-b57940e78209","name":"Single Budget","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":"b-d93f1600-796b-4caa-be4f-bfe84f972aee","description":"(Required) Invoice ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 29 Sep 2025 10:12:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"794"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4eee63dd-277b-4d8d-b9e0-01ba61dae0f5"},{"key":"content-encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"RqM_JHOgywMFrKg="},{"key":"x-trace-id","value":"api-019994f5-c37a-717a-b91e-c81e4ea74c66"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68da5b93-4a423209149ea6687be943a7;Parent=61154a0d4c271b7e;Sampled=0;Lineage=2:e4e2c13f:0"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"b-d93f1600-796b-4caa-be4f-bfe84f972aee\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": null,\n \"sahBudgetId\": \"1000000001\",\n \"sahCareRecipientId\": null,\n \"careRecipientName\": null,\n \"entryDate\": \"2025-06-01\",\n \"budgetTypeCode\": \"CU\",\n \"budgetType\": \"Commonwealth unspent funds\",\n \"startDate\": \"2025-07-01T00:00:00.000Z\",\n \"endDate\": \"2025-09-30T00:00:00.000Z\",\n \"total\": 3329.54,\n \"available\": 717.31,\n \"used\": 2612.23,\n \"writeOff\": 40.02,\n \"rolloverDeduction\": 195.01,\n \"status\": \"OPEN\",\n \"errorMessage\": null,\n \"createdAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"updatedAtDateTimeExternal\": \"2025-07-10T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\",\n \"serviceProvider\": {\n \"providerId\": \"p-579fa747-1e24-4c66-8b85-47950ba7d459\",\n \"name\": null,\n \"sahServiceProviderName\": \"Service 9990000001\",\n \"sahServiceProviderId\": \"9990000001\",\n \"sahServiceNapsId\": \"00999\",\n \"sahRegisteredProviderId\": null,\n \"careTypeCode\": \"RESI\",\n \"operationalStatus\": \"Operational\",\n \"registrationCategories\": [],\n \"registeredServiceTypes\": [],\n \"deletedAt\": \"1970-01-01T00:00:00.000Z\"\n },\n \"careRecipient\": null,\n \"entitlementItems\": [\n {\n \"itemCode\": \"SAH_7\",\n \"description\": \"Support at Home Class 7\",\n \"amount\": 1251.82,\n \"startDate\": \"2025-07-01\",\n \"endDate\": \"2025-08-01\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"createdAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"itemCode\": \"SAH_8\",\n \"description\": \"Support at Home Class 8\",\n \"amount\": 1569.12,\n \"startDate\": \"2025-07-01\",\n \"endDate\": \"2025-08-01\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"createdAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n }\n ],\n \"usage\": [\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000002\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0003\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000002\",\n \"itemId\": \"5000000002\",\n \"amount\": 196.14,\n \"deliveryDate\": \"2025-07-03\",\n \"updatedAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000003\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0004\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000003\",\n \"itemId\": \"5000000003\",\n \"amount\": 80.01,\n \"deliveryDate\": \"2025-07-04\",\n \"updatedAtDateTimeExternal\": \"2025-07-04T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000001\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0002\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000001\",\n \"itemId\": \"5000000001\",\n \"amount\": 156.48,\n \"deliveryDate\": \"2025-07-02\",\n \"updatedAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n }\n ]\n }\n}"},{"id":"036a94bd-fb94-41e1-8dff-037f15c2d4f7","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"a0e30537-ffe9-471f-8108-9d61ea240baf","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"44e3abc2-b2e1-401a-8f1c-be6e83406d9f","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"b5e64bf8-1328-4fd2-8254-5941a8c502fd"},{"name":"/snapshot/:id","id":"43e7d341-8c8c-409b-90c1-ff0beec94d53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"/snapshot/:id?snapshotDate=2025-09-25","description":"

Retrieve snapshot of a specific budget by ID and snapsho

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["snapshot",":id"],"host":[""],"query":[{"key":"snapshotDate","value":"2025-09-25"}],"variable":[{"type":"any","value":"b-d93f1600-796b-4caa-be4f-bfe84f972aee","key":"id"}]}},"response":[{"id":"074a364c-0496-4ac7-ba80-fc3ade606a07","name":"Single Budget","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":"b-d93f1600-796b-4caa-be4f-bfe84f972aee","description":"(Required) Invoice ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 29 Sep 2025 10:12:39 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"794"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"4eee63dd-277b-4d8d-b9e0-01ba61dae0f5"},{"key":"content-encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"RqM_JHOgywMFrKg="},{"key":"x-trace-id","value":"api-019994f5-c37a-717a-b91e-c81e4ea74c66"},{"key":"X-Amzn-Trace-Id","value":"Root=1-68da5b93-4a423209149ea6687be943a7;Parent=61154a0d4c271b7e;Sampled=0;Lineage=2:e4e2c13f:0"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"data\": {\n \"id\": \"b-d93f1600-796b-4caa-be4f-bfe84f972aee\",\n \"orgId\": 999,\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": null,\n \"sahBudgetId\": \"1000000001\",\n \"sahCareRecipientId\": null,\n \"careRecipientName\": null,\n \"entryDate\": \"2025-06-01\",\n \"budgetTypeCode\": \"CU\",\n \"budgetType\": \"Commonwealth unspent funds\",\n \"startDate\": \"2025-07-01T00:00:00.000Z\",\n \"endDate\": \"2025-09-30T00:00:00.000Z\",\n \"total\": 3329.54,\n \"available\": 717.31,\n \"used\": 2612.23,\n \"writeOff\": 40.02,\n \"rolloverDeduction\": 195.01,\n \"status\": \"OPEN\",\n \"errorMessage\": null,\n \"createdAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"updatedAtDateTimeExternal\": \"2025-07-10T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\",\n \"serviceProvider\": {\n \"providerId\": \"p-579fa747-1e24-4c66-8b85-47950ba7d459\",\n \"name\": null,\n \"sahServiceProviderName\": \"Service 9990000001\",\n \"sahServiceProviderId\": \"9990000001\",\n \"sahServiceNapsId\": \"00999\",\n \"sahRegisteredProviderId\": null,\n \"careTypeCode\": \"RESI\",\n \"operationalStatus\": \"Operational\",\n \"registrationCategories\": [],\n \"registeredServiceTypes\": [],\n \"deletedAt\": \"1970-01-01T00:00:00.000Z\"\n },\n \"careRecipient\": null,\n \"entitlementItems\": [\n {\n \"itemCode\": \"SAH_7\",\n \"description\": \"Support at Home Class 7\",\n \"amount\": 1251.82,\n \"startDate\": \"2025-07-01\",\n \"endDate\": \"2025-08-01\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"createdAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"itemCode\": \"SAH_8\",\n \"description\": \"Support at Home Class 8\",\n \"amount\": 1569.12,\n \"startDate\": \"2025-07-01\",\n \"endDate\": \"2025-08-01\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"createdAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n }\n ],\n \"usage\": [\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000002\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0003\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000002\",\n \"itemId\": \"5000000002\",\n \"amount\": 196.14,\n \"deliveryDate\": \"2025-07-03\",\n \"updatedAtDateTimeExternal\": \"2025-07-03T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000003\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0004\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000003\",\n \"itemId\": \"5000000003\",\n \"amount\": 80.01,\n \"deliveryDate\": \"2025-07-04\",\n \"updatedAtDateTimeExternal\": \"2025-07-04T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n },\n {\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"sahServiceProviderId\": \"4000000001\",\n \"careRecipientId\": null,\n \"sahCareRecipientId\": null,\n \"itemCode\": \"SERV-0002\",\n \"itemDescription\": \"Service Item\",\n \"invoiceId\": null,\n \"sahInvoiceId\": \"3000000001\",\n \"itemId\": \"5000000001\",\n \"amount\": 156.48,\n \"deliveryDate\": \"2025-07-02\",\n \"updatedAtDateTimeExternal\": \"2025-07-02T14:00:00.000Z\",\n \"createdAt\": \"2025-09-29T10:03:32.000Z\",\n \"updatedAt\": \"2025-09-29T10:03:32.000Z\"\n }\n ]\n }\n}"},{"id":"10fb3f90-0354-4bc8-baef-f169c5191db8","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"3afdb9a9-ad6c-46bf-8b7e-e2ba66a5ec7d","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"9dd81980-e03c-4e3a-a051-4dbe6aeb5d29","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"/:id","host":[""],"path":[":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"43e7d341-8c8c-409b-90c1-ff0beec94d53"},{"name":"/rollover","id":"43009080-3f3e-4d56-bb8d-c094aedd9360","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","type":"text"}],"url":"/rollover","description":"

Rollover budgets on-demand (budgets are rolled over after 60days) use this to rollover immediately.

\n

Budget endTime must have passed to be able to rollover

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["rollover"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"43009080-3f3e-4d56-bb8d-c094aedd9360"},{"name":"/sync","id":"9c01984b-8a5d-427d-80d1-00fb39fa5684","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","type":"text"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"syncAll\": true\n}","options":{"raw":{"language":"json"}}},"url":"/sync","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["sync"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"711a3f55-32cd-4c32-a696-7e9860afa4bf","name":"Sync All","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\"syncAll\": true}","options":{"raw":{"language":"json"}}},"url":"/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"org-id","value":"999","description":"","enabled":true},{"key":"Accept","value":"application/json","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Triggered sync for all budgets for org 999\",\n \"data\": {\n \"syncAll\": true\n }\n}"},{"id":"c7d23c12-2447-4904-99d7-e23161c3c50f","name":"Sync by IDs","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\"ids\": [\"b-yyyyyy\",\"b-xxxxxx\"]}","options":{"raw":{"language":"json"}}},"url":"/sync"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"org-id","value":"999","description":"","enabled":true},{"key":"Accept","value":"application/json","description":"","enabled":true}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Triggered sync for 1 budget(s)\",\n \"data\": {\n \"ids\": [\n \"b-740ca896-582e-4a90-849b-9897af2e38a5\"\n ]\n }\n}"}],"_postman_id":"9c01984b-8a5d-427d-80d1-00fb39fa5684"}],"id":"201a8d31-f4c0-45a2-89b8-88c4284a5983","description":"

Budget operations provide read-only access to the Budgets that have been allocated in Services Australia Support At Home platform. Organizations can monitor Budget states, Entitlements, and usages to understand the budget lifecycle.
There is also a snapshot API that provides summary of budget in a point in time (auto daily snapshots).

\n","_postman_id":"201a8d31-f4c0-45a2-89b8-88c4284a5983","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Transaction","item":[{"name":"/transaction","id":"b22f8a39-61cf-4b9a-aad6-3892b337064f","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction","description":"

Endpoint Description

\n

This endpoint retrieves a list of transactions based on the specified query parameters. It allows users to filter transactions by various criteria, such as status, pagination, and sorting options.

\n

Request Parameters

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"status\":{\"filterType\":\"text\",\"type\":\"equals\",\"filter\":\"SUBMITTED\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example sahBudgetId=test. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /transaction?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"status\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"OPEN\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Response Structure

\n

The response will include a JSON object containing the following fields:

\n
    \n

  • version (string): The version of the response format.

    \n
    • \n

  • message (string): A message providing additional context about the response.

    \n
    • \n

  • data (array of objects): An array of transaction objects, each containing:

    \n
      \n

    • id (string): Unique identifier for the transaction.

      \n
      • \n

    • orgId (integer): Identifier for the organization associated with the transaction.

      \n
      • \n

    • serviceProviderId (string): Identifier for the service provider.

      \n
      • \n

    • careRecipientId (string): Identifier for the care recipient.

      \n
      • \n

    • pricingId (string): Identifier for the pricing.

      \n
      • \n

    • deliveryDate (string): Date of delivery for the transaction.

      \n
      • \n

    • unit (integer): The unit count for the transaction.

      \n
      • \n

    • rate (number): The rate associated with the transaction.

      \n
      • \n

    • amount (number): The total amount for the transaction.

      \n
      • \n

    • status (string): Current status of the transaction.

      \n
      • \n

    • createdAt (string): Timestamp when the transaction was created.

      \n
      • \n

    • updatedAt (string): Timestamp when the transaction was last updated.

      \n
      • \n

    • invoiceId (string): Identifier for the associated invoice.

      \n
      • \n

    • contactId (integer): Identifier for the contact related to the transaction.

      \n
      • \n

    • deliveredByThirdParty (boolean): Indicates if the transaction was delivered by a third party.

      \n
      • \n

    • wraparoundCode (string): Code for wraparound services, if applicable.

      \n
      • \n

    • wraparoundText (string): Description for wraparound services, if applicable.

      \n
      • \n

    • itemCategoryCode (string): Code for the category of the item.

      \n
      • \n

    • functionCode (string): Code representing the function of the item.

      \n
      • \n

    • isPrescribedItem (boolean): Indicates if the item is prescribed.

      \n
      • \n

    • purchaseMethodType (string): Method used for the purchase.

      \n
      • \n

    • loanedByOrganisationName (string): Name of the organization that loaned the item.

      \n
      • \n

    • loanedByInvoiceNumber (string): Invoice number associated with the loan.

      \n
      • \n

    • healthProfessionalType (string): Type of health professional involved.

      \n
      • \n

    • healthProfessionalTypeOtherText (string): Additional text for health professional type, if applicable.

      \n
      • \n

    • isItemFirstPayment (boolean): Indicates if this transaction is the first payment for the item.

      \n
      • \n

    • lateSubmissionReasonCode (string): Code for the reason of late submission, if applicable.

      \n
      • \n

    • lateSubmissionReasonJustification (string): Justification for the late submission, if applicable.

      \n
      • \n

    • isReimbursement (boolean): Indicates if the transaction is a reimbursement.

      \n
      • \n

    • isCareManagementFee (boolean): Indicates if the transaction is a care management fee.

      \n
      • \n
    \n
    • \n
\n

Filtering

\n

The fields mentioned above can be used as query parameters to filter the results returned by this endpoint, allowing for more precise and relevant data retrieval.

\n

This endpoint is useful for applications that need to display or process transaction data efficiently.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[{"disabled":true,"description":{"content":"

Page number for pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"pageSize","value":"50"},{"disabled":true,"description":{"content":"

Sort criteria in AG Grid format or simple format

\n","type":"text/plain"},"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]"},{"disabled":true,"key":"status","value":"OPEN"}],"variable":[]}},"response":[{"id":"bf7c5653-9404-49f3-b7f3-b7f3e473c46b","name":"Paginated list of transactions","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": [\n {\n \"id\": \"tx-c2fed199-0203-2beb-0ba2-9dd21ce029e2\",\n \"orgId\": 5504,\n \"serviceProviderId\": \"sp-\",\n \"careRecipientId\": \"string\",\n \"pricingId\": \"string\",\n \"deliveryDate\": \"1951-04-21\",\n \"unit\": 8115.677419017863,\n \"rate\": 3050.0029003862396,\n \"amount\": 9919.091932447878,\n \"status\": \"PENDING\",\n \"createdAt\": \"2024-10-18T05:00:03.383Z\",\n \"updatedAt\": \"2013-03-14T20:54:11.947Z\",\n \"invoiceId\": \"i-\",\n \"contactId\": 5963,\n \"deliveredByThirdParty\": false,\n \"wraparoundCode\": \"string\",\n \"wraparoundText\": \"string\",\n \"itemCategoryCode\": \"string\",\n \"functionCode\": \"string\",\n \"isPrescribedItem\": true,\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"string\",\n \"loanedByInvoiceNumber\": \"string\",\n \"healthProfessionalType\": \"string\",\n \"healthProfessionalTypeOtherText\": \"string\",\n \"isItemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonJustification\": \"string\",\n \"isReimbursement\": true,\n \"isCareManagementFee\": true,\n \"note\": \"string\"\n },\n {\n \"id\": \"tx-8e8acd6b-ae42-3c3c-ca70-a6934201b7c9\",\n \"orgId\": 8250,\n \"serviceProviderId\": \"sp-\",\n \"careRecipientId\": \"string\",\n \"pricingId\": \"string\",\n \"deliveryDate\": \"1975-01-21\",\n \"unit\": 8251.389306931002,\n \"rate\": 1327.2343718923796,\n \"amount\": 9073.089778289434,\n \"status\": \"FAILED\",\n \"createdAt\": \"2017-07-25T07:34:15.313Z\",\n \"updatedAt\": \"2024-01-09T01:18:33.969Z\",\n \"invoiceId\": \"i-\",\n \"contactId\": 1361,\n \"deliveredByThirdParty\": false,\n \"wraparoundCode\": \"string\",\n \"wraparoundText\": \"string\",\n \"itemCategoryCode\": \"string\",\n \"functionCode\": \"string\",\n \"isPrescribedItem\": true,\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"string\",\n \"loanedByInvoiceNumber\": \"string\",\n \"healthProfessionalType\": \"string\",\n \"healthProfessionalTypeOtherText\": \"string\",\n \"isItemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonJustification\": \"string\",\n \"isReimbursement\": true,\n \"isCareManagementFee\": false,\n \"note\": \"string\"\n }\n ],\n \"page\": 7495,\n \"totalPages\": 5887,\n \"pageSize\": 961,\n \"totalCount\": 9382\n}"},{"id":"bbb078da-ce92-4186-a241-fecb36b652c6","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"},{"key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","description":"Filter criteria in AG Grid format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"91ae2cc2-0114-4fb2-a52f-18ce9bc7f3ab","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"},{"key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","description":"Filter criteria in AG Grid format"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"b22f8a39-61cf-4b9a-aad6-3892b337064f"},{"name":"/transaction","id":"e1d0df73-33ce-4fcc-a134-43fb03e9b0d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\",\n \"careRecipientId\": \"cr-e34f6bcd-840f-45d5-a241-4fbbc5fc8094\",\n \"pricingId\": \"SERV-0067\",\n \"deliveryDate\": \"2025-07-01\",\n \"unit\": 1,\n \"rate\": 200\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction","description":"

Create a New Transaction Record

\n

This API endpoint allows you to create a new transaction record for a specified service provider and care recipient. It is designed to facilitate the management of service transactions, including details about pricing, delivery, and contact information.

\n

Request Payload

\n

The request body should be in JSON format and include the following required parameters:

\n
    \n

  • serviceProviderId (string): The unique identifier for the service provider.

    \n
    • \n

  • pricingId (string): The identifier for the pricing structure associated with the transaction.

    \n
    • \n

  • careRecipientId (string): The unique identifier for the care recipient receiving the service.

    \n
    • \n

  • deliveryDate (string): The date when the service is to be delivered, formatted as YYYY-MM-DD.

    \n
    • \n

  • unit (integer): The quantity of the service units being requested.

    \n
    • \n

  • rate (integer): The rate charged per unit of service.

    \n
    • \n
\n

Example Request

\n
{\n  \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abc ...\",\n  \"pricingId\": \"SERV-0001\",\n  \"careRecipientId\": \"cr-1a2b3c4d-5e6f-7a8b-9c0d-123 ...\",\n  \"deliveryDate\": \"2025-07-01\",\n  \"unit\": 1,\n  \"rate\": 100,\n  \"contactId\": 5689\n}\n\n
\n

Response Structure

\n

Upon successful creation of the transaction, the API will respond with a JSON object containing the following fields:

\n
    \n

  • version (string): The version of the API response.

    \n
    • \n

  • message (string): A message indicating the status of the request.

    \n
    • \n

  • data (object): An object containing details about the created transaction:

    \n
      \n

    • id (string): The unique identifier for the transaction.

      \n
      • \n

    • orgId (integer): The organization ID associated with the transaction.

      \n
      • \n

    • serviceProviderId (string): The service provider ID.

      \n
      • \n

    • careRecipientId (string): The care recipient ID.

      \n
      • \n

    • pricingId (string): The pricing ID.

      \n
      • \n

    • deliveryDate (string): The delivery date.

      \n
      • \n

    • unit (integer): The number of units.

      \n
      • \n

    • rate (integer): The rate per unit.

      \n
      • \n

    • amount (integer): The total amount for the transaction.

      \n
      • \n

    • status (string): The current status of the transaction.

      \n
      • \n

    • createdAt (string): The timestamp when the transaction was created.

      \n
      • \n

    • updatedAt (string): The timestamp when the transaction was last updated.

      \n
      • \n

    • invoiceId (string): The ID of the associated invoice.

      \n
      • \n

    • contactId (integer): The contact ID.

      \n
      • \n

    • deliveredByThirdParty (boolean): Indicates if the service was delivered by a third party.

      \n
      • \n

    • wraparoundCode (string): Code related to wraparound services.

      \n
      • \n

    • wraparoundText (string): Text description related to wraparound services.

      \n
      • \n

    • itemCategoryCode (string): Code for the item category.

      \n
      • \n

    • functionCode (string): Code for the function of the transaction.

      \n
      • \n

    • isPrescribedItem (boolean): Indicates if the item is prescribed.

      \n
      • \n

    • purchaseMethodType (string): The method used for purchasing the service.

      \n
      • \n

    • loanedByOrganisationName (string): Name of the organization that loaned the item.

      \n
      • \n

    • loanedByInvoiceNumber (string): Invoice number associated with the loan.

      \n
      • \n

    • healthProfessionalType (string): Type of health professional involved.

      \n
      • \n

    • healthProfessionalTypeOtherText (string): Other text describing the health professional type.

      \n
      • \n

    • isItemFirstPayment (boolean): Indicates if this is the first payment for the item.

      \n
      • \n

    • lateSubmissionReasonCode (string): Code for the reason of late submission.

      \n
      • \n

    • lateSubmissionReasonJustification (string): Justification for the late submission.

      \n
      • \n

    • isReimbursement (boolean): Indicates if this transaction is for reimbursement.

      \n
      • \n

    • isCareManagementFee (boolean): Indicates if this is a care management fee.

      \n
      • \n

    • note (string): Any additional notes related to the transaction.

      \n
      • \n
    \n
    • \n
\n

This endpoint is essential for managing service transactions efficiently and ensuring that all relevant details are captured accurately.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[]}},"response":[{"id":"3b047d91-4fef-4db3-8141-1643388668ff","name":"Single transaction response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"pricingId\": \"SERV-0001\",\n \"careRecipientId\": \"cr-1a2b3c4d-5e6f-7a8b-9c0d-123456789abc\",\n \"deliveryDate\": \"2025-07-01\",\n \"unit\": 1,\n \"rate\": 100,\n \"contactId\": 5689\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"tx-e478b498-a957-2f9b-a645-bde37e7c9b90\",\n \"orgId\": 9627,\n \"serviceProviderId\": \"sp-\",\n \"careRecipientId\": \"string\",\n \"pricingId\": \"string\",\n \"deliveryDate\": \"2015-08-15\",\n \"unit\": 1834.1485385709889,\n \"rate\": 9696.190619799076,\n \"amount\": 7089.547106460948,\n \"status\": \"APPROVED\",\n \"createdAt\": \"1987-09-07T02:18:12.561Z\",\n \"updatedAt\": \"1955-06-01T06:57:36.266Z\",\n \"invoiceId\": \"i-\",\n \"contactId\": 4501,\n \"deliveredByThirdParty\": true,\n \"wraparoundCode\": \"string\",\n \"wraparoundText\": \"string\",\n \"itemCategoryCode\": \"string\",\n \"functionCode\": \"string\",\n \"isPrescribedItem\": false,\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"string\",\n \"loanedByInvoiceNumber\": \"string\",\n \"healthProfessionalType\": \"string\",\n \"healthProfessionalTypeOtherText\": \"string\",\n \"isItemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonJustification\": \"string\",\n \"isReimbursement\": false,\n \"isCareManagementFee\": true,\n \"note\": \"string\"\n }\n}"},{"id":"bb04ebf3-6375-481b-8b22-de43afed28d9","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"pricingId\": \"SERV-0001\",\n \"careRecipientId\": \"cr-1a2b3c4d-5e6f-7a8b-9c0d-123456789abc\",\n \"deliveryDate\": \"2025-07-01\",\n \"unit\": 1,\n \"rate\": 100,\n \"contactId\": 5689\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"9373934e-8e88-4646-b9d5-e988202e8638","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"pricingId\": \"SERV-0001\",\n \"careRecipientId\": \"cr-1a2b3c4d-5e6f-7a8b-9c0d-123456789abc\",\n \"deliveryDate\": \"2025-07-01\",\n \"unit\": 1,\n \"rate\": 100,\n \"contactId\": 5689\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"e1d0df73-33ce-4fcc-a134-43fb03e9b0d1"},{"name":"/transaction/summary","id":"9e465648-ebea-45c5-835b-280d63369168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/summary","description":"

Retrieve aggregated summary data for transactions with optional filtering

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction","summary"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[{"disabled":true,"description":{"content":"

Filter criteria in AG Grid format

\n","type":"text/plain"},"key":"filters","value":"%7B%22status%22%3A%7B%22filterType%22%3A%22set%22%2C%22values%22%3A%5B%22OPEN%22%5D%7D%7D"}],"variable":[]}},"response":[{"id":"75420d1c-ddd9-4799-b43d-d57dfa6ea810","name":"Transaction summary data","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/summary","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction","summary"],"query":[{"key":"filters","value":"%7B%22status%22%3A%7B%22filterType%22%3A%22set%22%2C%22values%22%3A%5B%22OPEN%22%5D%7D%7D","description":"Filter criteria in AG Grid format","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {}\n}"},{"id":"45dd4496-cc67-43bc-9f70-97632d19fd74","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/summary?filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction","summary"],"query":[{"key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","description":"Filter criteria in AG Grid format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"35a31872-dd4a-47ec-a23b-f64efaa5bf67","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"description":"(Required) Organization ID","key":"org-id","value":"2708"},{"description":"(Required) User ID","key":"user-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/public/transaction/summary?filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://api.quickclaim.io/public"],"path":["transaction","summary"],"query":[{"description":"Filter criteria in AG Grid format","key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Request trace ID","type":"text/plain"},"key":"x-trace-id","value":"stringstringstringstringstringstring"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"9e465648-ebea-45c5-835b-280d63369168"},{"name":"/transaction/:id","id":"da116947-6b56-4878-b944-1acbea8003f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","description":"

Retrieve a specific transaction by ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Transaction ID

\n","type":"text/plain"},"type":"any","value":"tx-346e76d9-38d0-4723-9d2a-ff931060f1ad","key":"id"}]}},"response":[{"id":"1922e7fe-b463-45e8-b12c-7342f8948c99","name":"Single transaction response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"tx-e478b498-a957-2f9b-a645-bde37e7c9b90\",\n \"orgId\": 9627,\n \"serviceProviderId\": \"sp-\",\n \"careRecipientId\": \"string\",\n \"pricingId\": \"string\",\n \"deliveryDate\": \"2015-08-15\",\n \"unit\": 1834.1485385709889,\n \"rate\": 9696.190619799076,\n \"amount\": 7089.547106460948,\n \"status\": \"APPROVED\",\n \"createdAt\": \"1987-09-07T02:18:12.561Z\",\n \"updatedAt\": \"1955-06-01T06:57:36.266Z\",\n \"invoiceId\": \"i-\",\n \"contactId\": 4501,\n \"deliveredByThirdParty\": true,\n \"wraparoundCode\": \"string\",\n \"wraparoundText\": \"string\",\n \"itemCategoryCode\": \"string\",\n \"functionCode\": \"string\",\n \"isPrescribedItem\": false,\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"string\",\n \"loanedByInvoiceNumber\": \"string\",\n \"healthProfessionalType\": \"string\",\n \"healthProfessionalTypeOtherText\": \"string\",\n \"isItemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonJustification\": \"string\",\n \"isReimbursement\": false,\n \"isCareManagementFee\": true,\n \"note\": \"string\"\n }\n}"},{"id":"30e39828-e179-4329-94c8-0fa3ecaa14d9","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"fc0f0d34-c505-4787-9294-8a3c14aabf72","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"d9bb8777-8359-4524-abd7-5eda48c3f2cf","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"da116947-6b56-4878-b944-1acbea8003f7"},{"name":"/transaction/:id","id":"69fe6c37-44d0-4cfc-bc2f-8b7b65cb85fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"rate\": 110\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","description":"

Update a Specific Transaction by ID

\n

This endpoint allows you to update a specific transaction identified by its unique ID.

\n

Transaction Statuses

\n
    \n

  • Non-Updatable Statuses: The following statuses cannot be updated once set:

    \n
      \n

    • SUBMITTED

      \n
      • \n

    • CLAIMING

      \n
      • \n

    • COMPLETED

      \n
      • \n

    • TERMINATED

      \n
      • \n

    • DELETED

      \n
      • \n

    • PENDING_SUBMISSION

      \n
      • \n
    \n
    • \n

  • All Possible Statuses: The transaction can have one of the following statuses:

    \n
      \n

    • OPEN

      \n
      • \n

    • INVALID

      \n
      • \n

    • APPROVED

      \n
      • \n

    • PENDING_SUBMISSION

      \n
      • \n

    • REJECTED

      \n
      • \n

    • SUBMITTED

      \n
      • \n

    • DELETED

      \n
      • \n

    • CLAIMING

      \n
      • \n

    • COMPLETED

      \n
      • \n

    • TERMINATED

      \n
      • \n
    \n
    • \n
\n

Example Response

\n
{\n  \"version\": \"\",\n  \"message\": \"\",\n  \"data\": {\n    \"id\": \"\",\n    \"orgId\": 0,\n    \"serviceProviderId\": \"\",\n    \"careRecipientId\": \"\",\n    \"pricingId\": \"\",\n    \"deliveryDate\": \"\",\n    \"unit\": 0,\n    \"rate\": 0,\n    \"amount\": 0,\n    \"status\": \"\",\n    \"createdAt\": \"\",\n    \"updatedAt\": \"\",\n    \"invoiceId\": \"\",\n    \"contactId\": 0,\n    \"deliveredByThirdParty\": true,\n    \"wraparoundCode\": \"\",\n    \"wraparoundText\": \"\",\n    \"itemCategoryCode\": \"\",\n    \"functionCode\": \"\",\n    \"isPrescribedItem\": true,\n    \"purchaseMethodType\": \"\",\n    \"loanedByOrganisationName\": \"\",\n    \"loanedByInvoiceNumber\": \"\",\n    \"healthProfessionalType\": \"\",\n    \"healthProfessionalTypeOtherText\": \"\",\n    \"isItemFirstPayment\": true,\n    \"lateSubmissionReasonCode\": \"\",\n    \"lateSubmissionReasonJustification\": \"\",\n    \"isReimbursement\": true,\n    \"isCareManagementFee\": true,\n    \"note\": \"\"\n  }\n}\n\n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Transaction ID

\n","type":"text/plain"},"type":"any","value":"tx-346e76d9-38d0-4723-9d2a-ff931060f1ad","key":"id"}]}},"response":[{"id":"c1ffaf5b-fb2e-4ea8-834d-0551861b08f1","name":"Single transaction response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"rate\": 240\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"tx-e478b498-a957-2f9b-a645-bde37e7c9b90\",\n \"orgId\": 9627,\n \"serviceProviderId\": \"sp-\",\n \"careRecipientId\": \"string\",\n \"pricingId\": \"string\",\n \"deliveryDate\": \"2015-08-15\",\n \"unit\": 1834.1485385709889,\n \"rate\": 9696.190619799076,\n \"amount\": 7089.547106460948,\n \"status\": \"APPROVED\",\n \"createdAt\": \"1987-09-07T02:18:12.561Z\",\n \"updatedAt\": \"1955-06-01T06:57:36.266Z\",\n \"invoiceId\": \"i-\",\n \"contactId\": 4501,\n \"deliveredByThirdParty\": true,\n \"wraparoundCode\": \"string\",\n \"wraparoundText\": \"string\",\n \"itemCategoryCode\": \"string\",\n \"functionCode\": \"string\",\n \"isPrescribedItem\": false,\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"string\",\n \"loanedByInvoiceNumber\": \"string\",\n \"healthProfessionalType\": \"string\",\n \"healthProfessionalTypeOtherText\": \"string\",\n \"isItemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonJustification\": \"string\",\n \"isReimbursement\": false,\n \"isCareManagementFee\": true,\n \"note\": \"string\"\n }\n}"},{"id":"db4d8906-eb2c-46fc-8be1-20e6bbba57af","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"rate\": 240\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"3e391f6c-3de8-4606-86f8-9afbba86817d","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"rate\": 240\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"c6bc82ed-a04f-4f87-bcb0-0a74d7d4a644","name":"Resource not found","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"rate\": 240\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"69fe6c37-44d0-4cfc-bc2f-8b7b65cb85fc"},{"name":"/transaction/:id","id":"173a66ff-07b8-43b3-92f1-9da9ae9c5984","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","description":"

Delete a specific transaction by ID

\n

This endpoint allows you to delete a specific transaction identified by its ID.

\n

Note: Only transactions with the following statuses can be deleted:

\n
    \n

  • OPEN

    \n
    • \n

  • INVALID

    \n
    • \n

  • APPROVED

    \n
    • \n

  • REJECTED

    \n
    • \n
\n

Response Structure

\n
    \n

  • version: The version of the response.

    \n
    • \n

  • message: A message providing additional information about the request.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Transaction ID

\n","type":"text/plain"},"type":"any","value":"tx-4cbb0163-fbde-4380-8eac-bdbac2b5139b","key":"id"}]}},"response":[{"id":"5d5a63d7-7c18-4a1e-bb50-710249ba0aac","name":"Generic success response","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"cbf288db-237b-45a2-842f-02d79dd438bc","name":"Bad request error","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"99e988aa-e2f8-49b0-966f-dc442158ed8b","name":"Authentication required or access denied","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"6d245d61-f6ab-4605-8a6e-bb27a63547c7","name":"Resource not found","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"173a66ff-07b8-43b3-92f1-9da9ae9c5984"},{"name":"/transaction/submit","id":"e1ffd767-9f37-40e0-bed0-7ee2a27215ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"tx-346e76d9-38d0-4723-9d2a-ff931060f1ad\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/submit","description":"

Submit Transactions for Processing by IDs or Filters

\n

Submit transactions for processing by IDs. This endpoint allows you to submit transactions and generateing SAH invoices.

\n

Request

\n
    \n

  • Method: POST

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/submit

    \n
    • \n

  • Request Body: The request should contain a JSON object with the following parameter:

    \n
      \n
    • ids (Array of Strings): A list of transaction IDs that you want to submit for processing. Each ID should be a valid transaction identifier.
      • \n
    \n
    • \n
\n

Example of Request Body:

\n
{\n  \"ids\": [\"tx-2cd74042-14a3-47e4-bdeb-7df...\"]\n}\n\n
\n

Response

\n

Upon successful submission, the API will return a JSON object with the following structure:

\n
    \n

  • version (String): The version of the response.

    \n
    • \n

  • message (String): A message indicating the status of the request.

    \n
    • \n

  • data (Object): Contains additional information about the response.

    \n
      \n

    • description (String): A description related to the transaction processing.

      \n
      • \n

    • nullable (Boolean): Indicates if the data can be null.

      \n
      • \n
    \n
    • \n
\n

Example of Response:

\n
{\n  \"version\": \"\",\n  \"message\": \"\",\n  \"data\": {\n    \"description\": \"\",\n    \"nullable\": true\n  }\n}\n\n
\n

Notes

\n
    \n

  • Ensure that the transaction IDs provided in the request are valid and exist in the system.

    \n
    • \n

  • The response may vary based on the processing result. Always check the message field for additional context.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["transaction","submit"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[]}},"response":[{"id":"8393e5f8-b352-408b-8e76-b6a06b09dc6f","name":"Submit operation response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"tx-2cd74042-14a3-47e4-bdeb-7df9c3a92be9\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/submit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"98f1ae0c-498b-4c0e-a1f1-5739485998f4","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"tx-2cd74042-14a3-47e4-bdeb-7df9c3a92be9\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/submit?filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction","submit"],"query":[{"key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","description":"Filter criteria in AG Grid format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"04d58d13-956d-4b70-95a8-caba16b82f43","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"ids\": [\n \"tx-2cd74042-14a3-47e4-bdeb-7df9c3a92be9\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/transaction/submit?filters={\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["transaction","submit"],"query":[{"key":"filters","value":"{\"status\":{\"filterType\":\"set\",\"values\":[\"OPEN\"]}}","description":"Filter criteria in AG Grid format"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"e1ffd767-9f37-40e0-bed0-7ee2a27215ca"}],"id":"32a7c63d-6994-4c0c-81da-f9d0671e9abe","description":"

Transaction management enables creation, modification, and submission of service delivery records with comprehensive business logic validation for aged care compliance. Service providers can track delivery dates, units, rates, and specialized fields required for different service types including assistive technology, home modifications, and care management services.

\n","_postman_id":"32a7c63d-6994-4c0c-81da-f9d0671e9abe","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Attachment","item":[{"name":"/attachment","id":"29e1ed21-e98e-4970-9c9e-448428d7f617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment?page=1&pageSize=50","description":"

Retrieve a Paginated List of Attachments

\n

This API endpoint allows you to retrieve a paginated list of attachments with optional filtering and sorting.

\n

Request Parameters:

\n
    \n

  • page (integer): The page number of the results to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 50.

    \n
    • \n

  • sort (array of objects): An array specifying the sorting criteria. Each object should contain:

    \n
      \n

    • colId (string): The column ID to sort by (e.g., \"createdAt\").

      \n
      • \n

    • sort (string): The sort order, either \"asc\" for ascending or \"desc\" for descending.

      \n
      • \n
    \n
    • \n

  • type (string): The type of attachment to filter the results (e.g., \"OTHER\").

    \n
    • \n
\n

Expected Response:

\n

The response will return a JSON object containing the following fields:

\n
    \n

  • version (string): The version of the API.

    \n
    • \n

  • message (string): A message about the response.

    \n
    • \n

  • data (array): A list of attachment objects, each containing:

    \n
      \n

    • id (string): The unique identifier for the attachment.

      \n
      • \n

    • orgId (integer): The organization ID associated with the attachment.

      \n
      • \n

    • type (string): The type of the attachment.

      \n
      • \n

    • fileName (string): The name of the file.

      \n
      • \n

    • status (string): The current status of the attachment.

      \n
      • \n

    • serviceProviderId (string): The ID of the service provider.

      \n
      • \n

    • originalFileName (string): The original name of the file.

      \n
      • \n

    • mimeType (string): The MIME type of the attachment.

      \n
      • \n

    • description (string): A description of the attachment.

      \n
      • \n

    • uploadedBy (string): The user who uploaded the attachment.

      \n
      • \n

    • isDeleted (boolean): Indicates if the attachment is deleted.

      \n
      • \n

    • createdAt (string): The timestamp when the attachment was created.

      \n
      • \n

    • updatedAt (string): The timestamp when the attachment was last updated.

      \n
      • \n

    • transactions (array): A list of transaction objects associated with the attachment, each containing:

      \n
        \n
      • id (string): The unique identifier for the transaction.
        • \n
      \n
      • \n
    \n
    • \n

  • page (integer): The current page number of the results.

    \n
    • \n

  • totalPages (integer): The total number of pages available.

    \n
    • \n

  • pageSize (integer): The number of results per page.

    \n
    • \n

  • totalCount (integer): The total number of attachments available.

    \n
    • \n
\n

Notes:

\n
    \n

  • Ensure to handle pagination correctly by adjusting the page and pageSize parameters as needed.

    \n
    • \n

  • Sorting can be customized by modifying the sort parameter to fit your requirements.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[{"description":{"content":"

Page number for pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"pageSize","value":"50"},{"disabled":true,"key":"type","value":"OTHER"}],"variable":[]}},"response":[{"id":"ba8a64d5-4e46-47a6-a165-f409b62943c6","name":"Paginated list of attachments","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&type=OTHER","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"},{"key":"type","value":"OTHER","description":"Filter attachments by type"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": [\n {\n \"id\": \"att-\",\n \"orgId\": 728,\n \"type\": \"OTHER\",\n \"fileName\": \"string\",\n \"status\": \"INVALID\",\n \"serviceProviderId\": \"string\",\n \"originalFileName\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\",\n \"isDeleted\": false,\n \"createdAt\": \"1989-05-09T13:16:30.152Z\",\n \"updatedAt\": \"2024-12-01T00:58:25.731Z\",\n \"transactions\": [\n {\n \"id\": \"tx-\"\n },\n {\n \"id\": \"tx-\"\n }\n ]\n },\n {\n \"id\": \"att-\",\n \"orgId\": 9039,\n \"type\": \"PRESC\",\n \"fileName\": \"string\",\n \"status\": \"INVALID\",\n \"serviceProviderId\": \"string\",\n \"originalFileName\": \"string\",\n \"mimeType\": \"image/tiff\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\",\n \"isDeleted\": false,\n \"createdAt\": \"1955-06-19T11:56:53.612Z\",\n \"updatedAt\": \"1993-01-30T02:02:10.099Z\",\n \"transactions\": [\n {\n \"id\": \"tx-\"\n },\n {\n \"id\": \"tx-\"\n }\n ]\n }\n ],\n \"page\": 3153,\n \"totalPages\": 846,\n \"pageSize\": 9220,\n \"totalCount\": 8959\n}"},{"id":"67b31069-0cd0-4823-9ee8-71a9573b6945","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&type=OTHER","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"},{"key":"type","value":"OTHER","description":"Filter attachments by type"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"2d9e95c4-efc5-42dd-8c31-80677655544f","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&type=OTHER","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"},{"key":"type","value":"OTHER","description":"Filter attachments by type"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"29e1ed21-e98e-4970-9c9e-448428d7f617"},{"name":"/attachment/:id","id":"079e904d-c375-4752-81f5-faf6c6c138a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","description":"

Retrieve a specific attachment by ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Attachment ID

\n","type":"text/plain"},"type":"any","value":"att-adaf45e7-6e10-44e7-bd16-2f07b714a5bc","key":"id"}]}},"response":[{"id":"5fc89377-4e48-42a8-9019-9a247498e930","name":"Single attachment response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"att-\",\n \"orgId\": 6944,\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"status\": \"PENDING_SUBMISSION\",\n \"serviceProviderId\": \"string\",\n \"originalFileName\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\",\n \"isDeleted\": false,\n \"createdAt\": \"1950-12-11T10:04:37.000Z\",\n \"updatedAt\": \"1999-08-19T05:15:03.013Z\",\n \"transactions\": [\n {\n \"id\": \"tx-\"\n },\n {\n \"id\": \"tx-\"\n }\n ]\n }\n}"},{"id":"476a7e4c-3038-471c-aaca-cce8656b582f","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"71c2376d-7524-4af0-8726-e23356877fd1","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"f9d6eb1e-27f3-4a76-abaa-33a9d167a33c","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"079e904d-c375-4752-81f5-faf6c6c138a3"},{"name":"/attachment/gen-upload","id":"882711a6-0392-479d-9140-ca1c41a3fea7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"INVOICE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload","description":"

Generate a pre-signed URL for uploading an attachment

\n

This endpoint allows you to generate a pre-signed URL for uploading an attachment.

\n

HOW TO UPLOAD

\n

We are using S3 Presigned URL to upload files. The gen-upload call will create a placeholder and generate a Presigned URL. You can then use a PUT request with the Presigned URL to push the binary file.

\n

Make sure to include the same content type that was used when generating the URL.
e.g:
curl -X PUT -T \"path/to/your/local/file\" -H \"Content-Type: application/pdf\" \"\"

\n

More Info (AWS Docs)

\n

Request Body

\n
    \n

  • type (string): The type of the attachment (e.g., INVOICE).

    \n
    • \n

  • fileName (string): The name of the file being uploaded.

    \n
    • \n

  • serviceProviderId (string): The ID of the service provider associated with the upload.

    \n
    • \n

  • mimeType (string): The MIME type of the file (e.g., image/png).

    \n
    • \n

  • description (string): A description of the attachment.

    \n
    • \n

  • uploadedBy (string): The identifier of the user uploading the file.

    \n
    • \n
\n

Response

\n

The response will contain:

\n
    \n

  • version: The version of the response.

    \n
    • \n

  • message: A message related to the request.

    \n
    • \n

  • data: An object containing:

    \n
      \n

    • uploadUrl: The generated pre-signed URL for file upload.

      \n
      • \n

    • fields: Additional fields related to the upload.

      \n
      • \n
    \n
    • \n
\n

Make sure to handle the response appropriately to utilize the provided pre-signed URL for uploading your file.

\n

This API endpoint allows clients to generate a pre-signed URL for uploading an attachment. This is particularly useful for services that require secure uploads without directly exposing the storage backend.

\n

Request

\n
    \n

  • Method: POST

    \n
    • \n

  • Endpoint: https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload

    \n
    • \n
\n

Request Body

\n

The request should be sent with a JSON payload in the following format:

\n
{\n  \"type\": \"INVOICE\",                     // Type of the attachment (e.g., INVOICE, QUOTE)\n  \"fileName\": \"string\",                // Name of the file to be uploaded\n  \"serviceProviderId\": \"string\",       // Identifier for the service provider\n  \"mimeType\": \"application/pdf\",             // MIME type of the file (e.g., image/png)\n  \"description\": \"string\",              // Description of the file\n  \"uploadedBy\": \"string\"                // Identifier for the user uploading the file\n}\n\n
\n

Headers

\n

Ensure to include the following headers in your request:

\n
    \n
  • Content-Type: application/json // Specifies that the request body is in JSON format
    • \n
\n

Response

\n

The response will be in JSON format and will contain the following structure:

\n
{\n  \"version\": \"\",                       // Version of the response\n  \"message\": \"\",                       // Message indicating the status of the request\n  \"data\": {\n    \"uploadUrl\": \"\",                   // Pre-signed URL for uploading the file\n    \"fields\": {}                       // Additional fields required for the upload\n  }\n}\n\n
\n

Notes

\n
    \n

  • The uploadUrl provided in the response should be used to upload the file to the specified location.

    \n
    • \n

  • The fields object may contain additional parameters required for the upload process.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment","gen-upload"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[]}},"response":[{"id":"337c5bfc-4991-40f2-8013-4e9364570f01","name":"Pre-signed upload URL response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"uploadUrl\": \"http://Lk.omcaTG,-ZKlCpXiDtXgwSwUXzomeZ\",\n \"fields\": {}\n }\n}"},{"id":"868bb530-e27a-4c38-9081-873efb7e4597","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"2a64bca1-e9d0-471b-a4b8-462326d6351a","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"882711a6-0392-479d-9140-ca1c41a3fea7"},{"name":"","id":"aaaf1d4c-2bef-4df4-9916-6b0879af320d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"","description":"

e.g: application/pdf

\n"}],"body":{"mode":"file","file":{"src":"/home/arash/Pictures/sql-responsibility.png"}},"url":"uploadUrl","description":"

Generate a pre-signed URL for uploading an attachment

\n

This endpoint allows you to generate a pre-signed URL for uploading an attachment.

\n

HOW TO UPLOAD

\n

We are using S3 Presigned URL to upload files. The gen-upload call will create a placeholder and generate a Presigned URL. You can then use a PUT request with the Presigned URL to push the binary file.

\n

Make sure to include the same content type that was used when generating the URL.
e.g:
curl -X PUT -T \"path/to/your/local/file\" -H \"Content-Type: application/pdf\" \"\"

\n

More Info (AWS Docs)

\n

Request Body

\n
    \n

  • type (string): The type of the attachment (e.g., INVOICE).

    \n
    • \n

  • fileName (string): The name of the file being uploaded.

    \n
    • \n

  • serviceProviderId (string): The ID of the service provider associated with the upload.

    \n
    • \n

  • mimeType (string): The MIME type of the file (e.g., image/png).

    \n
    • \n

  • description (string): A description of the attachment.

    \n
    • \n

  • uploadedBy (string): The identifier of the user uploading the file.

    \n
    • \n
\n

Response

\n

The response will contain:

\n
    \n

  • version: The version of the response.

    \n
    • \n

  • message: A message related to the request.

    \n
    • \n

  • data: An object containing:

    \n
      \n

    • uploadUrl: The generated pre-signed URL for file upload.

      \n
      • \n

    • fields: Additional fields related to the upload.

      \n
      • \n
    \n
    • \n
\n

Make sure to handle the response appropriately to utilize the provided pre-signed URL for uploading your file.

\n

This API endpoint allows clients to generate a pre-signed URL for uploading an attachment. This is particularly useful for services that require secure uploads without directly exposing the storage backend.

\n

Request

\n
    \n

  • Method: POST

    \n
    • \n

  • Endpoint: https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload

    \n
    • \n
\n

Request Body

\n

The request should be sent with a JSON payload in the following format:

\n
{\n  \"type\": \"INVOICE\",                     // Type of the attachment (e.g., INVOICE, QUOTE)\n  \"fileName\": \"string\",                // Name of the file to be uploaded\n  \"serviceProviderId\": \"string\",       // Identifier for the service provider\n  \"mimeType\": \"application/pdf\",             // MIME type of the file (e.g., image/png)\n  \"description\": \"string\",              // Description of the file\n  \"uploadedBy\": \"string\"                // Identifier for the user uploading the file\n}\n\n
\n

Headers

\n

Ensure to include the following headers in your request:

\n
    \n
  • Content-Type: application/json // Specifies that the request body is in JSON format
    • \n
\n

Response

\n

The response will be in JSON format and will contain the following structure:

\n
{\n  \"version\": \"\",                       // Version of the response\n  \"message\": \"\",                       // Message indicating the status of the request\n  \"data\": {\n    \"uploadUrl\": \"\",                   // Pre-signed URL for uploading the file\n    \"fields\": {}                       // Additional fields required for the upload\n  }\n}\n\n
\n

Notes

\n
    \n

  • The uploadUrl provided in the response should be used to upload the file to the specified location.

    \n
    • \n

  • The fields object may contain additional parameters required for the upload process.

    \n
    • \n
\n","urlObject":{"host":["uploadUrl"],"query":[],"variable":[]}},"response":[{"id":"f2401d89-a44e-4460-993c-a04ee9d9745f","name":"Pre-signed upload URL response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"uploadUrl\": \"http://Lk.omcaTG,-ZKlCpXiDtXgwSwUXzomeZ\",\n \"fields\": {}\n }\n}"},{"id":"d8e37bb1-92a6-47a0-a691-37ef3b29138c","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"09074fd6-8915-4937-b4e6-bf0b1c9e81ac","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"type\": \"QUOTE\",\n \"fileName\": \"string\",\n \"serviceProviderId\": \"string\",\n \"mimeType\": \"image/png\",\n \"description\": \"string\",\n \"uploadedBy\": \"string\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-upload"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"aaaf1d4c-2bef-4df4-9916-6b0879af320d"},{"name":"/attachment/:id/link","id":"66ddaaad-af93-44a2-89d5-8c88622e7ead","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/link","description":"

Link an attachment to one or more transactions

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment",":id","link"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Attachment ID

\n","type":"text/plain"},"type":"any","value":"att-731674f2-85cf-f943-eccb-ccb474090410","key":"id"}]}},"response":[{"id":"151df159-d708-4285-a1fa-f0d78015adde","name":"Generic success response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/link","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","link"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"4f2640ae-722b-4068-8012-9bbc39187289","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/link","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","link"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"9d19bb8e-4c50-4a4b-b5dd-7f44a759a75a","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/link","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","link"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"fa3fa2e1-8f0c-421f-ac94-9b98991afc00","name":"Resource not found","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/link","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","link"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"66ddaaad-af93-44a2-89d5-8c88622e7ead"},{"name":"/attachment/:id/unlink","id":"1cf2bc72-cc43-46b9-9d89-2f51d91f2075","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/unlink","description":"

Unlink an attachment from one or more transactions

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment",":id","unlink"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Attachment ID

\n","type":"text/plain"},"type":"any","value":"att-731674f2-85cf-f943-eccb-ccb474090410","key":"id"}]}},"response":[{"id":"49e70d19-d3a3-4cdc-9890-5ddf5cbeffaa","name":"Generic success response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/unlink","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","unlink"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"a4762b52-fb63-4749-9512-a7d43b98d761","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/unlink","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","unlink"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"20404fc2-fbfe-4d1d-93d1-ea150c769ec2","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/unlink","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","unlink"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"444c03b3-098a-47c7-b41d-4d1b26378f18","name":"Resource not found","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id/unlink","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id","unlink"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"1cf2bc72-cc43-46b9-9d89-2f51d91f2075"},{"name":"/attachment/link","id":"c2f337bb-25c9-4234-901e-be0ceab1ffa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Org ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"attachmentIds\": [\n \"att-adaf45e7-6e10-44e7-bd16-2f07b714a5bc\"\n ],\n \"transactionIds\": [\n \"tx-346e76d9-38d0-4723-9d2a-ff931060f1ad\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/link","description":"

Link multiple attachments to transactions in bulk

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment","link"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[]}},"response":[{"id":"307c64ec-8e42-4bce-bc95-056cf507bb3f","name":"Generic success response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"attachmentIds\": [\n \"att-\",\n \"att-\"\n ],\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"d32836fc-7c7b-4542-bef7-25092b902d01","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"attachmentIds\": [\n \"att-\",\n \"att-\"\n ],\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/link"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"a598c11f-32ae-41d0-89b6-d2be9e3085a0","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"attachmentIds\": [\n \"att-\",\n \"att-\"\n ],\n \"transactionIds\": [\n \"tx-\",\n \"tx-\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/link"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"c2f337bb-25c9-4234-901e-be0ceab1ffa6"},{"name":"/attachment/:id","id":"dcbff067-a0bd-43c6-b6b6-0458a0d35461","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","description":"

Delete a specific attachment by ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Attachment ID

\n","type":"text/plain"},"type":"any","value":"att-731674f2-85cf-f943-eccb-ccb474090410","key":"id"}]}},"response":[{"id":"c569d6c4-ca34-4c24-bc10-833e854bac85","name":"Generic success response","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"description\": \"Response data\",\n \"nullable\": true\n }\n}"},{"id":"2b723237-8795-47ec-8e52-294fa392662e","name":"Bad request error","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"ae69225e-4764-4e13-9fa0-659b95a025c3","name":"Authentication required or access denied","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"user-id","value":"string","description":"(Required) User ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"92996754-f4c6-422e-8131-aa0ece889c6e","name":"Resource not found","originalRequest":{"method":"DELETE","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["attachment",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"dcbff067-a0bd-43c6-b6b6-0458a0d35461"},{"name":"/attachment/gen-download","id":"bb5149c9-a7ee-4a49-97f1-946ef85628fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"string-20250917-093444\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download","description":"

Endpoint Description

\n

This endpoint allows users to generate a download URL for a specified file. By sending a POST request to https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download with the appropriate payload, users can obtain a presigned URL that can be used to download a file directly from S3.

\n

How to Download

\n

We are using presigned URL, presigned S3 URL to download files. After generating the download URL, the key is in the downloadUrl key in the response. We can then use a GET request to download the initial binary directly.

\n

e.g:
curl -L -o file.pdf \"\"

\n

Request

\n
    \n

  • Method: POST

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download

    \n
    • \n

  • Content-Type: application/json

    \n
    • \n
\n

Request Body Parameters

\n
    \n
  • fileName (string): The name of the file for which the download link is being generated for. This parameter is required and must be the fileName generated exactly by our upload URL e.g. original-filename-2025-02-02-1111111.pdf
    • \n
\n

Response

\n

The response will return a JSON object containing the following fields:

\n
    \n

  • version (string): The version of the API response.

    \n
    • \n

  • message (string): A message indicating the status of the request.

    \n
    • \n

  • data (object): An object containing the download information.

    \n
      \n
    • downloadUrl (string): The URL where the file can be downloaded.
      • \n
    \n
    • \n
\n

Notes

\n
    \n

  • Ensure that the fileName provided corresponds to a valid file in the system.

    \n
    • \n

  • The downloadUrl will be returned only if the request is successful.

    \n
    • \n

  • Handle any error messages appropriately based on the message field in the response.

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["attachment","gen-download"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[]}},"response":[{"id":"622f83d5-5647-467e-bc75-bfd86b2806e2","name":"Pre-signed download URL response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"downloadUrl\": \"https://tUNjkPhAD.pnoJ-qFjaniOyocJcD8.15RIRTorBGc\"\n }\n}"},{"id":"3d03355b-c536-49f1-be52-96cb58c2b6dd","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"9485a5b9-f6e6-420a-8017-a42c7f41103d","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"bb5149c9-a7ee-4a49-97f1-946ef85628fc"},{"name":"","id":"d935a8da-600b-4bd3-b215-513092ad0207","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"0a4774ea-b91c-4b02-bba8-3334f2b465f4","name":"Pre-signed download URL response","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"downloadUrl\": \"https://tUNjkPhAD.pnoJ-qFjaniOyocJcD8.15RIRTorBGc\"\n }\n}"},{"id":"a2c45a13-947b-487b-ab67-12e4b12a2c69","name":"Bad request error","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"ca7b559e-8461-444f-8e66-5006290939e6","name":"Authentication required or access denied","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"fileName\": \"h4-8-t1eum6s-4dnnam2p-oa739yycft-68277357-824064-375\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/attachment/gen-download"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"d935a8da-600b-4bd3-b215-513092ad0207"}],"id":"f61c0df0-dd9c-4a69-a196-4552cf323d22","description":"

Attachment handling supports document upload, linking, and management for supporting evidence such as prescriptions, receipts, and invoices required for service claims. The system provides secure file storage with pre-signed URLs for upload and download operations while maintaining proper associations between documents and service transactions.

\n","_postman_id":"f61c0df0-dd9c-4a69-a196-4552cf323d22","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Invoice","item":[{"name":"/invoice","id":"21b9a1a0-5214-4b12-9dd5-b22847e1d00a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice?page=1&pageSize=50","description":"

Retrieve a Paginated List of Invoices

\n

This API endpoint allows you to retrieve a paginated list of invoices submitted to SA, with options for filtering and sorting.

\n

Request Format

\n
    \n

  • Method: GET

    \n
    • \n

  • URL: https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice

    \n
    • \n
\n

Request Parameters

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"status\":{\"filterType\":\"text\",\"type\":\"equals\",\"filter\":\"SUBMITTED\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example sahInvoiceId=test. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /invoice?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"status\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"OPEN\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Expected Headers

\n
    \n

  • Authorization: Bearer token for authentication (if required by your API).

    \n
    • \n

  • Content-Type: application/json (generally not required for GET requests, but good to specify if needed).

    \n
    • \n
\n

Response Structure

\n

The response will be in JSON format and contains the following fields:

\n
    \n

  • version (string): The version of the API.

    \n
    • \n

  • message (string): A message regarding the status of the request.

    \n
    • \n

  • data (array of objects): A list of invoice objects, each containing:

    \n
      \n

    • id (string): The unique identifier of the invoice.

      \n
      • \n

    • orgId (integer): The identifier for the organization associated with the invoice.

      \n
      • \n

    • serviceProviderId (string): The identifier for the service provider.

      \n
      • \n

    • sahInvoiceId (string): The identifier for the SAH invoice.

      \n
      • \n

    • status (string): The current status of the invoice.

      \n
      • \n

    • createdAt (string): The timestamp when the invoice was created.

      \n
      • \n

    • updatedAt (string): The timestamp when the invoice was last updated.

      \n
      • \n

    • careRecipientId (string): The identifier for the care recipient associated with the invoice.

      \n
      • \n

    • messages (object): An object containing:

      \n
        \n

      • description (string): A description of the messages related to the invoice.

        \n
        • \n

      • nullable (boolean): Indicates if the description can be null.

        \n
        • \n
      \n
      • \n

    • claimId (string): The identifier for the claim associated with the invoice.

      \n
      • \n

    • sahCreatedAt (string): The timestamp when the invoice was created in the SAH system.

      \n
      • \n

    • sahUpdatedAt (string): The timestamp when the invoice was last updated in the SAH system.

      \n
      • \n
    \n
    • \n

  • page (integer): The current page number of the results.

    \n
    • \n

  • totalPages (integer): The total number of pages available.

    \n
    • \n

  • pageSize (integer): The number of items per page.

    \n
    • \n

  • totalCount (integer): The total number of invoices available.

    \n
    • \n
\n

This endpoint is essential for applications that need to manage and display invoice data efficiently.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["invoice"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[{"description":{"content":"

Page number for pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"pageSize","value":"50"},{"disabled":true,"key":"sort","value":"[[\"createdAt\",\"desc\"]]"}],"variable":[]}},"response":[{"id":"8d74ca27-6c71-4b9f-a8d2-35d50c8fa5df","name":"Paginated list of invoices","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": [\n {\n \"id\": \"i-\",\n \"orgId\": 2095,\n \"serviceProviderId\": \"string\",\n \"sahInvoiceId\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"1985-03-29T14:23:02.055Z\",\n \"updatedAt\": \"1984-11-22T23:59:02.688Z\",\n \"careRecipientId\": \"string\",\n \"messages\": {\n \"description\": \"System messages related to invoice\",\n \"nullable\": true\n },\n \"claimId\": \"string\",\n \"sahCreatedAt\": \"1975-08-05T03:05:04.808Z\",\n \"sahUpdatedAt\": \"2008-08-09T19:05:23.111Z\"\n },\n {\n \"id\": \"i-\",\n \"orgId\": 207,\n \"serviceProviderId\": \"string\",\n \"sahInvoiceId\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"1972-03-21T11:51:23.165Z\",\n \"updatedAt\": \"2004-04-28T09:46:04.793Z\",\n \"careRecipientId\": \"string\",\n \"messages\": {\n \"description\": \"System messages related to invoice\",\n \"nullable\": true\n },\n \"claimId\": \"string\",\n \"sahCreatedAt\": \"2019-09-19T06:14:01.240Z\",\n \"sahUpdatedAt\": \"1984-01-28T10:41:39.498Z\"\n }\n ],\n \"page\": 6649,\n \"totalPages\": 7762,\n \"pageSize\": 9708,\n \"totalCount\": 5415\n}"},{"id":"d3795a5b-b93c-4e68-8056-f7e8fbe28edc","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"8b9bbcb0-249f-44c7-a77a-81cfdfe1fd26","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice?page=1&pageSize=50&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice"],"query":[{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"50","description":"Number of items per page"},{"key":"sort","value":"[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]","description":"Sort criteria in AG Grid format or simple format"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"}],"_postman_id":"21b9a1a0-5214-4b12-9dd5-b22847e1d00a"},{"name":"/invoice/:id","id":"abab2950-db9b-4bf8-951c-6732087528e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice/:id","description":"

Retrieve a specific invoice by ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["invoice",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"query":[],"variable":[{"description":{"content":"

(Required) Invoice ID

\n","type":"text/plain"},"type":"any","value":"i-8c5f4bad-2b71-d56d-f7a5-80f5ea16873f","key":"id"}]}},"response":[{"id":"e6b7da52-1f5b-44fa-9035-6028848eae3a","name":"Single invoice response","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\",\n \"data\": {\n \"id\": \"i-\",\n \"orgId\": 9629,\n \"serviceProviderId\": \"string\",\n \"sahInvoiceId\": \"string\",\n \"status\": \"string\",\n \"createdAt\": \"2017-04-22T01:45:30.185Z\",\n \"updatedAt\": \"1982-06-12T10:38:06.069Z\",\n \"careRecipientId\": \"string\",\n \"messages\": {\n \"description\": \"System messages related to invoice\",\n \"nullable\": true\n },\n \"claimId\": \"string\",\n \"sahCreatedAt\": \"1949-01-11T19:03:11.535Z\",\n \"sahUpdatedAt\": \"1952-09-23T11:12:32.167Z\"\n }\n}"},{"id":"a93d4495-ca7b-4432-91d8-bb2a164d5363","name":"Bad request error","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"588d0174-9db7-427c-a811-97c3c9bc540a","name":"Authentication required or access denied","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice",":id"],"variable":[{"key":"id","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Invalid request\"\n}"},{"id":"fd03e0e1-0ad6-4617-906a-7f58c2e58904","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"org-id","value":"2708","description":"(Required) Organization ID"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/tx/invoice/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/tx"],"path":["invoice",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"stringstringstringstringstringstring","description":{"content":"Request trace ID","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Resource not found\"\n}"}],"_postman_id":"abab2950-db9b-4bf8-951c-6732087528e2"}],"id":"671e70b6-a7d3-44f7-86cb-7534d042ab69","description":"

Invoice operations provide read-only access to the invoices that have been submitted to Services Australia Support At Home platform. Organizations can monitor invoice processing states, claim associations, and system-generated messages to understand the billing lifecycle and payment flows.

\n","_postman_id":"671e70b6-a7d3-44f7-86cb-7534d042ab69","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}},{"name":"Claim","item":[{"name":"/claim","event":[{"listen":"test","script":{"id":"745da462-5739-4022-b5f3-25b0e9f28925","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4fec5f0a-0d05-43ec-bd7c-64a68d5f0d12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"org-id","value":"999","type":"text"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&page=1&pageSize=100","description":"

Returns a list of claims with optional filtering and sorting

\n

This endpoint allows you to retrieve claims based on their status, service provider ID, and sorting preferences.

\n

Possible Claim Statuses:

\n
    \n

  • InError: The claim is in error.

    \n
    • \n

  • PendingApproval: The claim is pending approval.

    \n
    • \n

  • Cancelled: The claim has been cancelled/rejected.

    \n
    • \n

  • Approved: The claim has been approved for payment.

    \n
    • \n

  • Completed: The claim is paid.

    \n
    • \n
\n

Request Parameters

\n
    \n

  • page (integer): The page number to retrieve. Default is 1.

    \n
    • \n

  • pageSize (integer): The number of results to return per page. Default is 100.

    \n
    • \n

  • sort (string): Sort criteria. Pass this as a JSON string using AG Grid sort model format.
    Example: [{\"colId\":\"createdAt\",\"sort\":\"desc\"}]

    \n
    • \n

  • filters (string): Filter criteria. Pass this as a JSON string using AG Grid filter model format.
    Example: {\"status\":{\"filterType\":\"text\",\"type\":\"equals\",\"filter\":\"CLAIMING\"}}

    \n
    • \n
\n

Filtering and Sorting

\n

Each supported field can also be used directly as a query parameter, for example sahClaimId=10000000. For more advanced filtering, use the filters query parameter.

\n

Use filters to narrow the results and sort to control the order of the returned rows. Both parameters should be sent as JSON strings in the query string.

\n

Example:

\n
GET /claim?page=1&pageSize=100&sort=[{\"colId\":\"createdAt\",\"sort\":\"desc\"}]&filters={\"status\":{\"filterType\":\"text\",\"type\":\"contains\",\"filter\":\"COMPLETED\"}}\n\n
\n

For full filter model details, see the AG Grid Filter API.

\n

Response:

\n
    \n

  • Status: HTTP status code of the response.

    \n
    • \n

  • Content-Type: Type of content returned (application/json).

    \n
    • \n

  • Data: An array of claims with their details.

    \n
    • \n

  • Pagination: Information about the pagination of the results.

    \n
    • \n
\n

Example Responses:

\n
{\"data\":[{\"id\":\"\",\"status\":\"\",\"serviceProviderId\":\"\",\"sahClaimId\":\"\",\"createdAt\":\"\"}],\"pagination\":{\"page\":0,\"pageSize\":0,\"total\":0}}\n{\"data\":[{\"id\":\"\",\"status\":\"\",\"serviceProviderId\":\"\",\"createdAt\":\"\"}],\"pagination\":{\"page\":0,\"pageSize\":0,\"total\":0}}\n{\"data\":[{\"id\":\"\",\"status\":\"\",\"serviceProviderId\":\"\",\"createdAt\":\"\"}],\"pagination\":{\"page\":0,\"pageSize\":0,\"total\":0}}\n\n
\n

Returns a list of claims, allowing filtering and sorting options to retrieve specific claims based on various criteria.
Request Parameters

\n
    \n

  • status (query parameter, required): The status of the claims to filter. In this case, it is set to Completed.

    \n
    • \n

  • serviceProviderId (query parameter, required): The unique identifier for the service provider associated with the claims. Example value: sp-101e7c2a-1234-4b5a-8c1d-abcdef123458.

    \n
    • \n

  • sort (query parameter, optional): A JSON string that specifies the sorting criteria for the results. For example, sorting by sahClaimId in ascending order.

    \n
    • \n

  • filters (query parameter, optional): A string that can be used for additional filtering criteria.

    \n
    • \n

  • page (query parameter, optional): The page number of results to retrieve. Default is 1.

    \n
    • \n

  • pageSize (query parameter, optional): The number of results to return per page. Default is 20.

    \n
    • \n
\n

Response Structure

\n

The response will contain a JSON object with the following structure:

\n
    \n

  • data (array): An array of claim objects, where each object includes:

    \n
      \n

    • id: The unique identifier for the claim.

      \n
      • \n

    • status: The current status of the claim.

      \n
      • \n

    • serviceProviderId: The ID of the service provider associated with the claim.

      \n
      • \n

    • sahClaimId: The specific claim ID.

      \n
      • \n

    • createdAt: The timestamp when the claim was created.

      \n
      • \n
    \n
    • \n

  • pagination (object): An object containing pagination details:

    \n
      \n

    • page: The current page number of the results.

      \n
      • \n

    • pageSize: The number of items per page.

      \n
      • \n

    • total: The total number of claims available based on the filters applied.

      \n
      • \n
    \n
    • \n
\n

This endpoint is useful for service providers and administrators who need to track and manage submitted claims effectively.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["claim"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[{"disabled":true,"description":{"content":"

Filter by claim status

\n","type":"text/plain"},"key":"status","value":"Completed"},{"disabled":true,"description":{"content":"

Filter by service provider ID

\n","type":"text/plain"},"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458"},{"description":{"content":"

Sort criteria (URL-encoded JSON array)

\n","type":"text/plain"},"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D"},{"description":{"content":"

Page number for pagination

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"pageSize","value":"100"}],"variable":[]}},"response":[{"id":"13a81ee9-02de-47ba-a85c-d7db4b3d3e47","name":"Basic claim list response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"},{"key":"org-id","value":"999","type":"text"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?status=SUBMITTED&serviceProviderId=sp-101e7c2a-1234-4b5a-8c1d-abcdef123458&sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&page=1&pageSize=20","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim"],"query":[{"key":"status","value":"SUBMITTED","description":"Filter by claim status"},{"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458","description":"Filter by service provider ID"},{"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D","description":"Sort criteria (URL-encoded JSON array)"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"20","description":"Number of items per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"abc123-def456-ghi789","description":{"content":"Trace ID for debugging","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde\",\n \"status\": \"SUBMITTED\",\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"sahClaimId\": \"SAH-2023-12345\",\n \"createdAt\": \"2023-01-15T10:30:00Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"pageSize\": 20,\n \"total\": 100\n }\n}"},{"id":"c09338cf-3223-4dab-9d4c-c4a45d7e39f5","name":"Filtered by status","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?status=SUBMITTED&serviceProviderId=sp-101e7c2a-1234-4b5a-8c1d-abcdef123458&sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&filters=string&page=1&pageSize=20","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim"],"query":[{"key":"status","value":"SUBMITTED","description":"Filter by claim status"},{"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458","description":"Filter by service provider ID"},{"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D","description":"Sort criteria (URL-encoded JSON array)"},{"key":"filters","value":"string","description":"Filter criteria (URL-encoded JSON object)"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"20","description":"Number of items per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"abc123-def456-ghi789","description":{"content":"Trace ID for debugging","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde\",\n \"status\": \"SUBMITTED\",\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"createdAt\": \"2023-01-15T10:30:00Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"pageSize\": 20,\n \"total\": 1\n }\n}"},{"id":"f5bb0f12-75bc-4c96-aab4-9b58af3ad5d6","name":"Paginated response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?status=SUBMITTED&serviceProviderId=sp-101e7c2a-1234-4b5a-8c1d-abcdef123458&sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&filters=string&page=1&pageSize=20","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim"],"query":[{"key":"status","value":"SUBMITTED","description":"Filter by claim status"},{"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458","description":"Filter by service provider ID"},{"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D","description":"Sort criteria (URL-encoded JSON array)"},{"key":"filters","value":"string","description":"Filter criteria (URL-encoded JSON object)"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"20","description":"Number of items per page"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"abc123-def456-ghi789","description":{"content":"Trace ID for debugging","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde\",\n \"status\": \"SUBMITTED\",\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"createdAt\": \"2023-01-15T10:30:00Z\"\n }\n ],\n \"pagination\": {\n \"page\": 1,\n \"pageSize\": 5,\n \"total\": 50\n }\n}"},{"id":"46cac882-1fd5-4174-b856-b9f40a1f7cf5","name":"Invalid input","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?status=SUBMITTED&serviceProviderId=sp-101e7c2a-1234-4b5a-8c1d-abcdef123458&sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&filters=string&page=1&pageSize=20","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim"],"query":[{"key":"status","value":"SUBMITTED","description":"Filter by claim status"},{"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458","description":"Filter by service provider ID"},{"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D","description":"Sort criteria (URL-encoded JSON array)"},{"key":"filters","value":"string","description":"Filter criteria (URL-encoded JSON object)"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"20","description":"Number of items per page"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"c066be0e-730c-421f-81b8-481b63e16bf0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim?status=SUBMITTED&serviceProviderId=sp-101e7c2a-1234-4b5a-8c1d-abcdef123458&sort=%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D&filters=string&page=1&pageSize=20","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim"],"query":[{"key":"status","value":"SUBMITTED","description":"Filter by claim status"},{"key":"serviceProviderId","value":"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458","description":"Filter by service provider ID"},{"key":"sort","value":"%5B%7B%22colId%22%3A%22sahClaimId%22%2C%22sort%22%3A%22asc%22%7D%5D","description":"Sort criteria (URL-encoded JSON array)"},{"key":"filters","value":"string","description":"Filter criteria (URL-encoded JSON object)"},{"key":"page","value":"1","description":"Page number for pagination"},{"key":"pageSize","value":"20","description":"Number of items per page"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"4fec5f0a-0d05-43ec-bd7c-64a68d5f0d12"},{"name":"/claim/:id","id":"c80f834c-fd47-4e55-bc4f-73776b33e567","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"org-id","value":"999","type":"text"}],"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/:id","description":"

Returns a single claim by its ID

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["claim",":id"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[],"variable":[{"description":{"content":"

(Required) ID of the claim to retrieve

\n","type":"text/plain"},"type":"any","value":"cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde","key":"id"}]}},"response":[{"id":"013933b2-1768-4c65-9f49-e59382d5a01c","name":"Successful operation","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"},{"key":"org-id","value":"999","type":"text"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim",":id"],"variable":[{"key":"id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"Trace ID for debugging","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde\",\n \"status\": \"SUBMITTED\",\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\",\n \"sahClaimId\": \"SAH-2023-12345\",\n \"createdAt\": \"2023-01-15T10:30:00Z\"\n}"},{"id":"21fe4adf-963c-408f-8720-31fd82920fb4","name":"Invalid ID supplied","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim",":id"],"variable":[{"key":"id","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"eaf371e0-134f-4c38-98a0-40767d206643","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim",":id"],"variable":[{"key":"id","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"d1c03d1c-1ecb-420c-ad7a-c21db9b89dbb","name":"Claim not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"},{"key":"org-id","value":"999","type":"text"}],"url":{"raw":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/:id","host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"path":["claim",":id"],"variable":[{"key":"id","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"1.0.0\",\n \"message\": \"Claim not found with ID cl-3c4d5e6f-7a8b-9c0d-1e2f-3456789abcde\"\n}"}],"_postman_id":"c80f834c-fd47-4e55-bc4f-73776b33e567"},{"name":"/claim/submit","id":"ac93be05-0f1a-4aaf-b719-7d6b87c6592a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"org-id","value":"999","description":"

(Required) Organization ID

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-5262506e-2c70-42dc-be8b-77bcce3d1c6a\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/submit","description":"

Submit Claims for an Organization

\n

This endpoint submits claims for an organization.

\n

Important: The submit action requires caution as submitting a claim initiates a process that may take up to seven days for support to process the submitted invoices. During this period, no further claims can be submitted. It is crucial to wait until the current claim is processed before submitting another.

\n

Additionally, note that there is no filtering option available; all submitted invoices will be claimed, which is a limitation set by Services Australia.

\n

Request Body

\n
    \n
  • serviceProviderId: (string) The ID of the service provider associated with the claim.
    • \n
\n

Example Response

\n
{\n  \"message\": \"\",\n  \"count\": 0\n}\n\n
\n

This endpoint allows organizations to submit claims, which can be optionally filtered by a specific service provider. It is designed to facilitate the processing of claims within the financial system.

\n

Purpose

\n

The primary purpose of this request is to submit a claim for processing. This is crucial for organizations that need to manage their financial transactions and ensure claims are handled efficiently.

\n

Request Parameters

\n

The request body should be in JSON format and include the following parameter:

\n
    \n
  • serviceProviderId (string): A unique identifier for the service provider associated with the claim. This is essential for filtering and processing the claim accurately.
    • \n
\n

Example Request Body:

\n
{\n  \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abc ...\"\n}\n\n
\n

Response Structure

\n

The response from this request will be in JSON format and may include the following fields:

\n
    \n

  • message (string): A message indicating the status of the claim submission.

    \n
    • \n

  • count (integer): The count of claims processed or affected by the submission.

    \n
    • \n
\n

Example Response:

\n
{\n  \"message\": \"\",\n  \"count\": 0\n}\n\n
\n

This structure allows clients to understand the outcome of their claim submission and take necessary actions based on the response received.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}},"urlObject":{"path":["claim","submit"],"host":["https://stage-api.quickclaim.io/sah/pub/v1/provider"],"query":[],"variable":[]}},"response":[{"id":"55ec84e6-5a57-43d0-b1fa-0d5efbe6baba","name":"Claims submitted successfully","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/submit"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"x-trace-id","value":"string","description":{"content":"Trace ID for debugging","type":"text/plain"},"disabled":false}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"string\",\n \"count\": 77\n}"},{"id":"66657e4d-bdbf-415d-8b6e-3e2b0d16240c","name":"Invalid input","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/submit"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"},{"id":"6e10c5fb-8ba8-4651-b941-75529f02c6b6","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"org-id","value":"999","description":"(Required) Organization ID"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: apikey"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"sp-101e7c2a-1234-4b5a-8c1d-abcdef123458\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://stage-api.quickclaim.io/sah/pub/v1/provider/claim/submit"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"version\": \"string\",\n \"message\": \"string\"\n}"}],"_postman_id":"ac93be05-0f1a-4aaf-b719-7d6b87c6592a"}],"id":"a2f1b75d-b77b-470c-82ea-7d57f1dc8a25","description":"

The Support at Home Finance API provides an interface for managing the complete lifecycle of financial claims within the Support at Home program. This RESTful API enables authorized service providers to:

\n
    \n

  • Submit new claims for reimbursement

    \n
    • \n

  • Retrieve existing claim details and status

    \n
    • \n

  • Search and filter claims based on various criteria

    \n
    • \n

  • Manage claim processing workflows

    \n
    • \n
\n

Key Features:

\n
    \n

  • Secure Authentication: All endpoints require valid API key authentication

    \n
    • \n

  • Versioned API: This is version 1 (v1) of the API, ensuring stability

    \n
    • \n

  • Filtering: Supports complex queries with multiple filter parameters

    \n
    • \n

  • Pagination: Large result sets are automatically paginated

    \n
    • \n

  • Audit Trails: Each request includes trace IDs for debugging

    \n
    • \n
\n

The API follows REST conventions and returns standard HTTP status codes. All responses are formatted in JSON, including detailed error messages when requests fail.

\n

This API is part of the QuickClaim platform that powers the Support at Home program's financial management system.

\n","_postman_id":"a2f1b75d-b77b-470c-82ea-7d57f1dc8a25","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","name":"Support At Home","type":"folder"}}}],"id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"99004550-9781-4231-a346-e458b3222b7f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"4ff0afae-89b2-47c2-82ab-c5dd4bd79fa4","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"21e4988f-4d7e-4767-bab4-f06d2d17527a","description":""},{"name":"Support At Home (Native)","item":[{"name":"service-provider-summary-1.0.0","item":[{"name":"/acws/support-at-home/serviceProviders/v1/:serviceProviderId","id":"77eddddb-4ae0-4936-b884-0ac3d1bd9dbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProviders/v1/:serviceProviderId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","serviceProviders","v1",":serviceProviderId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"e4d2ea75-b86b-4e9e-ac19-f1ca07194f10","description":{"content":"

Service provider identifier

\n","type":"text/plain"},"type":"any","value":"","key":"serviceProviderId"}]}},"response":[{"id":"8ae72707-048f-4309-aab9-5fe475d05da9","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProviders/v1/:serviceProviderId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","serviceProviders","v1",":serviceProviderId"],"variable":[{"key":"serviceProviderId","value":"","description":"Service provider identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"serviceProviderName\": \"Test service provider\",\n \"registeredProviderId\": \"12345\",\n \"programCode\": \"SAH\",\n \"status\": \"Operational\",\n \"statusEffectiveDate\": \"2024-06-12\",\n \"addresses\": [\n {\n \"type\": \"Location\",\n \"streetLine1\": \"10 Test street\",\n \"streetLine2\": \"\",\n \"city\": \"Canberra\",\n \"state\": \"ACT\",\n \"country\": \"Australia\",\n \"postcode\": \"2600\",\n \"validFrom\": \"2024-11-10\",\n \"validTo\": \"2024-08-10\"\n },\n {\n \"type\": \"Location\",\n \"streetLine1\": \"10 Test street\",\n \"streetLine2\": \"\",\n \"city\": \"Canberra\",\n \"state\": \"ACT\",\n \"country\": \"Australia\",\n \"postcode\": \"2600\",\n \"validFrom\": \"2024-11-10\",\n \"validTo\": \"2024-08-10\"\n }\n ],\n \"registrationCategories\": [\n {\n \"categoryCode\": \"1\",\n \"categoryText\": \"Home and community services\",\n \"startDate\": \"2024-09-25\",\n \"endDate\": \"2024-11-20\",\n \"updatedAtDateTime\": \"1953-11-22T08:32:33.694Z\"\n },\n {\n \"categoryCode\": \"1\",\n \"categoryText\": \"Home and community services\",\n \"startDate\": \"2024-09-25\",\n \"endDate\": \"2024-11-20\",\n \"updatedAtDateTime\": \"1950-09-15T02:31:54.802Z\"\n }\n ],\n \"registeredServiceTypes\": [\n {\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceTypeStartDate\": \"2024-09-20\",\n \"serviceTypeEndDate\": \"2024-10-20\",\n \"updatedAtDateTime\": \"1963-11-30T12:47:25.712Z\"\n },\n {\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceTypeStartDate\": \"2024-09-20\",\n \"serviceTypeEndDate\": \"2024-10-20\",\n \"updatedAtDateTime\": \"2020-05-28T20:00:21.224Z\"\n }\n ]\n}"},{"id":"b2473f77-7115-4156-a791-f38b2b62cd65","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProviders/v1/:serviceProviderId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","serviceProviders","v1",":serviceProviderId"],"variable":[{"key":"serviceProviderId","value":"","description":"Service provider identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"77eddddb-4ae0-4936-b884-0ac3d1bd9dbf"}],"id":"e4c5a050-d098-41ba-9659-5430d295785d","description":"

Provides the summary information about an Aged Care Support at Home service provider.

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • descriptions have been updated
    • \n
      \n
    • serviceGroupId
      • \n
    • serviceGroupText
      • \n
    • serviceTypeId
      • \n
    • serviceTypeText
      • \n
    \n
  • examples have been added and updated
    • \n
  • renamed registerdServiceTypes to registeredServiceTypes
    • \n
  • added updatedAtDateTime to registrationCategory and registeredServiceType
    • \n
  • operationId has been updated
    • \n
  • updated RegisteredServiceType entity to remove array
    • \n
  • added categoryText in registrationCategories entity
    • \n
  • programCode enumerations been updated
    • \n
\n
","_postman_id":"e4c5a050-d098-41ba-9659-5430d295785d","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"service-provider-account-summary-1.0.0","item":[{"name":"/acws/support-at-home/serviceProvider/:serviceProviderId/account-summary/v1","id":"ee7ccf22-b3dc-4a2b-bb81-09e1f611302c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProvider/:serviceProviderId/account-summary/v1?periodStartDate=current date - 1 months&periodEndDate=current date","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","serviceProvider",":serviceProviderId","account-summary","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The earliest payment date that will be returned in response. Response will be inclusive of periodStartDate.

\n","type":"text/plain"},"key":"periodStartDate","value":"current date - 1 months"},{"description":{"content":"

The latest payment date that will be returned in response. Response will be inclusive of periodEndDate.

\n","type":"text/plain"},"key":"periodEndDate","value":"current date"}],"variable":[{"id":"5e260f62-f010-434a-8a6c-bd48f755e026","description":{"content":"

Service Australia identifier for the service provider

\n","type":"text/plain"},"type":"any","value":"string","key":"serviceProviderId"}]}},"response":[{"id":"df228fb9-a257-48f8-9517-4544e08c56cd","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProvider/:serviceProviderId/account-summary/v1?periodStartDate=current date - 1 months&periodEndDate=current date","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","serviceProvider",":serviceProviderId","account-summary","v1"],"query":[{"description":"The earliest payment date that will be returned in response. Response will be inclusive of periodStartDate.","key":"periodStartDate","value":"current date - 1 months"},{"description":"The latest payment date that will be returned in response. Response will be inclusive of periodEndDate.","key":"periodEndDate","value":"current date"}],"variable":[{"key":"serviceProviderId","value":"string","description":"Service Australia identifier for the service provider"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"periodStartDate\": \"2024-10-01\",\n \"periodEndDate\": \"2024-11-01\",\n \"heldoverPreviousPeriod\": 1000,\n \"transactionDetail\": [\n {\n \"date\": \"2024-10-12\",\n \"description\": \"Support from Home Claim\",\n \"amount\": 200,\n \"transactionType\": \"SAH_CLAIM\",\n \"transactionReference\": \"12345\",\n \"updatedAtDateTime\": \"1958-09-02T14:51:57.966Z\"\n },\n {\n \"date\": \"2024-10-12\",\n \"description\": \"Support from Home Claim\",\n \"amount\": 200,\n \"transactionType\": \"SAH_CLAIM\",\n \"transactionReference\": \"12345\",\n \"updatedAtDateTime\": \"2018-03-09T10:21:42.079Z\"\n }\n ],\n \"paymentAmount\": 200,\n \"heldoverAmount\": 800\n },\n {\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"periodStartDate\": \"2024-10-01\",\n \"periodEndDate\": \"2024-11-01\",\n \"heldoverPreviousPeriod\": 1000,\n \"transactionDetail\": [\n {\n \"date\": \"2024-10-12\",\n \"description\": \"Support from Home Claim\",\n \"amount\": 200,\n \"transactionType\": \"SAH_CLAIM\",\n \"transactionReference\": \"12345\",\n \"updatedAtDateTime\": \"2011-04-10T20:59:17.186Z\"\n },\n {\n \"date\": \"2024-10-12\",\n \"description\": \"Support from Home Claim\",\n \"amount\": 200,\n \"transactionType\": \"SAH_CLAIM\",\n \"transactionReference\": \"12345\",\n \"updatedAtDateTime\": \"2010-08-20T10:25:45.489Z\"\n }\n ],\n \"paymentAmount\": 200,\n \"heldoverAmount\": 800\n }\n]"},{"id":"b9d4e65b-758e-4a1e-835b-016f133aa6c6","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/serviceProvider/:serviceProviderId/account-summary/v1?periodStartDate=current date - 1 months&periodEndDate=current date","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","serviceProvider",":serviceProviderId","account-summary","v1"],"query":[{"description":"The earliest payment date that will be returned in response. Response will be inclusive of periodStartDate.","key":"periodStartDate","value":"current date - 1 months"},{"description":"The latest payment date that will be returned in response. Response will be inclusive of periodEndDate.","key":"periodEndDate","value":"current date"}],"variable":[{"key":"serviceProviderId","value":"string","description":"Service Australia identifier for the service provider"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ee7ccf22-b3dc-4a2b-bb81-09e1f611302c"}],"id":"4888c747-3e7b-41ff-8fd9-72b63cdb8c3a","description":"

Provides account summaries for Support at Home service provider

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in serviceProviderId description has been updated to Identifier
    • \n
  • param in periodStartDate and periodEndDate description has been updated to parameter
    • \n
  • examples have been added and updated
    • \n
  • added updatedAtDateTime to response
    • \n
  • operationId has been updated
    • \n
  • removed creditOrDebit from response
    • \n
  • added serviceNapsId to response
    • \n
  • added paymentAmount to response
    • \n
\n
","_postman_id":"4888c747-3e7b-41ff-8fd9-72b63cdb8c3a","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"payment-statement-1.0.0","item":[{"name":"/acws/support-at-home/payment-statement/v1/serviceProvider/:serviceProviderId/:claimId","id":"1c9d7745-467f-4d0d-ad8c-0e12076f276f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-statement/v1/serviceProvider/:serviceProviderId/:claimId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","payment-statement","v1","serviceProvider",":serviceProviderId",":claimId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"0bb80e85-d92c-4b15-9857-c4c9840f2232","description":{"content":"

The Services Australia Identifier for the Service provider

\n","type":"text/plain"},"type":"any","value":"string","key":"serviceProviderId"},{"id":"1b30f3eb-f1be-4216-a5e5-46ebdaf99fa7","description":{"content":"

The identifier used to identity the payment statement for a claim

\n","type":"text/plain"},"type":"any","value":"string","key":"claimId"}]}},"response":[{"id":"ea663408-5b07-452c-81ab-297f84899d51","name":"Retrieved entity","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-statement/v1/serviceProvider/:serviceProviderId/:claimId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","payment-statement","v1","serviceProvider",":serviceProviderId",":claimId"],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"},{"key":"claimId","value":"string","description":"The identifier used to identity the payment statement for a claim"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"registeredProviderId\": \"strin\",\n \"registeredProviderName\": \"string\",\n \"registeredProviderABN\": \"string\",\n \"paymentDate\": \"2020-12-03\",\n \"updatedAtDateTime\": \"1994-10-10T03:21:15.507Z\",\n \"summary\": {\n \"categoryItems\": [\n {\n \"code\": \"CM\",\n \"description\": \"Home support ongoing\",\n \"amount\": 1000\n },\n {\n \"code\": \"EL\",\n \"description\": \"Home support ongoing\",\n \"amount\": 1000\n }\n ],\n \"heldoverPreviousPeriod\": 200,\n \"commonwealthUnspent\": 0,\n \"compensationReduction\": 200,\n \"careRecipientIndividualContribution\": 200,\n \"claimTotal\": 1000,\n \"totalPaid\": 800,\n \"outstandingHeldover\": 0\n },\n \"paymentItems\": [\n {\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"invoiceExternalReferenceId\": \"12345\",\n \"invoiceItemExternalReferenceItemId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"deliveryDate\": \"1950-10-30\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescriptionCode\": \"WRAP-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"entitlementType\": \"string\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"unitType\": \"hours\",\n \"invoiceAmount\": 100,\n \"compensationReduction\": 100,\n \"individualContributionAmount\": 20,\n \"paymentDetermination\": 80,\n \"finalDetermination\": 8937.83,\n \"budgets\": [\n {\n \"budgetTypeCode\": \"ON\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n },\n {\n \"budgetTypeCode\": \"ON\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n }\n ]\n },\n {\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"invoiceExternalReferenceId\": \"12345\",\n \"invoiceItemExternalReferenceItemId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"deliveryDate\": \"1973-09-11\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescriptionCode\": \"WRAP-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"entitlementType\": \"string\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"unitType\": \"hours\",\n \"invoiceAmount\": 100,\n \"compensationReduction\": 100,\n \"individualContributionAmount\": 20,\n \"paymentDetermination\": 80,\n \"finalDetermination\": 6636.27,\n \"budgets\": [\n {\n \"budgetTypeCode\": \"ON\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n },\n {\n \"budgetTypeCode\": \"ON\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n }\n ]\n }\n ],\n \"notes\": [\n {\n \"noteType\": \"string\",\n \"note\": \"\"\n },\n {\n \"noteType\": \"string\",\n \"note\": \"\"\n }\n ]\n}"},{"id":"6f13c3d8-a779-4e19-9adf-cb7096bd09b9","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-statement/v1/serviceProvider/:serviceProviderId/:claimId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","payment-statement","v1","serviceProvider",":serviceProviderId",":claimId"],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"},{"key":"claimId","value":"string","description":"The identifier used to identity the payment statement for a claim"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"1c9d7745-467f-4d0d-ad8c-0e12076f276f"}],"id":"13b1a0e5-9579-4546-8625-e95800a579d6","description":"

Provides a payment statement for relevant payments for Support at Home

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • path parameter for payment statement download has been updated from claimid to claimId
    • \n
  • moved updatedAtDateTime from summary to under Payment
    • \n
  • operationId has been updated
    • \n
  • serviceProviderId been added to get payment statement path parameter
    • \n
  • updated csv and xml value for payment statement download.
    • \n
  • removed fields from paymentItems
    • \n
      \n
    • itemId
      • \n
    • itemDescription
      • \n
    • quantity
      • \n
    • pricePerUnit
      • \n
    • unitTYpe
      • \n
    • fundingSource
      • \n
    \n
  • removed items from notes
    • \n
      \n
    • headerInformation
      • \n
    • careRecipientId
      • \n
    \n
  • added budgets entity to paymentItems to show multiple budgets
    • \n
  • totalAmount renamed to invoiceAmount
    • \n
  • subsidyAmount renamed to paymentDetermination
    • \n
  • added contributionReduction and careRecipientIndividualContribution to summary entity
    • \n
  • added serviceNapsId to response
    • \n
  • added following fields back in
    • \n
      \n
    • itemId
      • \n
    • quantity
      • \n
    • pricePerUnit
      • \n
    • unitType
      • \n
    \n
  • added following fields to paymentItems entity
    • \n
      \n
    • invoiceItemExternalReferenceItemId
      • \n
    • invoiceExternalReferenceId
      • \n
    • wraparoundDescriptionCode
      • \n
    • wraparoundDescriptionText
      • \n
    • budgetType has been expanded into budgetTypeCode and budgetTypeText
      • \n
    • added code to categoryItems entity
      • \n
    • updated unitType enumerations
      • \n
    • added entitlementType and finalDetermination to response
      • \n
    \n
","_postman_id":"13b1a0e5-9579-4546-8625-e95800a579d6","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"payment-item-reporting-1.0.0","item":[{"name":"/acws/support-at-home/payment-item-report/v1","id":"6450a034-62dc-4dd7-a312-d2d4c6bad640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-item-report/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&deliveryDateFrom=1960-01-12&deliveryDateTo=1960-01-12&serviceGroupId=string&serviceTypeId=string&serviceId=string&invoiceId=string&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=paymentDate&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","payment-item-report","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

Service Australia identifier for the service provider.

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The National Approved Provider System(NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

The earliest payment date that will be returned in response. Response will be inclusive of provided date.

\n","type":"text/plain"},"key":"paymentDateFrom","value":"1960-01-12"},{"description":{"content":"

The latest payment date that will be returned in response. Response will be inclusive of provided date.

\n","type":"text/plain"},"key":"paymentDateTo","value":"1960-01-12"},{"description":{"content":"

The earliest delivery date that will be returned in response. Response will be inclusive of provided date.

\n","type":"text/plain"},"key":"deliveryDateFrom","value":"1960-01-12"},{"description":{"content":"

The latest delivery date that will be returned in response. Response will be inclusive of provided date.

\n","type":"text/plain"},"key":"deliveryDateTo","value":"1960-01-12"},{"description":{"content":"

Identifier of the service group. See Service list api for available values

\n","type":"text/plain"},"key":"serviceGroupId","value":"string"},{"description":{"content":"

Identifier of the service type. See Service list api for available values

\n","type":"text/plain"},"key":"serviceTypeId","value":"string"},{"description":{"content":"

Identifier of the service. See Service list api for available values

\n","type":"text/plain"},"key":"serviceId","value":"string"},{"description":{"content":"

The unique identifier for an invoice.

\n","type":"text/plain"},"key":"invoiceId","value":"string"},{"description":{"content":"

The start of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"paymentDate"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"9abe93f9-3422-408e-86cd-527901bff41e","name":"Payment item","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-item-report/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&deliveryDateFrom=1960-01-12&deliveryDateTo=1960-01-12&serviceGroupId=string&serviceTypeId=string&serviceId=string&invoiceId=string&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=paymentDate&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","payment-item-report","v1"],"query":[{"description":"Service Australia identifier for the service provider.","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System(NAPS) Identifier for the service provider ","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"The earliest payment date that will be returned in response. Response will be inclusive of provided date.","key":"paymentDateFrom","value":"1960-01-12"},{"description":"The latest payment date that will be returned in response. Response will be inclusive of provided date.","key":"paymentDateTo","value":"1960-01-12"},{"description":"The earliest delivery date that will be returned in response. Response will be inclusive of provided date.","key":"deliveryDateFrom","value":"1960-01-12"},{"description":"The latest delivery date that will be returned in response. Response will be inclusive of provided date.","key":"deliveryDateTo","value":"1960-01-12"},{"description":"Identifier of the service group. See Service list api for available values","key":"serviceGroupId","value":"string"},{"description":"Identifier of the service type. See Service list api for available values","key":"serviceTypeId","value":"string"},{"description":"Identifier of the service. See Service list api for available values","key":"serviceId","value":"string"},{"description":"The unique identifier for an invoice. ","key":"invoiceId","value":"string"},{"description":"The start of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime ","key":"sort-fields","value":"paymentDate"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"invoiceExternalReferenceId\": \"12345\",\n \"invoiceItemExternalReferenceItemId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"claimSubmissionDate\": \"2018-12-03\",\n \"claimApprovedDate\": \"2003-05-31\",\n \"paymentDate\": \"2012-05-15\",\n \"deliveryDate\": \"1950-02-07\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescriptionCode\": \"WRAP-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"entitlementType\": \"string\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"unitType\": \"hours\",\n \"invoiceAmount\": 100,\n \"compensationReduction\": 100,\n \"individualContributionAmount\": 20,\n \"paymentDetermination\": 80,\n \"finalDetermination\": 3763.46,\n \"updatedAtDateTime\": \"1991-03-19T22:26:22.042Z\",\n \"budgets\": [\n {\n \"budgetTypeCode\": \"string\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n },\n {\n \"budgetTypeCode\": \"string\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n }\n ]\n },\n {\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"invoiceExternalReferenceId\": \"12345\",\n \"invoiceItemExternalReferenceItemId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"claimSubmissionDate\": \"1954-01-04\",\n \"claimApprovedDate\": \"1953-02-22\",\n \"paymentDate\": \"2003-04-24\",\n \"deliveryDate\": \"1962-12-23\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescriptionCode\": \"WRAP-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"entitlementType\": \"string\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"unitType\": \"hours\",\n \"invoiceAmount\": 100,\n \"compensationReduction\": 100,\n \"individualContributionAmount\": 20,\n \"paymentDetermination\": 80,\n \"finalDetermination\": 1810.3400000000001,\n \"updatedAtDateTime\": \"1999-10-09T09:50:37.767Z\",\n \"budgets\": [\n {\n \"budgetTypeCode\": \"string\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n },\n {\n \"budgetTypeCode\": \"string\",\n \"budgetTypeText\": \"Home Support Ongoing\",\n \"amount\": 1000\n }\n ]\n }\n]"},{"id":"848edafa-83d8-456d-8b8d-b06097019efc","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/payment-item-report/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&deliveryDateFrom=1960-01-12&deliveryDateTo=1960-01-12&serviceGroupId=string&serviceTypeId=string&serviceId=string&invoiceId=string&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=paymentDate&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","payment-item-report","v1"],"query":[{"description":"Service Australia identifier for the service provider.","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System(NAPS) Identifier for the service provider ","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"The earliest payment date that will be returned in response. Response will be inclusive of provided date.","key":"paymentDateFrom","value":"1960-01-12"},{"description":"The latest payment date that will be returned in response. Response will be inclusive of provided date.","key":"paymentDateTo","value":"1960-01-12"},{"description":"The earliest delivery date that will be returned in response. Response will be inclusive of provided date.","key":"deliveryDateFrom","value":"1960-01-12"},{"description":"The latest delivery date that will be returned in response. Response will be inclusive of provided date.","key":"deliveryDateTo","value":"1960-01-12"},{"description":"Identifier of the service group. See Service list api for available values","key":"serviceGroupId","value":"string"},{"description":"Identifier of the service type. See Service list api for available values","key":"serviceTypeId","value":"string"},{"description":"Identifier of the service. See Service list api for available values","key":"serviceId","value":"string"},{"description":"The unique identifier for an invoice. ","key":"invoiceId","value":"string"},{"description":"The start of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of payment item report updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime ","key":"sort-fields","value":"paymentDate"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"6450a034-62dc-4dd7-a312-d2d4c6bad640"}],"id":"9685006f-63f3-4d9e-8814-73bcb7a52199","description":"

Reporting api for querying across all Support at home invoice items

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • clientContributionAmount renamed to individualContributionAmount
    • \n
  • descriptions updated
    • \n
      \n
    • invoiceId
      • \n
    • paidDate
      • \n
    • deliveryDate
      • \n
    • individualContributionAmount
      • \n
    \n
  • updated multipleOf for quantity
    • \n
  • added query parameters for payment item report GET call
    • \n
      \n
    • updatedAtDateTime
      • \n
    • limit
      • \n
    • page
      • \n
    • sort-fields
      • \n
    • sort
      • \n
    \n
  • added following fields to response
    • \n
      \n
    • updatedAtDateTime
      • \n
    • invoiceId
      • \n
    \n
  • removed default for deliveryDateFrom and deliveryDateTo with defaults for paymentDateFrom and paymentDateTo
    • \n
  • updated sort-fields
    • \n
  • updated paidDate to paymentDate to align field names across APIs
    • \n
  • removed fields
    • \n
      \n
    • itemId
      • \n
    • quantity
      • \n
    • pricePerUnit
      • \n
    • unitTYpe
      • \n
    • fundingSource
      • \n
    \n
  • added budgets entity to show multiple budgets
    • \n
  • totalAmount renamed to invoiceAmount
    • \n
  • subsidyAmount renamed to paymentDetermination
    • \n
  • fundingSource has been removed from query parameter
    • \n
  • added compensationReduction to response
    • \n
  • added claimSubmissionDate and claimApprovedDate
    • \n
  • added serviceNapsId to response and query parameter
    • \n
  • added following fields back in
    • \n
      \n
    • itemId
      • \n
    • quantity
      • \n
    • pricePerUnit
      • \n
    • unitType
      • \n
    \n
  • added following fields to paymentItems entity
    • \n
      \n
    • invoiceItemExternalReferenceItemId
      • \n
    • invoiceExternalReferenceId
      • \n
    • itemDescriptionCode
      • \n
    • itemDescriptionText
      • \n
    • wraparoundDescriptionCode
      • \n
    • added entitlementType and finalDetermination to response
      • \n
    \n\n
    </td>\n
","_postman_id":"9685006f-63f3-4d9e-8814-73bcb7a52199","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"oxygen-supplement-1.0.0","item":[{"name":"/acws/support-at-home/events/oxygen/v1","id":"d9119690-c648-4099-aeb3-53f5b96be696","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"description":{"content":"

Start date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"startDateFrom","value":"1960-01-12"},{"description":{"content":"

Start date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"startDateTo","value":"1960-01-12"},{"description":{"content":"

End date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"endDateFrom","value":"1960-01-12"},{"description":{"content":"

End date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"endDateTo","value":"1960-01-12"},{"description":{"content":"

The start of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"8774bd97-21d6-4638-885e-c0e730aff1ac","name":"Oxygen supplement summary","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Start date from date. Result will be inclusive of date.","key":"startDateFrom","value":"1960-01-12"},{"description":"Start date to date. Result will be inclusive of date.","key":"startDateTo","value":"1960-01-12"},{"description":"End date from date. Result will be inclusive of date.","key":"endDateFrom","value":"1960-01-12"},{"description":"End date to date. Result will be inclusive of date.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-11\",\n \"oxygenTypeText\": \"Normal\",\n \"status\": \"Approved\",\n \"channel\": \"B2G\",\n \"createdAtDateTime\": \"1974-05-07T09:02:22.237Z\",\n \"updatedAtDateTime\": \"1982-04-06T08:58:30.504Z\"\n },\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-11\",\n \"oxygenTypeText\": \"Normal\",\n \"status\": \"Approved\",\n \"channel\": \"B2G\",\n \"createdAtDateTime\": \"1991-10-21T01:24:09.380Z\",\n \"updatedAtDateTime\": \"1952-01-09T10:38:41.842Z\"\n }\n]"},{"id":"acc60d4b-7d1b-4f56-a521-a1cddf264c94","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Start date from date. Result will be inclusive of date.","key":"startDateFrom","value":"1960-01-12"},{"description":"Start date to date. Result will be inclusive of date.","key":"startDateTo","value":"1960-01-12"},{"description":"End date from date. Result will be inclusive of date.","key":"endDateFrom","value":"1960-01-12"},{"description":"End date to date. Result will be inclusive of date.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of oxygen supplement updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"d9119690-c648-4099-aeb3-53f5b96be696"},{"name":"/acws/support-at-home/events/oxygen/v1","id":"21d42edb-910d-47b4-87aa-b2506ed941d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"a68a448f-e219-4b54-85c8-bb829f6f5f2f","name":"Oxygen supplement","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-11\",\n \"oxygenTypeText\": \"Normal\",\n \"status\": \"Approved\",\n \"channel\": \"B2G\",\n \"createdAtDateTime\": \"1986-05-18T02:57:18.070Z\",\n \"updatedAtDateTime\": \"1980-07-23T13:43:27.751Z\"\n}"},{"id":"046c5b68-52c8-494b-8d06-54313f5aa1fe","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"21d42edb-910d-47b4-87aa-b2506ed941d6"},{"name":"/acws/support-at-home/events/oxygen/v1/:supplementId","id":"0fdeed03-3e94-41ee-ac7e-423e5ff99593","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"da05867c-5244-4845-a3bc-0c234b925707","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"6a2c4976-2ad2-4cfc-9258-1b940e0a3891","name":"Oxygen supplement","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-11\",\n \"oxygenTypeText\": \"Normal\",\n \"status\": \"Approved\",\n \"channel\": \"B2G\",\n \"createdAtDateTime\": \"1966-03-07T17:55:28.842Z\",\n \"updatedAtDateTime\": \"1976-11-25T19:33:38.503Z\",\n \"messages\": [\n {\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ],\n \"attachments\": [\n {\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1976-08-15T03:20:59.019Z\"\n },\n {\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2017-12-31T11:02:33.791Z\"\n }\n ]\n}"},{"id":"09e449c1-906e-4459-9e94-9ac843229a13","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"0fdeed03-3e94-41ee-ac7e-423e5ff99593"},{"name":"/acws/support-at-home/events/oxygen/v1/:supplementId","id":"b9a72c2b-80f5-4c29-ae12-840a9d693190","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"6d9109e9-5c6a-4578-bcb8-0bd604124204","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"de6b5d27-383e-4d62-80f3-25f05e7c7e97","name":"No content","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"4c9e156f-d9fb-4a19-bf37-e4d674e0a4e2","name":"Error","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-11\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"b9a72c2b-80f5-4c29-ae12-840a9d693190"},{"name":"/acws/support-at-home/events/oxygen/v1/:supplementId","id":"ae0a98a1-f314-45ed-a975-baadd19f5945","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"d4626a77-9053-4788-8335-6b894eb848e4","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"8102123a-cde9-4e11-88c4-cc6bffc94b95","name":"Deleted supplement","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-10\",\n \"oxygenTypeCode\": \"OXY_NORM\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-11\",\n \"oxygenTypeText\": \"Normal\",\n \"status\": \"Approved\",\n \"channel\": \"B2G\",\n \"createdAtDateTime\": \"1986-05-18T02:57:18.070Z\",\n \"updatedAtDateTime\": \"1980-07-23T13:43:27.751Z\"\n}"},{"id":"a7ddae9b-cd30-487b-991f-046c958b125e","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ae0a98a1-f314-45ed-a975-baadd19f5945"},{"name":"/acws/support-at-home/events/oxygen/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","id":"8584b0fa-eec4-4c71-8284-fae38a179df8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"b52a41d9-9767-4d1f-9469-036c5a1907a7","description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"type":"any","value":"","key":"careRecipientId"},{"id":"8b83e44a-c249-48e9-9121-2a85e50cb481","description":{"content":"

Start date of the oxygen supplement.

\n","type":"text/plain"},"type":"any","value":"","key":"startDate"},{"id":"9408a6f1-9e8f-4591-9111-1d03e2339d94","description":{"content":"

End date of the oxygen supplement.

\n","type":"text/plain"},"type":"any","value":"","key":"endDate"}]}},"response":[{"id":"5edfe719-0b7d-40d3-be8f-2d64a6953e17","name":"End date Oxygen supplement","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "},{"key":"startDate","value":"","description":"Start date of the oxygen supplement."},{"key":"endDate","value":"","description":"End date of the oxygen supplement."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-11-11\",\n \"status\": \"Approved\",\n \"updatedAtDateTime\": \"2018-11-15T00:48:00.004Z\"\n}"},{"id":"af2694e7-4da0-4a88-8e46-fb2f1330418f","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "},{"key":"startDate","value":"","description":"Start date of the oxygen supplement."},{"key":"endDate","value":"","description":"End date of the oxygen supplement."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"8584b0fa-eec4-4c71-8284-fae38a179df8"},{"name":"/acws/support-at-home/events/oxygen/v1/:supplementId/attachments","id":"0ab358cf-6f82-4444-83dc-7628d08ce503","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1955-12-11T08:45:20.734Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"7b7a8ce3-4cce-416f-8881-decc707aa34e","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"a6c3cccd-3479-45bb-8bf1-dd3ce96fb832","name":"Attachment pdf","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1955-12-11T08:45:20.734Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1982-03-13T05:17:44.379Z\"\n}"},{"id":"5671f390-678e-4ade-911e-961f1452d2ca","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"string\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1955-12-11T08:45:20.734Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"0ab358cf-6f82-4444-83dc-7628d08ce503"},{"name":"/acws/support-at-home/events/oxygen/v1/:supplementId/attachments/:attachmentId","id":"9031d2eb-944f-467e-877e-70816e2f9ce4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments/:attachmentId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments",":attachmentId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"e84ce22a-b9a7-4c28-8e0d-8a22904c83d3","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"},{"id":"1a1a0947-5e7e-4a99-82fa-78c4647b0737","description":{"content":"

The unique identifier given to an attachment

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"a6f1ccf4-0426-4305-811b-f40adc2a6e41","name":"Attachment pdf","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments",":attachmentId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"07f629a8-2f37-4571-9147-afbd100aa794","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/oxygen/v1/:supplementId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","oxygen","v1",":supplementId","attachments",":attachmentId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"9031d2eb-944f-467e-877e-70816e2f9ce4"}],"id":"858d2fc0-0021-45b0-86f6-6ff659be28aa","description":"

Oxygen supplement details that relate to a Care Recipient for Support at Home

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • added updatedAtDateTime as query parameters for Query enteral feeding supplements GET call
    • \n
  • operationId has been updated
    • \n
  • added externalReferenceId in request and query
    • \n
  • added ability to end date oxygen supplement
    • \n
\n
","_postman_id":"858d2fc0-0021-45b0-86f6-6ff659be28aa","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"enteral-feeding-supplement-1.0.0","item":[{"name":"/acws/support-at-home/events/enteral-feeding/v1","id":"bce6f84b-61ab-4015-ac5b-429417a48391","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"description":{"content":"

Start date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"startDateFrom","value":"1960-01-12"},{"description":{"content":"

Start date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"startDateTo","value":"1960-01-12"},{"description":{"content":"

End date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"endDateFrom","value":"1960-01-12"},{"description":{"content":"

End date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"endDateTo","value":"1960-01-12"},{"description":{"content":"

The start of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"eec09f98-75a9-4f1e-9535-2cc89c2d106e","name":"Enteral feeding supplement summary","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Start date from date. Result will be inclusive of date.","key":"startDateFrom","value":"1960-01-12"},{"description":"Start date to date. Result will be inclusive of date.","key":"startDateTo","value":"1960-01-12"},{"description":"End date from date. Result will be inclusive of date.","key":"endDateFrom","value":"1960-01-12"},{"description":"End date to date. Result will be inclusive of date.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NNBO\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-12\",\n \"enteralFeedingTypeText\": \"Normal Bolus\",\n \"status\": \"Approved\",\n \"channel\": \"B2G'INT\",\n \"createdAtDateTime\": \"1972-05-21T23:15:31.340Z\",\n \"updatedAtDateTime\": \"2019-11-27T19:26:45.262Z\"\n },\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NNBO\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-12\",\n \"enteralFeedingTypeText\": \"Normal Bolus\",\n \"status\": \"Approved\",\n \"channel\": \"PRP\",\n \"createdAtDateTime\": \"1960-01-09T00:59:25.386Z\",\n \"updatedAtDateTime\": \"1979-01-15T15:33:22.021Z\"\n }\n]"},{"id":"7e704fe9-53eb-43f0-b83e-c7500ca5929f","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Start date from date. Result will be inclusive of date.","key":"startDateFrom","value":"1960-01-12"},{"description":"Start date to date. Result will be inclusive of date.","key":"startDateTo","value":"1960-01-12"},{"description":"End date from date. Result will be inclusive of date.","key":"endDateFrom","value":"1960-01-12"},{"description":"End date to date. Result will be inclusive of date.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of enteral feeding updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"bce6f84b-61ab-4015-ac5b-429417a48391"},{"name":"/acws/support-at-home/events/enteral-feeding/v1","id":"764be925-7b9f-4e31-9d38-286ef7b8a816","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"bbab9b5c-4686-4a88-86b2-c9c578e3293a","name":"Enteral feeding supplement","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NNBO\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-12\",\n \"enteralFeedingTypeText\": \"Normal Bolus\",\n \"status\": \"Approved\",\n \"channel\": \"B2G'INT\",\n \"createdAtDateTime\": \"1952-02-21T20:12:48.683Z\",\n \"updatedAtDateTime\": \"1975-03-11T17:21:38.511Z\"\n}"},{"id":"47d2820c-c778-491d-a818-bf0a4a7279fd","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"764be925-7b9f-4e31-9d38-286ef7b8a816"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/:supplementId","id":"232ac04d-b236-403c-af25-498d430e8020","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"458f5f01-923e-4fc2-a202-62ba56287f33","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"5815ddca-f4f2-41ed-aee2-a0789595b8cb","name":"Enteral feeding supplement","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-12\",\n \"enteralFeedingTypeText\": \"Normal Bolus\",\n \"status\": \"Approved\",\n \"channel\": \"PRP\",\n \"createdAtDateTime\": \"1966-04-22T17:32:04.093Z\",\n \"updatedAtDateTime\": \"1948-06-14T23:34:02.115Z\",\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ],\n \"attachments\": [\n {\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2019-05-22T17:38:36.004Z\"\n },\n {\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1986-05-21T16:12:50.707Z\"\n }\n ]\n}"},{"id":"7bd597f1-e372-4ab1-859e-931b0b7b318c","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"232ac04d-b236-403c-af25-498d430e8020"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/:supplementId","id":"edfac70e-e0c9-46a8-9317-5ac31b1e9e92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"313a384c-2b30-4562-a6fd-d0a339b9ba4e","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"d8e2b318-d93b-47cf-8c1b-5e9d64444c98","name":"No content","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"a57bb22f-eea6-48a1-8018-45758d5ab47c","name":"Error","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NBO\",\n \"externalReferenceId\": \"External12345\",\n \"endDate\": \"2023-11-12\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"edfac70e-e0c9-46a8-9317-5ac31b1e9e92"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/:supplementId","id":"fbc1fad2-fadf-4526-ae94-01595cb1a8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"ea87cd0b-82c2-4679-a802-407747430229","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"d9526155-c810-4774-a32c-a66d6965da74","name":"Deleted Enteral Feeding supplement","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"startDate\": \"2023-10-15\",\n \"enteralFeedingTypeCode\": \"ENT_NNBO\",\n \"supplementId\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"endDate\": \"2023-11-12\",\n \"enteralFeedingTypeText\": \"Normal Bolus\",\n \"status\": \"Approved\",\n \"channel\": \"B2G'INT\",\n \"createdAtDateTime\": \"1952-02-21T20:12:48.683Z\",\n \"updatedAtDateTime\": \"1975-03-11T17:21:38.511Z\"\n}"},{"id":"bab38693-ecf5-4ba4-8638-a0b110368de1","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"fbc1fad2-fadf-4526-ae94-01595cb1a8ca"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","id":"3f401041-4bcf-4e08-967c-bb249429685f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"d68140c5-ccee-486c-9b9e-80404f335ed3","description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"type":"any","value":"","key":"careRecipientId"},{"id":"76e3d74a-ab42-4aaf-b1c0-44f030a96f01","description":{"content":"

Start date of the enteral feeding supplement.

\n","type":"text/plain"},"type":"any","value":"","key":"startDate"},{"id":"ccf97eae-2b45-419a-98f4-2552557d4781","description":{"content":"

End date of the enteral feeding supplement.

\n","type":"text/plain"},"type":"any","value":"","key":"endDate"}]}},"response":[{"id":"b6938287-aa1f-4cd3-ab30-c6c3ffb40034","name":"End date Enteral Feeding Supplement","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "},{"key":"startDate","value":"","description":"Start date of the enteral feeding supplement."},{"key":"endDate","value":"","description":"End date of the enteral feeding supplement."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"startDate\": \"2023-10-10\",\n \"endDate\": \"2023-11-11\",\n \"status\": \"Approved\",\n \"updatedAtDateTime\": \"2008-04-30T04:27:49.149Z\"\n}"},{"id":"45054537-41b5-4b83-b577-7f1e68d7a501","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/endDateSupplement/care-recipient/:careRecipientId/start-date/:startDate/end-date/:endDate","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1","endDateSupplement","care-recipient",":careRecipientId","start-date",":startDate","end-date",":endDate"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "},{"key":"startDate","value":"","description":"Start date of the enteral feeding supplement."},{"key":"endDate","value":"","description":"End date of the enteral feeding supplement."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"3f401041-4bcf-4e08-967c-bb249429685f"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments","id":"b545503a-3eea-4d9e-a845-0fe4e8db7dd5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2003-08-14T19:33:07.500Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"2de40083-e83b-4518-98eb-954849af9e5f","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"}]}},"response":[{"id":"ae04690f-5ccc-4eb6-8cd6-53323b6142cf","name":"Attachment pdf","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2003-08-14T19:33:07.500Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1957-02-14T19:00:11.525Z\"\n}"},{"id":"dbd05454-245c-49db-a4bc-441f62011849","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"AC011\",\n \"typeText\": \"Application for the Oxygen or Enteral Feeding Supplement Form\",\n \"id\": \"12345\",\n \"filename\": \"TestAttachment\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2003-08-14T19:33:07.500Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"b545503a-3eea-4d9e-a845-0fe4e8db7dd5"},{"name":"/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments/:attachmentId","id":"ed23c243-7665-4de7-b194-b54bd87153d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments/:attachmentId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments",":attachmentId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"0f77a077-c300-430d-ae9f-969c2e15ee70","description":{"content":"

The unique identifier given to a supplement

\n","type":"text/plain"},"type":"any","value":"","key":"supplementId"},{"id":"ae3030d5-67aa-4efb-8b45-1ba0d1e7f9ec","description":{"content":"

The unique identifier given to an attachment

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"684bd4f6-fe72-4aef-80cf-c56bca67a133","name":"Attachment pdf","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments",":attachmentId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"f8c04a3a-3e8e-47ec-8e43-727b469b826b","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/enteral-feeding/v1/:supplementId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","enteral-feeding","v1",":supplementId","attachments",":attachmentId"],"variable":[{"key":"supplementId","value":"","description":"The unique identifier given to a supplement"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ed23c243-7665-4de7-b194-b54bd87153d0"}],"id":"e52dc888-1643-4749-99fc-664e7d81571d","description":"

Enteral Feeding supplements for a Care Recipient for Support at Home

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • added updatedAtDateTime as query parameters for Query enteral feeding supplements GET call
    • \n
  • operationId has been updated
    • \n
  • enteralFeedingTypeCode enumerations and description has been updated
    • \n
  • enteralFeedingTypeText example has been updated
    • \n
  • added externalReferenceId in request and query
    • \n
  • added ability to end date an enteral feeding supplement
    • \n
\n
","_postman_id":"e52dc888-1643-4749-99fc-664e7d81571d","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"claim-1.0.0","item":[{"name":"/acws/support-at-home/claim/v1","id":"c7a633c1-2a1a-4fe8-b305-98d3cd7d2f9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1?serviceProviderId=string&serviceNapsId=strin&status=Completed&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&createdAtDateTimeFrom=2004-10-11T02:49:29.486Z&createdAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","claim","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The National Approved Provider System (NAPS) Id for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The status of the claim

\n
    \n
  • In Error - The claim is in error
    • \n
  • Pending Approval - The claim is pending approval
    • \n
  • Cancelled - The claim has been cancelled/rejected
    • \n
  • Approved - The claim has been approved for payment
    • \n
  • Completed - The claim is paid
    • \n
\n","type":"text/plain"},"key":"status","value":"Completed"},{"description":{"content":"

The start of range query of paymentDate field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"paymentDateFrom","value":"1960-01-12"},{"description":{"content":"

The end of range query of paymentDate field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"paymentDateTo","value":"1960-01-12"},{"description":{"content":"

The start of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The start of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"createdAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"createdAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=paymentDate,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"a4eff0c5-1d20-433b-b14f-070075a68696","name":"Claim summary","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1?serviceProviderId=string&serviceNapsId=strin&status=Completed&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&createdAtDateTimeFrom=2004-10-11T02:49:29.486Z&createdAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1"],"query":[{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System (NAPS) Id for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The status of the claim\n* In Error - The claim is in error\n* Pending Approval - The claim is pending approval\n* Cancelled - The claim has been cancelled/rejected\n* Approved - The claim has been approved for payment\n* Completed - The claim is paid","key":"status","value":"Completed"},{"description":"The start of range query of paymentDate field. Response will be inclusive of date provided.","key":"paymentDateFrom","value":"1960-01-12"},{"description":"The end of range query of paymentDate field. Response will be inclusive of date provided.","key":"paymentDateTo","value":"1960-01-12"},{"description":"The start of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The start of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.","key":"createdAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.","key":"createdAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=paymentDate,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"claimId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"strin\",\n \"paymentDate\": \"2020-12-03\",\n \"status\": \"Pending Approval\",\n \"createdAtDateTime\": \"2000-03-24T08:23:35.519Z\",\n \"updatedAtDateTime\": \"1946-12-04T12:09:51.487Z\"\n },\n {\n \"claimId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"strin\",\n \"paymentDate\": \"2020-12-03\",\n \"status\": \"Completed\",\n \"createdAtDateTime\": \"2020-11-14T05:52:46.204Z\",\n \"updatedAtDateTime\": \"1983-08-21T02:58:32.042Z\"\n }\n]"},{"id":"200ab67c-53d7-4672-ba69-61ff6c5399ae","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1?serviceProviderId=string&serviceNapsId=strin&status=Completed&paymentDateFrom=1960-01-12&paymentDateTo=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&createdAtDateTimeFrom=2004-10-11T02:49:29.486Z&createdAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1"],"query":[{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System (NAPS) Id for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The status of the claim\n* In Error - The claim is in error\n* Pending Approval - The claim is pending approval\n* Cancelled - The claim has been cancelled/rejected\n* Approved - The claim has been approved for payment\n* Completed - The claim is paid","key":"status","value":"Completed"},{"description":"The start of range query of paymentDate field. Response will be inclusive of date provided.","key":"paymentDateFrom","value":"1960-01-12"},{"description":"The end of range query of paymentDate field. Response will be inclusive of date provided.","key":"paymentDateTo","value":"1960-01-12"},{"description":"The start of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of claims updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The start of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.","key":"createdAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of claims createdAtDateTime date time field. Response will be inclusive of date time provided.","key":"createdAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=paymentDate,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"c7a633c1-2a1a-4fe8-b305-98d3cd7d2f9e"},{"name":"/acws/support-at-home/claim/v1/serviceProviderId/:serviceProviderId","id":"91af0cd6-99bf-4198-8514-37b9e39f2495","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/serviceProviderId/:serviceProviderId","description":"

Provides the ability to submit invoices to be claimed.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","claim","v1","serviceProviderId",":serviceProviderId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"176e8015-192f-4113-a92a-4c5f65ecbdbc","description":{"content":"

Service provider identifier

\n","type":"text/plain"},"type":"any","value":"string","key":"serviceProviderId"}]}},"response":[{"id":"6900033f-0ade-4dc1-ac3d-723359128292","name":"Created claim","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/serviceProviderId/:serviceProviderId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1","serviceProviderId",":serviceProviderId"],"variable":[{"key":"serviceProviderId","value":"string","description":"Service provider identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"claimId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"strin\",\n \"paymentDate\": \"2020-12-03\",\n \"status\": \"Completed\",\n \"createdAtDateTime\": \"1965-07-21T16:59:12.475Z\",\n \"updatedAtDateTime\": \"1967-04-07T11:28:08.028Z\"\n}"},{"id":"eeb2812f-0014-45d7-b32e-1698df5e9793","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/serviceProviderId/:serviceProviderId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1","serviceProviderId",":serviceProviderId"],"variable":[{"key":"serviceProviderId","value":"string","description":"Service provider identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"91af0cd6-99bf-4198-8514-37b9e39f2495"},{"name":"/acws/support-at-home/claim/v1/:claimId","id":"05119f11-8aa5-468d-8b2e-b602c435c4ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/:claimId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","claim","v1",":claimId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"efdf2a80-0664-4749-9329-1614a781319a","description":{"content":"

The unique identifier of the claim for the invoice/s is being claimed against.

\n","type":"text/plain"},"type":"any","value":"","key":"claimId"}]}},"response":[{"id":"041ea489-ff65-4eaf-97b4-6d50861ec78d","name":"Claim","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/:claimId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1",":claimId"],"variable":[{"key":"claimId","value":"","description":"The unique identifier of the claim for the invoice/s is being claimed against."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"claimId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"strin\",\n \"paymentDate\": \"2020-12-03\",\n \"status\": \"Paid\",\n \"invoices\": [\n {\n \"invoiceId\": \"12345\"\n },\n {\n \"invoiceId\": \"12345\"\n }\n ],\n \"createdAtDateTime\": \"2004-09-22T09:33:44.114Z\",\n \"updatedAtDateTime\": \"1948-09-08T13:09:56.900Z\",\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"e8f270f7-e046-49e6-9536-060f09be101f","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/claim/v1/:claimId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","claim","v1",":claimId"],"variable":[{"key":"claimId","value":"","description":"The unique identifier of the claim for the invoice/s is being claimed against."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"05119f11-8aa5-468d-8b2e-b602c435c4ba"}],"id":"2932a37f-37c0-4cec-a095-de0d314c62c1","description":"

Information relating to a claim for Support at Home.\nAt least one invoice is required to be submitted in order to claim.\nChanges

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • claimId description updated
    • \n
  • status has been updated
    • \n
  • operationId has been updated
    • \n
  • added messages to claim details response
    • \n
  • submit claim path updated
    • \n
  • added createdAtDateTime to Claim and ClaimSummary responses
    • \n
  • added createdAtDateTimeTo and createdAtDateTimeFrom to query parameters
    • \n
  • removed claimItems from response
    • \n
  • added serviceNapsId to response and query claim as a parameter
    • \n
  • status enumerations have been updated
    • \n
\n
","_postman_id":"2932a37f-37c0-4cec-a095-de0d314c62c1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"reference-data-1.0.0","item":[{"name":"/acws/support-at-home/service-list/v1","id":"6cc977b6-dcd1-40f4-8c43-f004af678bf7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/service-list/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","service-list","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"87ab7e8c-3d27-416f-850a-d7893053895c","name":"Service list","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/service-list/v1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"participantContributionCategory\": \"Everyday living\",\n \"unitType\": \"bill\",\n \"items\": [\n {\n \"functionCode\": \"20 22\",\n \"functionText\": \"Supporting and stimulating blood circulation\",\n \"itemId\": \"20 20 17\",\n \"itemText\": \"Anti-oedema stockings for arms and legs and other parts of the body\",\n \"units\": [\n \"item\",\n \"bill\"\n ],\n \"freeTextRequired\": true\n },\n {\n \"functionCode\": \"20 22\",\n \"functionText\": \"Supporting and stimulating blood circulation\",\n \"itemId\": \"20 20 17\",\n \"itemText\": \"Anti-oedema stockings for arms and legs and other parts of the body\",\n \"units\": [\n \"bill\",\n \"hours\"\n ],\n \"freeTextRequired\": false\n }\n ],\n \"wraparoundServices\": [\n {\n \"wraparoundServiceId\": \"WRAP-0001\",\n \"wraparoundServiceText\": \"Delivery\",\n \"units\": [\n \"voucher\",\n \"bill\"\n ],\n \"freeTextRequired\": false\n },\n {\n \"wraparoundServiceId\": \"WRAP-0001\",\n \"wraparoundServiceText\": \"Delivery\",\n \"units\": [\n \"meal\",\n \"bill\"\n ],\n \"freeTextRequired\": true\n }\n ],\n \"classifications\": [\n {\n \"classificationType\": \"Ongoing\",\n \"classificationCode\": \"508\",\n \"classificationText\": \"SAH Class 1\"\n },\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"507\",\n \"classificationText\": \"SAH Class 1\"\n }\n ],\n \"healthProfessionalTypes\": [\n {\n \"healthProfessionalTypeCode\": \"CAT-0001\",\n \"healthProfessionalTypeText\": \"HM Item\",\n \"freeTextRequired\": false\n },\n {\n \"healthProfessionalTypeCode\": \"CAT-0001\",\n \"healthProfessionalTypeText\": \"HM Item\",\n \"freeTextRequired\": false\n }\n ],\n \"effectiveStartDate\": \"1971-01-06\",\n \"effectiveEndDate\": \"2008-10-05\",\n \"updatedAtDateTime\": \"1955-08-03T16:55:34.587Z\"\n },\n {\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceId\": \"SERV-0001\",\n \"serviceText\": \"House cleaning\",\n \"participantContributionCategory\": \"Everyday living\",\n \"unitType\": \"hours\",\n \"items\": [\n {\n \"functionCode\": \"20 22\",\n \"functionText\": \"Supporting and stimulating blood circulation\",\n \"itemId\": \"20 20 17\",\n \"itemText\": \"Anti-oedema stockings for arms and legs and other parts of the body\",\n \"units\": [\n \"trip\",\n \"item\"\n ],\n \"freeTextRequired\": true\n },\n {\n \"functionCode\": \"20 22\",\n \"functionText\": \"Supporting and stimulating blood circulation\",\n \"itemId\": \"20 20 17\",\n \"itemText\": \"Anti-oedema stockings for arms and legs and other parts of the body\",\n \"units\": [\n \"trip\",\n \"hours\"\n ],\n \"freeTextRequired\": true\n }\n ],\n \"wraparoundServices\": [\n {\n \"wraparoundServiceId\": \"WRAP-0001\",\n \"wraparoundServiceText\": \"Delivery\",\n \"units\": [\n \"trip\",\n \"meal\"\n ],\n \"freeTextRequired\": false\n },\n {\n \"wraparoundServiceId\": \"WRAP-0001\",\n \"wraparoundServiceText\": \"Delivery\",\n \"units\": [\n \"trip\",\n \"item\"\n ],\n \"freeTextRequired\": true\n }\n ],\n \"classifications\": [\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"517\",\n \"classificationText\": \"SAH Class 1\"\n },\n {\n \"classificationType\": \"Ongoing\",\n \"classificationCode\": \"501\",\n \"classificationText\": \"SAH Class 1\"\n }\n ],\n \"healthProfessionalTypes\": [\n {\n \"healthProfessionalTypeCode\": \"CAT-0001\",\n \"healthProfessionalTypeText\": \"HM Item\",\n \"freeTextRequired\": false\n },\n {\n \"healthProfessionalTypeCode\": \"CAT-0001\",\n \"healthProfessionalTypeText\": \"HM Item\",\n \"freeTextRequired\": false\n }\n ],\n \"effectiveStartDate\": \"1954-01-11\",\n \"effectiveEndDate\": \"2000-08-25\",\n \"updatedAtDateTime\": \"2016-11-15T14:00:00.327Z\"\n }\n]"},{"id":"026769f4-a073-4631-8d0c-f479fb09e8a4","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/service-list/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"6cc977b6-dcd1-40f4-8c43-f004af678bf7"},{"name":"/acws/support-at-home/funding-source-list/v1","id":"ec3fff94-0520-425b-adb3-ce3cd135e623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/funding-source-list/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","funding-source-list","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"b0cb2bfe-a171-47e3-98b1-723baafb794f","name":"Mapping of funding source to entry type, classification and budget required to claim for that funding source","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/funding-source-list/v1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"fundingSourceCode\": \"AT\",\n \"fundingSourceText\": \"Assistive technology\",\n \"entryCategories\": [\n {\n \"entryCategoryCode\": \"AT\",\n \"entryCategoryText\": \"Assistive technology\"\n },\n {\n \"entryCategoryCode\": \"AT\",\n \"entryCategoryText\": \"Assistive technology\"\n }\n ],\n \"classifications\": [\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"519\",\n \"classificationText\": \"SAH Class 1\"\n },\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"526\",\n \"classificationText\": \"SAH Class 1\"\n }\n ],\n \"budgetClaimingSequence\": [\n {\n \"priority\": 1,\n \"budgetTypeCode\": \"AT\",\n \"budgetTypeText\": \"Assistive technology\"\n },\n {\n \"priority\": 1,\n \"budgetTypeCode\": \"AT\",\n \"budgetTypeText\": \"Assistive technology\"\n }\n ]\n },\n {\n \"fundingSourceCode\": \"AT\",\n \"fundingSourceText\": \"Assistive technology\",\n \"entryCategories\": [\n {\n \"entryCategoryCode\": \"AT\",\n \"entryCategoryText\": \"Assistive technology\"\n },\n {\n \"entryCategoryCode\": \"AT\",\n \"entryCategoryText\": \"Assistive technology\"\n }\n ],\n \"classifications\": [\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"514\",\n \"classificationText\": \"SAH Class 1\"\n },\n {\n \"classificationType\": \"Ongoing\",\n \"classificationCode\": \"504\",\n \"classificationText\": \"SAH Class 1\"\n }\n ],\n \"budgetClaimingSequence\": [\n {\n \"priority\": 1,\n \"budgetTypeCode\": \"AT\",\n \"budgetTypeText\": \"Assistive technology\"\n },\n {\n \"priority\": 1,\n \"budgetTypeCode\": \"AT\",\n \"budgetTypeText\": \"Assistive technology\"\n }\n ]\n }\n]"},{"id":"ebde00cf-f4df-4036-966e-5865863ffaf2","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/funding-source-list/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ec3fff94-0520-425b-adb3-ce3cd135e623"},{"name":"/acws/support-at-home/late-submission-list/v1","id":"6676ca6e-6a69-498d-b527-1aff9deeb018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/late-submission-list/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","late-submission-list","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"07b42eb7-6a22-4779-a95e-40b1891e7911","name":"Service list","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/late-submission-list/v1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"lateSubmissionCode\": \"LEAVE\",\n \"shortText\": \"Staff on leave (annual and personal)\",\n \"longText\": \"string\",\n \"freeTextRequired\": false,\n \"attachmentsRequired\": false\n },\n {\n \"lateSubmissionCode\": \"LEAVE\",\n \"shortText\": \"Staff on leave (annual and personal)\",\n \"longText\": \"string\",\n \"freeTextRequired\": true,\n \"attachmentsRequired\": false\n }\n]"},{"id":"2dbe2c71-4752-497c-82c4-cb8a372836aa","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/late-submission-list/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"6676ca6e-6a69-498d-b527-1aff9deeb018"},{"name":"/acws/support-at-home/budget-codes/v1","id":"24617ef5-1955-456b-857e-976782bc087d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budget-codes/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budget-codes","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"42ec2a73-c9b2-4f72-9310-881c41981aae","name":"Service list","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budget-codes/v1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"entitlementCodes\": [\n {\n \"budgetItemCode\": \"string\",\n \"budgetItemText\": \"string\",\n \"rates\": [\n {\n \"rate\": 1311.74,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n },\n {\n \"rate\": 4425.14,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n }\n ]\n },\n {\n \"budgetItemCode\": \"string\",\n \"budgetItemText\": \"string\",\n \"rates\": [\n {\n \"rate\": 3255.07,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n },\n {\n \"rate\": 6428.93,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n }\n ]\n }\n ],\n \"usageCodes\": [\n {\n \"budgetItemCode\": \"string\",\n \"budgetItemText\": \"string\",\n \"rates\": [\n {\n \"rate\": 238.11,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n },\n {\n \"rate\": 3124.28,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n }\n ]\n },\n {\n \"budgetItemCode\": \"string\",\n \"budgetItemText\": \"string\",\n \"rates\": [\n {\n \"rate\": 2853.2000000000003,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n },\n {\n \"rate\": 9264.45,\n \"frequency\": \"string\",\n \"frequencyPeriod\": \"string\",\n \"validFrom\": \"string\",\n \"validTo\": \"string\"\n }\n ]\n }\n ]\n}"},{"id":"ca89a54b-bd7f-416f-a243-56e8e6742393","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budget-codes/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"24617ef5-1955-456b-857e-976782bc087d"},{"name":"/acws/support-at-home/service-list/v1","id":"d0987684-04bc-481e-8cef-b574318ac913","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"p-acd6c813-63d3-4e04-871e-b3087523fe94","disabled":false},{"key":"org-id","value":"13139","disabled":false},{"key":"Accept","value":"application/json","disabled":false},{"key":"Authorization","value":"apikey {{apiKey}}","disabled":false}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/service-list/v1","description":"

Generated from cURL: curl --location 'https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/service-list/v1' --header 'provider-id: p-acd6c813-63d3-4e04-871e-b3087523fe94' --header 'org-id: 13139' --header 'Accept: application/json' --header 'Authorization: apikey {{apiKey}}'

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"protocol":"https","path":["sah","gateway","native","acws","support-at-home","service-list","v1"],"host":["api","quickclaim","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"d0987684-04bc-481e-8cef-b574318ac913"}],"id":"9fa96a12-8208-49ce-8951-2addd7379bd0","description":"

Relates to the service list for enumerations.

\n

This will assist in validating

\n
    \n
  • the values that are required when submitting invoices on what services have been provided via the Support at Home Invoice API.
    • \n
  • the services a Care Recipient is approved for that is shown on the Care Recipient Summary API
    • \n
  • the services a service provider is approved to provide that is shown in the Support at Home service provider summary API
    • \n
\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • added updatedAtDateTime to response
    • \n
  • operationId has been updated
    • \n
  • API name update to Support at Home Reference data
    • \n
  • classification entity created to include classificationType, classificationCode and classificationText
    • \n
  • added AT/HM reference data calls
    • \n
  • added following GET calls
    • \n
      \n
    • Under Invoice item reference data
      • \n
        \n
      • Item category codes
        • \n
      • Health professional list
        • \n
      • Funding source
        • \n
      • Late submission codes
        • \n
      \n
    • Budget reference data
      • \n
    \n
  • GET list of AT HM items and GET list of wraparound services have been merged into GET service list call
    • \n
  • itemCategories entity has been removed
    • \n
  • budget codes response entity updated
    • \n
\n
","_postman_id":"9fa96a12-8208-49ce-8951-2addd7379bd0","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"invoices-1.1.0","item":[{"name":"/acws/service/support-at-home/invoice/v1","id":"3a71bc0c-6ea8-4885-9b1b-f40784a8b33b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"provider-id","value":"p-acd6c813-63d3-4e04-871e-b3087523fe94","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"13139","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"apikey 1Ne8kQYBPVz7km41?sOwY0GKGWfNEysA@mBOp32m","type":"text"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1","urlObject":{"path":["acws","service","support-at-home","invoice","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"disabled":true,"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"disabled":true,"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"disabled":true,"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"disabled":true,"description":{"content":"

The status of the invoice:

\n
    \n
  • OPEN - Invoice items can only be edited from OPEN status. Invoice must be submitted to be claimed
    • \n
  • SUBMITTED - Invoice has been submitted and is ready to be claimed
    • \n
  • HELD - Invoice is held internally by Services Australia pending approval. No action is required by provider.
    • \n
  • DELETED - Invoice is deleted
    • \n
  • CLAIMED - Invoice has been claimed and claim is in progress
    • \n
  • COMPLETED - Invoice is completed when claim has been paid
    • \n
\n","type":"text/plain"},"key":"status","value":"HELD"},{"disabled":true,"description":{"content":"

The start of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"disabled":true,"description":{"content":"

The end of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"disabled":true,"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"

The fields the response will be sorted on.

\n

Multiple values can be provided comma separated ie\nsort-fields=externalReferenceId,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"disabled":true,"description":{"content":"

The order the fields will be sorted. This will apply to all\nsort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"6fed05f9-df9d-4a18-b5be-ada40000f4bf","name":"Invoice details","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1?serviceNapsId=strin&serviceProviderId=string&externalReferenceId=string&status=HELD&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"The status of the invoice:\n * OPEN - Invoice items can only be edited from OPEN status. Invoice must be submitted to be claimed\n * SUBMITTED - Invoice has been submitted and is ready to be claimed\n * HELD - Invoice is held internally by Services Australia pending approval. No action is required by provider.\n * DELETED - Invoice is deleted\n * CLAIMED - Invoice has been claimed and claim is in progress\n * COMPLETED - Invoice is completed when claim has been paid","key":"status","value":"HELD"},{"description":"The start of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\n\nMultiple values can be provided comma separated ie\nsort-fields=externalReferenceId,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all\nsort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"2013-08-11T12:40:09.163Z\",\n \"updatedAtDateTime\": \"1946-11-02T19:46:23.091Z\"\n },\n {\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1997-11-24T08:40:25.547Z\",\n \"updatedAtDateTime\": \"1985-12-17T12:57:32.885Z\"\n }\n]"},{"id":"c9052094-cf8a-452d-b4cd-4e8deb95c955","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1?serviceNapsId=strin&serviceProviderId=string&externalReferenceId=string&status=HELD&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"The status of the invoice:\n * OPEN - Invoice items can only be edited from OPEN status. Invoice must be submitted to be claimed\n * SUBMITTED - Invoice has been submitted and is ready to be claimed\n * HELD - Invoice is held internally by Services Australia pending approval. No action is required by provider.\n * DELETED - Invoice is deleted\n * CLAIMED - Invoice has been claimed and claim is in progress\n * COMPLETED - Invoice is completed when claim has been paid","key":"status","value":"HELD"},{"description":"The start of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of invoices updatedAtDateTime\ndate time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\n\nMultiple values can be provided comma separated ie\nsort-fields=externalReferenceId,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all\nsort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"3a71bc0c-6ea8-4885-9b1b-f40784a8b33b"},{"name":"/acws/service/support-at-home/invoice/v1","id":"cab6854e-5462-4958-9029-c75732f66b15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1978-03-10T17:39:16.152Z\",\n \"updatedAtDateTime\": \"1946-06-22T02:02:43.369Z\",\n \"items\": [\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"ON\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-02-20T19:01:25.715Z\",\n \"updatedAtDateTime\": \"1980-01-11T07:42:45.107Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1993-04-28T20:04:05.987Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1949-09-11T16:27:37.180Z\"\n }\n ]\n },\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"RC\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": true,\n \"createdAtDateTime\": \"1994-11-29T12:41:55.958Z\",\n \"updatedAtDateTime\": \"1991-02-10T14:25:53.814Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1978-09-19T18:21:50.931Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1964-02-08T12:36:01.654Z\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1?submit=false","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

Defines whether the invoice being created will be auto submitted and\nwill be automatically created in submitted status.

\n
    \n
  • true - Auto submit invoice
    • \n
  • false - Invoice will be created in Open status
    • \n
\n","type":"text/plain"},"key":"submit","value":"false"}],"variable":[]}},"response":[{"id":"768faee7-5d6a-405f-b87d-20f5e9ca8d60","name":"Invoice details","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1978-03-10T17:39:16.152Z\",\n \"updatedAtDateTime\": \"1946-06-22T02:02:43.369Z\",\n \"items\": [\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"ON\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-02-20T19:01:25.715Z\",\n \"updatedAtDateTime\": \"1980-01-11T07:42:45.107Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1993-04-28T20:04:05.987Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1949-09-11T16:27:37.180Z\"\n }\n ]\n },\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"RC\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": true,\n \"createdAtDateTime\": \"1994-11-29T12:41:55.958Z\",\n \"updatedAtDateTime\": \"1991-02-10T14:25:53.814Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1978-09-19T18:21:50.931Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1964-02-08T12:36:01.654Z\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1?submit=false","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1"],"query":[{"description":"Defines whether the invoice being created will be auto submitted and\nwill be automatically created in submitted status.\n\n * true - Auto submit invoice\n * false - Invoice will be created in Open status","key":"submit","value":"false"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1978-03-10T17:39:16.152Z\",\n \"updatedAtDateTime\": \"1946-06-22T02:02:43.369Z\",\n \"items\": [\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"ON\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-02-20T19:01:25.715Z\",\n \"updatedAtDateTime\": \"1980-01-11T07:42:45.107Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1993-04-28T20:04:05.987Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1949-09-11T16:27:37.180Z\"\n }\n ]\n },\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"RC\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": true,\n \"createdAtDateTime\": \"1994-11-29T12:41:55.958Z\",\n \"updatedAtDateTime\": \"1991-02-10T14:25:53.814Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1978-09-19T18:21:50.931Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1964-02-08T12:36:01.654Z\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"4c1e4616-be70-43ce-b84a-fbfbc9859b0c","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1978-03-10T17:39:16.152Z\",\n \"updatedAtDateTime\": \"1946-06-22T02:02:43.369Z\",\n \"items\": [\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"ON\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-02-20T19:01:25.715Z\",\n \"updatedAtDateTime\": \"1980-01-11T07:42:45.107Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1993-04-28T20:04:05.987Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1949-09-11T16:27:37.180Z\"\n }\n ]\n },\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"RC\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": true,\n \"createdAtDateTime\": \"1994-11-29T12:41:55.958Z\",\n \"updatedAtDateTime\": \"1991-02-10T14:25:53.814Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1978-09-19T18:21:50.931Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1964-02-08T12:36:01.654Z\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1?submit=false","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1"],"query":[{"description":"Defines whether the invoice being created will be auto submitted and\nwill be automatically created in submitted status.\n\n * true - Auto submit invoice\n * false - Invoice will be created in Open status","key":"submit","value":"false"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"cab6854e-5462-4958-9029-c75732f66b15"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId","id":"ca194498-e0e4-4b89-8ba9-2d183dc3e219","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"dcc49512-e213-4577-9791-2115da5cb86e","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"}]}},"response":[{"id":"64921801-af8a-44e0-96a3-fcad473a3112","name":"Invoice details","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"1978-03-10T17:39:16.152Z\",\n \"updatedAtDateTime\": \"1946-06-22T02:02:43.369Z\",\n \"items\": [\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"ON\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-02-20T19:01:25.715Z\",\n \"updatedAtDateTime\": \"1980-01-11T07:42:45.107Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1993-04-28T20:04:05.987Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1949-09-11T16:27:37.180Z\"\n }\n ]\n },\n {\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"DELETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"RC\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"PURCHASED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": true,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": true,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": true,\n \"createdAtDateTime\": \"1994-11-29T12:41:55.958Z\",\n \"updatedAtDateTime\": \"1991-02-10T14:25:53.814Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1978-09-19T18:21:50.931Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1964-02-08T12:36:01.654Z\"\n }\n ]\n }\n ],\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"5e4cb013-78c2-4a6c-8e7e-75e5d5c98771","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ca194498-e0e4-4b89-8ba9-2d183dc3e219"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/submit","id":"512ebede-00e6-4d0a-8998-4988c756679c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/submit","description":"

Changes status of invoice from Draft to Submitted.\nInvoices must be submitted to be able to be claimed.\nCan only be called for invoices in Draft status.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","submit"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"e4fb1fc1-97d6-4270-88be-c552179cbcdb","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"}]}},"response":[{"id":"16e8601f-c87b-4732-9448-7160552c2156","name":"Invoice details","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/submit","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","submit"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"2020-01-30T12:02:04.837Z\",\n \"updatedAtDateTime\": \"2023-06-24T22:29:18.179Z\"\n}"},{"id":"1566c876-9de7-413b-9c0a-c637770c660a","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/submit","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","submit"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"512ebede-00e6-4d0a-8998-4988c756679c"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/open","id":"d78e2fd1-b3f0-49d6-b32c-1a45339d679d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/open","description":"

Changes status of invoice from Completed or Submitted to Open. Can only be called for invoices in Completed or Submitted status.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","open"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"35df2fc4-46d4-4173-a1d7-409fff9bd178","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"}]}},"response":[{"id":"58a21d1a-b0db-44fd-8611-a47e17177b60","name":"Invoice details","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/open","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","open"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"2020-01-30T12:02:04.837Z\",\n \"updatedAtDateTime\": \"2023-06-24T22:29:18.179Z\"\n}"},{"id":"d13f570e-63ae-4c76-85f5-46b33c85d971","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/open","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","open"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"d78e2fd1-b3f0-49d6-b32c-1a45339d679d"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/delete","id":"23e056a4-40f0-4e7c-b60a-21d5f96c7c6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/delete","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","delete"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"40950a91-e1dd-4e84-9adc-90458f7414ee","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"}]}},"response":[{"id":"a3757451-3f69-48aa-ba34-29e6c0df1e71","name":"Invoice details","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/delete","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","delete"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceProviderId\": \"40123234\",\n \"invoiceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"externalReferenceId\": \"Ext 12345\",\n \"status\": \"CLAIMED\",\n \"createdAtDateTime\": \"2020-01-30T12:02:04.837Z\",\n \"updatedAtDateTime\": \"2023-06-24T22:29:18.179Z\"\n}"},{"id":"fd32f7db-3dfc-4761-bff1-f78fba9aa77d","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/delete","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","delete"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"23e056a4-40f0-4e7c-b60a-21d5f96c7c6c"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/item","id":"06d0ae5a-5b1f-4576-a7f2-20894b1e0ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"0b63b2ca-10ce-41a6-91b3-d827414ac77c","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"}]}},"response":[{"id":"ced14eb5-d8bd-4b3f-afbd-bcdffcf76381","name":"Invoice details","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"COMPLETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": false,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-06-07T09:54:34.085Z\",\n \"updatedAtDateTime\": \"1948-08-17T21:51:26.294Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1970-08-26T11:16:35.992Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2022-07-31T10:27:08.243Z\"\n }\n ]\n}"},{"id":"675a7c1f-f327-4b87-b424-af5f4e4d1f4c","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"06d0ae5a-5b1f-4576-a7f2-20894b1e0ab3"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","id":"21ef1cb4-3c68-4d99-a548-d2d936d4b0c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"24a1780f-e9fa-4c76-b6c7-7295dc88a6a8","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"},{"id":"0d18c13f-4322-467d-84a2-6e40bc4aa7ca","description":{"content":"

The unique identifier given to an item within an invoice.

\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"98d4cbd2-f9c0-4810-85c3-63e1a041ad53","name":"Invoice item","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"itemId\": \"12345\",\n \"externalReferenceId\": \"12345\",\n \"itemStatus\": \"COMPLETED\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"serviceGroupId\": \"SERG-0001\",\n \"serviceGroupText\": \"Home support\",\n \"serviceTypeId\": \"SERT-0001\",\n \"serviceTypeText\": \"Home maintenance\",\n \"serviceText\": \"House cleaning\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"fundingSourceText\": \"Home Support ongoing\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"functionCode\": \"12 22\",\n \"functionText\": \"Walking, manipulated by one arm\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescriptionText\": \"Finger orthoses\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescriptionText\": \"Finger orthoses\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"N\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeText\": \"Allied health assistance\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionReasonText\": \"string\",\n \"lateSubmissionJustification\": \"\",\n \"attachmentProvided\": false,\n \"attachmentRequired\": false,\n \"furtherInformationRequired\": false,\n \"createdAtDateTime\": \"1992-06-07T09:54:34.085Z\",\n \"updatedAtDateTime\": \"1948-08-17T21:51:26.294Z\",\n \"attachments\": [\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1970-08-26T11:16:35.992Z\"\n },\n {\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2022-07-31T10:27:08.243Z\"\n }\n ]\n}"},{"id":"c3367ac1-532b-4769-bc80-4220ef782b20","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"},{"id":"19e3e94a-a9d9-48a9-b06b-4665a13991b3","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"21ef1cb4-3c68-4d99-a548-d2d936d4b0c0"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","id":"aa13e64d-af07-4129-8480-dbee3956f8d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"f45d3723-6b03-4775-8612-29ede5f5c56d","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"},{"id":"e3e4e8a3-465a-4483-8207-b4ec018c8e09","description":{"content":"

The unique identifier given to an item within an invoice.

\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"46997fd8-39c5-4170-a4bf-e6bbc09d1c1d","name":"No content","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7176167b-a8b5-4ba7-b203-217d1aa0af1f","name":"Error","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"careRecipientId\": \"12345\",\n \"serviceId\": \"SERV-0001\",\n \"deliveryDate\": \"2024-10-01\",\n \"quantity\": 2,\n \"pricePerUnit\": 50,\n \"externalReferenceId\": \"12345\",\n \"unitType\": \"hours\",\n \"fundingSource\": \"AT\",\n \"deliveredByThirdParty\": false,\n \"itemOrWraparound\": \"ITEM\",\n \"itemDescriptionCode\": \"12 22 34\",\n \"itemDescription\": \"string\",\n \"wraparoundDescriptionCode\": \"ITEM-001\",\n \"wraparoundDescription\": \"Installation\",\n \"prescribedItem\": \"Y\",\n \"purchaseMethodType\": \"LOANED\",\n \"loanedByOrganisationName\": \"Pharmacy\",\n \"loanedByInvoiceNumber\": \"Pharmacy Invoice Number 12345\",\n \"healthProfessionalTypeCode\": \"SERV-0027\",\n \"healthProfessionalTypeOther\": \"Allied health assistance\",\n \"itemFirstPayment\": false,\n \"lateSubmissionReasonCode\": \"string\",\n \"lateSubmissionJustification\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"aa13e64d-af07-4129-8480-dbee3956f8d8"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","id":"582c5770-4031-4841-99a3-9f1307d487d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","description":"

This provides the ability to delete an item from an invoice. Once\nit is deleted it can no longer be edited and will not be considered\nfor payment.

\n

Only unclaimed items can be deleted.\nOnce an invoice is in completed status and items have been processed for payment to achieve the same outcome as deletion the amount or quantity can be set to 0.

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"611781db-e13b-4702-9a01-bf3e3cd06c11","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"},{"id":"695ea9af-fdae-40cb-b732-941dae27037a","description":{"content":"

The unique identifier given to an item within an invoice.

\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"0c03d259-b92e-49a2-9c73-29743adc70e6","name":"No content","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7dd839be-d597-4ee4-a0f1-b4f3dd0b0553","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"582c5770-4031-4841-99a3-9f1307d487d5"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId/attachments","id":"ca042b7c-a8e6-4af8-94ff-bdc109ac4b57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1977-03-15T10:50:50.748Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId/attachments","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId","attachments"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"8637335e-5d72-4717-8f44-3a7098915f5d","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"},{"id":"97c32166-ffe9-4ae8-a8e6-42968aa299ee","description":{"content":"

The unique identifier given to an item within an invoice.

\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"f57e0019-f852-4e89-98d0-80e34da66547","name":"Attachment pdf. No content. Use Get invoice item details to obtain details of the uploaded attachment for retrieve attachment call.","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1977-03-15T10:50:50.748Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId","attachments"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ac48d71a-bd97-43b1-9fed-b47c7a1ee345","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"fileContent\": \"string\",\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"1977-03-15T10:50:50.748Z\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/item/:itemId/attachments","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","item",":itemId","attachments"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"itemId","value":"","description":"The unique identifier given to an item within an invoice."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ca042b7c-a8e6-4af8-94ff-bdc109ac4b57"},{"name":"/acws/service/support-at-home/invoice/v1/:invoiceId/attachments/:attachmentId","id":"aabe80fc-df0a-4dd4-b93c-21b489349679","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/attachments/:attachmentId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1",":invoiceId","attachments",":attachmentId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"d7c8574e-dc4e-4dca-a2f7-ea0e15327275","description":{"content":"

The unique identifier given to an invoice

\n","type":"text/plain"},"type":"any","value":"","key":"invoiceId"},{"id":"9ec1ac58-01e8-4e1e-bf88-a23aa263f984","description":{"content":"

The unique identifier given to an attachment

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"21bfb65a-fc00-4d20-bb32-d357e73a8c7e","name":"Attachment pdf","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","attachments",":attachmentId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"91f27427-a29d-463f-9457-fb09be3f4ba7","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/:invoiceId/attachments/:attachmentId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1",":invoiceId","attachments",":attachmentId"],"variable":[{"key":"invoiceId","value":"","description":"The unique identifier given to an invoice"},{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"aabe80fc-df0a-4dd4-b93c-21b489349679"},{"name":"/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/details","id":"a84d0d96-f4d6-4601-b7eb-3afd80709015","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/details","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","details"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"e299a131-2bef-466c-b756-7be9a7a0020b","description":{"content":"

The unique identifier given to an attachment

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"d367941b-b5b6-463e-a8f7-7c6c1dae3205","name":"Invoice item attachment details","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/details","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","details"],"variable":[{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"INVOICE\",\n \"typeText\": \"Invoice\",\n \"id\": \"12345\",\n \"filename\": \"InvoiceNumber12345\",\n \"mimeType\": \"application/pdf\",\n \"createdAtDateTime\": \"2005-11-29T07:54:12.646Z\"\n}"},{"id":"685b6ee3-89eb-4142-a941-864c5d861853","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/details","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","details"],"variable":[{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"a84d0d96-f4d6-4601-b7eb-3afd80709015"},{"name":"/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/delete","id":"7bc27fcb-0a63-4c2e-9aaa-fbcb6cddf9fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/delete","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","delete"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"73900a7f-f113-4cd9-afe4-c394e1dcdcdc","description":{"content":"

The unique identifier given to an attachment

\n","type":"text/plain"},"type":"any","value":"","key":"attachmentId"}]}},"response":[{"id":"a6f8a490-6214-4e5d-b672-cc95428196f1","name":"Attachment pdf","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/delete","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","delete"],"variable":[{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"null"},{"id":"b3442724-74ef-436b-990a-bcf7787872f8","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/service/support-at-home/invoice/v1/attachments/:attachmentId/delete","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","service","support-at-home","invoice","v1","attachments",":attachmentId","delete"],"variable":[{"key":"attachmentId","value":"","description":"The unique identifier given to an attachment"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"7bc27fcb-0a63-4c2e-9aaa-fbcb6cddf9fd"}],"id":"a6307dec-9a22-4a35-978b-d1fbd9e66d3e","description":"

Provide the required support and functionality to support invoicing for\nSupport at Home.

\n

The maximum number of items that can be per invoice is 10 000 including\ndeleted items.

\n

The functionality this API provides is the ability to:

\n
    \n
  • query invoice details
    • \n
  • get details about a specific invoice
    • \n
  • create an invoice
    • \n
  • add new items to an existing invoice
    • \n
  • update items in an existing invoice
    • \n
  • delete items in an existing invoice
    • \n
  • delete an invoice
    • \n
  • submit an invoice to be processed
    • \n
  • upload attachments relating to specific items within an invoice
    • \n
  • retrieve attachments
    • \n
\n

Refer to items entity to view additional fields that might be required\ndepending on what service is being invoiced.

\n

If you've previously claimed for an invoice item that should not have been claimed for (example user error in claiming), you can use the amend function to change the invoiced amounts to $0. \nThis will result in a correction to the amounts originally claimed.

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • basePath updated
    • \n
  • serviceGroup renamed to serviceGroupId
    • \n
  • serviceType renamed to serviceTypeId
    • \n
  • service renamed to serviceId
    • \n
  • loandedByOrganisationName renamed to loanedByOrganisationName
    • \n
  • descriptions updated
    • \n
      \n
    • fundingSource
      • \n
    • pricePerUnit
      • \n
    • quantity
      • \n
    • itemCategory
      • \n
    • itemCategoryDescription
      • \n
    • prescribedItem
      • \n
    • purchasedMethodType
      • \n
    • loanedByOrganisationName
      • \n
    • loanedByInvoiceNumber
      • \n
    • healthProfessionalType
      • \n
    • itemFirstPayment
      • \n
    • justifications
      • \n
    • conditions
      • \n
    • loanFrom
      • \n
    • declaration
      • \n
    • lateSubmissionJustification
      • \n
    • lateSubmissionReason
      • \n
    \n
  • firstItemPayment type been updated
    • \n
  • examples have been added
    • \n
  • enumerations have been added
    • \n
      \n
    • status
      • \n
    • healthProfessionalType
      • \n
    \n
  • description updated for POST Upload attachment
    • \n
  • operationId has been updated
    • \n
  • deliveredByThirdParty has been added
    • \n
  • loanFrom has been removed and incorporated into loanedByOrganisationName
    • \n
  • added Submit and open invoice calls
    • \n
  • added get invoice item details call
    • \n
  • Invoice and invoice item has been simplified to reduce duplicated entities
  • \n
  • item and wraparound fields have been added to item entity
    • \n
  • documentation has been cleaned up in relation to what fields are required. This has been added to the TECH SIS document
    • \n
  • status enumerations have been updated
    • \n
  • fundingSource enumerations have been added
    • \n
  • prescribedItem has been updated
    • \n
  • renamed healthProfessionalType to healthProfessionalTypeCode
    • \n
  • added fields
    • \n
      \n
    • healthProfessionalTypeText
      • \n
    • healthProfessionalTypeOther
      • \n
    \n
  • removed fields
    • \n
      \n
    • justification
      • \n
    • conditions
      • \n
    • declaration
      • \n
    \n
  • attachment type enumerations have been updated
    • \n
  • serviceProviderId has been added to invoice summary response entity
    • \n
  • removed not required body parameter on delete invoice item
    • \n
  • added externalReferenceId to Item entity
    • \n
  • removed not required parameters on get invoice item details
  • \n
  • update submit, re-open and delete invoice from put to post
    • \n
  • removed serviceGroupId and serviceTypeId from required fields
    • \n
  • added fields to Item entity
    • \n
      \n
    • itemStatus
      • \n
    • attachmentProvided
      • \n
    • attachmentRequired
      • \n
    • furtherInformationRequired
      • \n
    \n
  • description have been updated
    • \n
      \n
    • careRecipientId
      • \n
    • serviceId
      • \n
    • deliveryDate
      • \n
    • itemDescription
      • \n
    • itemCategoryDescription
      • \n
    • itemDescriptionCode
      • \n
    • lateSubmissionReasonCode
      • \n
    • description and enumerations have been updated
      • \n
        \n
      • unitType
        • \n
      • healthProfessionalTypeCode
        • \n
      \n
    • unitType is no longer read only and can be submitted
      • \n
    • functionCode has the description updated and is now read only
      • \n
    • removed itemCategoryDescription
      • \n
    • updated fundingSource enumerations and description
      • \n
    • itemCategoryCode, itemCategoryText and itemCategory have been removed
      • \n
    • Response for upload attachment has been updated
      • \n
    • API description has been updated
      • \n
    • added get attachment details and delete attachment calls
      • \n
","_postman_id":"a6307dec-9a22-4a35-978b-d1fbd9e66d3e","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"entry-departure-1.0.0","item":[{"name":"/acws/support-at-home/events/entry/v1","id":"f120b26e-22c1-4b44-891d-902c6ef247d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&entryDateFrom=1960-01-12&entryDateTo=1960-01-12&departureDateFrom=1960-01-12&departureDateTo=current date if only departureDateFrom is selected&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","entry","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.
Optional

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"description":{"content":"

Entry date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"entryDateFrom","value":"1960-01-12"},{"description":{"content":"

Entry date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"entryDateTo","value":"1960-01-12"},{"description":{"content":"

Departure date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"departureDateFrom","value":"1960-01-12"},{"description":{"content":"

Departure date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"departureDateTo","value":"current date if only departureDateFrom is selected"},{"description":{"content":"

The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"269bac7a-1094-4c94-a1ce-d7559b74f37e","name":"Entry summary","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&entryDateFrom=1960-01-12&entryDateTo=1960-01-12&departureDateFrom=1960-01-12&departureDateTo=current date if only departureDateFrom is selected&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.
Optional","key":"externalReferenceId","value":"string"},{"description":"Entry date from date. Result will be inclusive of date.","key":"entryDateFrom","value":"1960-01-12"},{"description":"Entry date to date. Result will be inclusive of date.","key":"entryDateTo","value":"1960-01-12"},{"description":"Departure date from date. Result will be inclusive of date.","key":"departureDateFrom","value":"1960-01-12"},{"description":"Departure date to date. Result will be inclusive of date.","key":"departureDateTo","value":"current date if only departureDateFrom is selected"},{"description":"The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"2004-10-29\",\n \"entryCategoryCode\": \"HC\",\n \"eventId\": \"12345\",\n \"status\": \"Deleted\",\n \"channel\": \"B2G\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"entryCategoryText\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"departureDate\": \"1999-07-18\",\n \"departureReasonCode\": \"THOSP\",\n \"departureEventId\": \"12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"Co-resident\",\n \"awardOrSettlementTypeCode\": \"CL\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"\",\n \"awardOrSettlementTypeText\": \"Worker's compensation\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"createdAtDateTime\": \"1981-05-29T00:40:19.162Z\",\n \"updatedAtDateTime\": \"1977-03-10T14:01:28.263Z\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n },\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n },\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"2025-04-23\",\n \"entryCategoryCode\": \"RC\",\n \"eventId\": \"12345\",\n \"status\": \"Accepted\",\n \"channel\": \"B2G\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"entryCategoryText\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"departureDate\": \"1950-11-03\",\n \"departureReasonCode\": \"DECEA\",\n \"departureEventId\": \"12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"CL\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"\",\n \"awardOrSettlementTypeText\": \"Worker's compensation\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"createdAtDateTime\": \"2021-09-13T09:35:22.095Z\",\n \"updatedAtDateTime\": \"1974-05-29T03:57:42.450Z\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n },\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n }\n]"},{"id":"ecf2b701-e9f7-48d1-83af-55bc8436d768","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&entryDateFrom=1960-01-12&entryDateTo=1960-01-12&departureDateFrom=1960-01-12&departureDateTo=current date if only departureDateFrom is selected&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.
Optional","key":"externalReferenceId","value":"string"},{"description":"Entry date from date. Result will be inclusive of date.","key":"entryDateFrom","value":"1960-01-12"},{"description":"Entry date to date. Result will be inclusive of date.","key":"entryDateTo","value":"1960-01-12"},{"description":"Departure date from date. Result will be inclusive of date.","key":"departureDateFrom","value":"1960-01-12"},{"description":"Departure date to date. Result will be inclusive of date.","key":"departureDateTo","value":"current date if only departureDateFrom is selected"},{"description":"The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"f120b26e-22c1-4b44-891d-902c6ef247d2"},{"name":"/acws/support-at-home/events/entry/v1","id":"153ee278-eb74-4958-8680-46d7a0bcf626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"temp-access-key","value":"string","description":"

Temporary access key.\nRequired when entering a care recipient into care that has not previous been in care in one of your services.\nTemporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","entry","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"56f08072-111b-4393-808e-c69ab7409b4d","name":"Entry","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"Temporary access key.\nRequired when entering a care recipient into care that has not previous been in care in one of your services.\nTemporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.","key":"temp-access-key","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1994-07-26\",\n \"entryCategoryCode\": \"HM\",\n \"eventId\": \"12345\",\n \"status\": \"Accepted\",\n \"channel\": \"B2G\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"entryCategoryText\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"departureDate\": \"1949-08-02\",\n \"departureReasonCode\": \"THOSP\",\n \"departureEventId\": \"12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No carer\",\n \"awardOrSettlementTypeCode\": \"TP\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"N\",\n \"awardOrSettlementTypeText\": \"Worker's compensation\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"createdAtDateTime\": \"2007-07-26T08:18:21.180Z\",\n \"updatedAtDateTime\": \"1980-07-30T22:56:08.741Z\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n },\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"391a402b-c73c-4ebb-916b-3fcc4657812e","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"Temporary access key.\nRequired when entering a care recipient into care that has not previous been in care in one of your services.\nTemporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.","key":"temp-access-key","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"153ee278-eb74-4958-8680-46d7a0bcf626"},{"name":"/acws/support-at-home/events/entry/v1/:eventId","id":"23b27554-105e-405c-96bf-d0c0dd2495e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","entry","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"ddf0733c-3976-4a0b-a5c3-b51ab4418891","description":{"content":"

Event Identifier

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"5ff7f98b-2ba5-4615-bb08-0f8bfacd5c89","name":"Entry","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1994-07-26\",\n \"entryCategoryCode\": \"HM\",\n \"eventId\": \"12345\",\n \"status\": \"Accepted\",\n \"channel\": \"B2G\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"entryCategoryText\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"departureDate\": \"1949-08-02\",\n \"departureReasonCode\": \"THOSP\",\n \"departureEventId\": \"12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No carer\",\n \"awardOrSettlementTypeCode\": \"TP\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"N\",\n \"awardOrSettlementTypeText\": \"Worker's compensation\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"createdAtDateTime\": \"2007-07-26T08:18:21.180Z\",\n \"updatedAtDateTime\": \"1980-07-30T22:56:08.741Z\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n },\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"dade686d-bfe1-4e37-a0fd-cdb0f667ef88","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"23b27554-105e-405c-96bf-d0c0dd2495e7"},{"name":"/acws/support-at-home/events/entry/v1/:eventId","id":"c0b490a3-00e2-4c0c-a7a6-9aed7548dd2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","entry","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"15496259-1941-4031-a4c7-7706161667f8","description":{"content":"

Event Identifier

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"56e75269-e2f2-4789-a3d0-7d28a9d77be9","name":"No content","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"048f7920-a66e-4775-b000-d0a714af783b","name":"Error","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1993-04-13\",\n \"entryCategoryCode\": \"AS\",\n \"externalReferenceId\": \"External12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No co-resident\",\n \"awardOrSettlementTypeCode\": \"\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"Y\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"c0b490a3-00e2-4c0c-a7a6-9aed7548dd2a"},{"name":"/acws/support-at-home/events/entry/v1/:eventId","id":"ca94379d-9a67-4bcf-a970-ad597b7a3468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","entry","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"7f2a0724-6eb7-4b34-9cc6-19e343b720f1","description":{"content":"

Event Identifier

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"01279533-ed10-42e8-ba94-5ae865357bc2","name":"Deleted entry","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryDate\": \"1994-07-26\",\n \"entryCategoryCode\": \"HM\",\n \"eventId\": \"12345\",\n \"status\": \"Accepted\",\n \"channel\": \"B2G\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"serviceProviderId\": \"12345\",\n \"entryCategoryText\": \"string\",\n \"externalReferenceId\": \"External12345\",\n \"departureDate\": \"1949-08-02\",\n \"departureReasonCode\": \"THOSP\",\n \"departureEventId\": \"12345\",\n \"centrelinkCrn\": \"123456789A\",\n \"dvaUin\": \"WX123456A\",\n \"carerStatus\": \"No carer\",\n \"awardOrSettlementTypeCode\": \"TP\",\n \"unfundedPriorEntryDate\": \"2017-04-13\",\n \"approvalSighted\": \"N\",\n \"awardOrSettlementTypeText\": \"Worker's compensation\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"createdAtDateTime\": \"2007-07-26T08:18:21.180Z\",\n \"updatedAtDateTime\": \"1980-07-30T22:56:08.741Z\",\n \"address\": {\n \"streetLine\": \"20 Test Street\",\n \"suburb\": \"Canberra\",\n \"state\": \"ACT\",\n \"postcode\": \"2600\"\n },\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"a9e20519-aaec-4c7b-8b4f-e931ad02c663","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/entry/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","entry","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ca94379d-9a67-4bcf-a970-ad597b7a3468"},{"name":"/acws/support-at-home/events/departure/v1","id":"3b218f27-1f59-4abd-99d8-7a979c3a6aeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&departureDateTo=1960-01-12&departureDateFrom=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","departure","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The Services Australia Identifier for the service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring residential, home or flexible care.

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"description":{"content":"

Departure date to date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"departureDateTo","value":"1960-01-12"},{"description":{"content":"

Departure date from date. Result will be inclusive of date.

\n","type":"text/plain"},"key":"departureDateFrom","value":"1960-01-12"},{"description":{"content":"

The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=careRecipientid,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"873df7ee-5f9b-4c34-831f-543ee62f7c80","name":"Departure event summary","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&departureDateTo=1960-01-12&departureDateFrom=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring residential, home or flexible care.","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Departure date to date. Result will be inclusive of date.","key":"departureDateTo","value":"1960-01-12"},{"description":"Departure date from date. Result will be inclusive of date.","key":"departureDateFrom","value":"1960-01-12"},{"description":"The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"EL\",\n \"departureDate\": \"2025-02-25\",\n \"departureReasonCode\": \"TORES\",\n \"eventId\": \"12345\",\n \"status\": \"Held\",\n \"channel\": \"B2G\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"externalReferenceId\": \"External12345\",\n \"entryCategoryText\": \"string\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"entryId\": \"string\",\n \"createdAtDateTime\": \"2015-07-29T16:13:58.980Z\",\n \"updatedAtDateTime\": \"1999-01-30T21:25:37.151Z\",\n \"messages\": [\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n },\n {\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"ON\",\n \"departureDate\": \"2024-01-06\",\n \"departureReasonCode\": \"\",\n \"eventId\": \"12345\",\n \"status\": \"Rejected\",\n \"channel\": \"B2G\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"externalReferenceId\": \"External12345\",\n \"entryCategoryText\": \"string\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"entryId\": \"string\",\n \"createdAtDateTime\": \"1956-11-26T13:14:55.775Z\",\n \"updatedAtDateTime\": \"2007-05-24T10:10:28.484Z\",\n \"messages\": [\n {\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n }\n]"},{"id":"761d3aa3-c79c-4bfb-85b4-a956affb6c11","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1?serviceNapsId=strin&serviceProviderId=string&careRecipientId=string&externalReferenceId=string&departureDateTo=1960-01-12&departureDateFrom=1960-01-12&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the service provider","key":"serviceProviderId","value":"string"},{"description":"The identifier of a person who has been assessed to be requiring residential, home or flexible care.","key":"careRecipientId","value":"string"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"Departure date to date. Result will be inclusive of date.","key":"departureDateTo","value":"1960-01-12"},{"description":"Departure date from date. Result will be inclusive of date.","key":"departureDateFrom","value":"1960-01-12"},{"description":"The start of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of entry updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"3b218f27-1f59-4abd-99d8-7a979c3a6aeb"},{"name":"/acws/support-at-home/events/departure/v1","id":"8ac40c84-4451-4889-ab5d-ada468aa7041","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1","description":"

Departure will update the end date and departure reason for the relevant entry

\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","departure","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[]}},"response":[{"id":"5ac39845-326f-42fb-b2a9-47a37b226248","name":"Entry","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"HM\",\n \"departureDate\": \"1949-05-10\",\n \"departureReasonCode\": \"TERMS\",\n \"eventId\": \"12345\",\n \"status\": \"Held\",\n \"channel\": \"B2G\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"externalReferenceId\": \"External12345\",\n \"entryCategoryText\": \"string\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"entryId\": \"string\",\n \"createdAtDateTime\": \"1949-11-30T14:42:58.089Z\",\n \"updatedAtDateTime\": \"1968-03-29T09:07:20.499Z\",\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"a80ad2e9-9b82-4935-a7ff-a03ffdaf74cd","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"8ac40c84-4451-4889-ab5d-ada468aa7041"},{"name":"/acws/support-at-home/events/departure/v1/:eventId","id":"450b91f4-1426-42aa-87c9-f848983ce186","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","departure","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"253bd571-4593-44f9-a768-2f778b4c1369","description":{"content":"

Event Identifier for the departure.

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"0d6a1e61-c3df-4306-a801-a0032ebe6206","name":"Entry","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"HM\",\n \"departureDate\": \"1949-05-10\",\n \"departureReasonCode\": \"TERMS\",\n \"eventId\": \"12345\",\n \"status\": \"Held\",\n \"channel\": \"B2G\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"externalReferenceId\": \"External12345\",\n \"entryCategoryText\": \"string\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"entryId\": \"string\",\n \"createdAtDateTime\": \"1949-11-30T14:42:58.089Z\",\n \"updatedAtDateTime\": \"1968-03-29T09:07:20.499Z\",\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"566fd829-24cb-41d1-9192-2ea09e4f21ce","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"450b91f4-1426-42aa-87c9-f848983ce186"},{"name":"/acws/support-at-home/events/departure/v1/:eventId","id":"053fff84-3f3a-4ee5-98a0-3158cfa8cc37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","departure","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"9f26a7b3-f373-4655-84c2-8f1e4a17f934","description":{"content":"

Event Identifier for the departure.

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"39a7b657-26ff-4258-88c8-53f1cf5f251f","name":"No content","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[{"disabled":false,"description":{"content":"Used to identify specific version of resource. Required to be passed in if-match header for all updates to resource.","type":"text/plain"},"key":"etag","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"9225ca3a-3455-4f3b-b1e3-e23cdab52971","name":"Error","originalRequest":{"method":"PUT","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"AT\",\n \"departureDate\": \"1979-12-12\",\n \"departureReasonCode\": \"CEASE\",\n \"externalReferenceId\": \"External12345\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"053fff84-3f3a-4ee5-98a0-3158cfa8cc37"},{"name":"/acws/support-at-home/events/departure/v1/:eventId","id":"ec829d98-3886-446c-bd8f-ec0ad48f3f7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"x-requested-with","value":"","description":"

CSRF mitigation for AJAX requests

\n"},{"key":"if-match","value":"","description":"

Conditional value required for all update requests. Value should match etag from get request response headers.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","events","departure","v1",":eventId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"9324b48a-be6e-4c35-86d3-114a0433cca1","description":{"content":"

Event Identifier for the departure.

\n","type":"text/plain"},"type":"any","value":"","key":"eventId"}]}},"response":[{"id":"debdfc4b-5c72-4881-9485-2fd18ca9844e","name":"Deleted departure","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"entryCategoryCode\": \"HM\",\n \"departureDate\": \"1949-05-10\",\n \"departureReasonCode\": \"TERMS\",\n \"eventId\": \"12345\",\n \"status\": \"Held\",\n \"channel\": \"B2G\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"externalReferenceId\": \"External12345\",\n \"entryCategoryText\": \"string\",\n \"departureReasonText\": \"Care recipient moved out of service area\",\n \"entryId\": \"string\",\n \"createdAtDateTime\": \"1949-11-30T14:42:58.089Z\",\n \"updatedAtDateTime\": \"1968-03-29T09:07:20.499Z\",\n \"messages\": [\n {\n \"type\": \"W\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n },\n {\n \"type\": \"I\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n }\n ]\n}"},{"id":"eae7042f-2c81-4865-82a3-6c2d6d6c14c1","name":"Error","originalRequest":{"method":"DELETE","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"CSRF mitigation for AJAX requests","key":"x-requested-with","value":""},{"description":"Conditional value required for all update requests. Value should match etag from get request response headers.","key":"if-match","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/events/departure/v1/:eventId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","events","departure","v1",":eventId"],"variable":[{"key":"eventId","value":"","description":"Event Identifier for the departure."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ec829d98-3886-446c-bd8f-ec0ad48f3f7a"}],"id":"32dc1fc6-7f4a-4af9-8bfe-97b3f934a162","description":"

Details the relevant information around Support at Home entry and departure

\n

Provides the ability to support Home Care entries and departures.

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • added updatedAtDateTime as query parameters for Query entry GET call
    • \n
  • operationId has been updated
    • \n
  • add departureDate into sort-fields
    • \n
  • added search and read departure calls
    • \n
  • added departureEventId to EntryDetails response entity
    • \n
  • added default date for departureDateTo
    • \n
  • added DepartureDetails for response entity for POST, DELETE and GET departure event
    • \n
  • sort-fields has been updated on query entry call
    • \n
  • optInSupportAtHomeRates has been updated
    • \n
  • new departure reason code FNDEX has been added
    • \n
  • entryCategory has been expanded into entryCategoryCode and entryCategoryText
    • \n
  • entryCategoryCode enumerations value AS has been added
    • \n
  • careLevel has been removed
    • \n
  • optInSupportAtHomeRates has been removed
    • \n
\n
","_postman_id":"32dc1fc6-7f4a-4af9-8bfe-97b3f934a162","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"budgets-1.1.0","item":[{"name":"/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId/summary","id":"4b3145a8-da6a-49e9-bf6c-e49c7ff50715","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId/summary?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId","summary"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The start of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateFrom","value":"current date - 3 months"},{"description":{"content":"

The end of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateTo","value":"current date"},{"description":{"content":"

The start of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[{"id":"f00bc98a-c27b-45a2-99dd-4c3a271af86a","description":{"content":"

The Services Australia Identifier for the Service provider

\n","type":"text/plain"},"type":"any","value":"string","key":"serviceProviderId"}]}},"response":[{"id":"38c75c4e-24f7-4745-a4db-792e80b138a5","name":"Budget Summary
\nFollowing fields will be populated for Care Recipient budgets:\n * careRecipientId\n * careRecipientName\n * entryDate\nFollowing fields will be populated for Service Provider budgets:\n * serviceProviderId \nAll other fields will be","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId/summary?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId","summary"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The start of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Open\",\n \"createdAtDateTime\": \"1959-05-29T13:26:45.568Z\",\n \"updatedAtDateTime\": \"1977-01-09T08:07:19.135Z\"\n },\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Closed\",\n \"createdAtDateTime\": \"2012-02-01T03:57:27.644Z\",\n \"updatedAtDateTime\": \"1999-05-20T08:57:04.994Z\"\n }\n]"},{"id":"51ade18e-2a8a-4c0e-8941-de2247f20bbe","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId/summary?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId","summary"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The start of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of budget summary updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"4b3145a8-da6a-49e9-bf6c-e49c7ff50715"},{"name":"/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId","id":"d2977175-26b7-478e-b021-7cc00a094471","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The start of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateFrom","value":"current date - 3 months"},{"description":{"content":"

The end of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateTo","value":"current date"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[{"id":"8ccd26dc-a409-4bd0-a5d1-4d80752323d3","description":{"content":"

The Services Australia Identifier for the Service provider

\n","type":"text/plain"},"type":"any","value":"string","key":"serviceProviderId"}]}},"response":[{"id":"3500726a-27ed-4a1c-bbbf-de665794d8cb","name":"Budget Summary
\nFollowing fields will be populated for Care Recipient budgets:\n * careRecipientId\n * careRecipientName\n * entryDate\nFollowing fields will be populated for Service Provider budgets:\n * serviceProviderId \nAll other fields will be","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Open\",\n \"createdAtDateTime\": \"1959-05-29T13:26:45.568Z\",\n \"updatedAtDateTime\": \"1977-01-09T08:07:19.135Z\"\n },\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Closed\",\n \"createdAtDateTime\": \"2012-02-01T03:57:27.644Z\",\n \"updatedAtDateTime\": \"1999-05-20T08:57:04.994Z\"\n }\n]"},{"id":"77ae5953-2a27-4105-9e43-93172de66f59","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/serviceProvider/:serviceProviderId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","serviceProvider",":serviceProviderId"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"serviceProviderId","value":"string","description":"The Services Australia Identifier for the Service provider"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"d2977175-26b7-478e-b021-7cc00a094471"},{"name":"/acws/support-at-home/budgets/v1/careRecipient/:careRecipientId","id":"11f016b0-bb68-4c1c-aacc-482fa0d1b9f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/careRecipient/:careRecipientId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budgets","v1","careRecipient",":careRecipientId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The start of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateFrom","value":"current date - 3 months"},{"description":{"content":"

The end of range query for the budget effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateTo","value":"current date"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[{"id":"931378b6-d6ef-4b67-82ba-797d18295764","description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"type":"any","value":"string","key":"careRecipientId"}]}},"response":[{"id":"3bdfecf2-8d44-42f6-b75a-a2cda15cfb51","name":"Care recipient Budgets
\nFollowing fields will be populated for Care Recipient budgets:\n * careRecipientId\n * careRecipientName\n * entryDate\nFollowing fields will be populated for Service Provider budgets:\n * serviceProviderId \nAll other fields","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/careRecipient/:careRecipientId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","careRecipient",":careRecipientId"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime ","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"careRecipientId","value":"string","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Open\",\n \"createdAtDateTime\": \"1959-05-29T13:26:45.568Z\",\n \"updatedAtDateTime\": \"1977-01-09T08:07:19.135Z\"\n },\n {\n \"budgetId\": \"12345\",\n \"serviceProviderId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home Support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 2200,\n \"available\": 1500,\n \"used\": 500,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Closed\",\n \"createdAtDateTime\": \"2012-02-01T03:57:27.644Z\",\n \"updatedAtDateTime\": \"1999-05-20T08:57:04.994Z\"\n }\n]"},{"id":"e262b45d-92c6-406c-876f-dd8f8f6bcce3","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/careRecipient/:careRecipientId?effectiveDateFrom=current date - 3 months&effectiveDateTo=current date&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1","careRecipient",":careRecipientId"],"query":[{"description":"The start of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current date - 3 months"},{"description":"The end of range query for the budget effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current date"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=createdAtDateTime,updatedAtDateTime ","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}],"variable":[{"key":"careRecipientId","value":"string","description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home "}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"11f016b0-bb68-4c1c-aacc-482fa0d1b9f2"},{"name":"/acws/support-at-home/budgets/v1/:budgetId","id":"06c08ebb-b98c-40b5-95fc-d4ccfe0a8faf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budgets","v1",":budgetId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"0b58a4ba-b3c4-43e6-b547-283e99d0ebef","description":{"content":"

The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis

\n","type":"text/plain"},"type":"any","value":"string","key":"budgetId"}]}},"response":[{"id":"5f70f5e9-ffce-438d-98e4-77559ee59bd0","name":"Budget details
\nFollowing fields will be populated for Care Recipient budgets:\n * careRecipientId\n * careRecipientName\n * entryDate\nFollowing fields will be populated for Service Provider budgets:\n * serviceProviderId \nAll other fields will be","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1",":budgetId"],"variable":[{"key":"budgetId","value":"string","description":"The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"budgetId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientName\": \"Test Care Recipient\",\n \"entryDate\": \"2024-03-01\",\n \"budgetTypeCode\": \"ON\",\n \"budgetType\": \"Home support ongoing\",\n \"startDate\": \"2024-04-01\",\n \"endDate\": \"2024-06-30\",\n \"total\": 1200,\n \"available\": 900,\n \"used\": 100,\n \"writeOff\": 200,\n \"rolloverDeduction\": 200,\n \"status\": \"Open\",\n \"createdAtDateTime\": \"1999-01-23T05:23:25.132Z\",\n \"updatedAtDateTime\": \"1958-06-10T08:18:51.988Z\",\n \"entitlementItems\": [\n {\n \"itemCode\": \"SAH_7\",\n \"description\": \"Support at Home Class 7\",\n \"amount\": 1000,\n \"startDate\": \"1963-09-20\",\n \"endDate\": \"1954-01-17\",\n \"careRecipientId\": \"string\",\n \"createdAtDateTime\": \"2021-03-15T03:41:15.949Z\"\n },\n {\n \"itemCode\": \"SAH_7\",\n \"description\": \"Support at Home Class 7\",\n \"amount\": 1000,\n \"startDate\": \"2008-09-23\",\n \"endDate\": \"2015-08-14\",\n \"careRecipientId\": \"string\",\n \"createdAtDateTime\": \"2010-11-11T22:33:23.518Z\"\n }\n ],\n \"usage\": [\n {\n \"serviceProviderId\": \"12345\",\n \"itemCode\": \"SERV-0001\",\n \"itemDescription\": \"Gardening\",\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"amount\": 100,\n \"deliveryDate\": \"1948-08-13\",\n \"careRecipientId\": \"string\",\n \"updatedAtDateTime\": \"1977-03-14T17:15:32.732Z\"\n },\n {\n \"serviceProviderId\": \"12345\",\n \"itemCode\": \"SERV-0001\",\n \"itemDescription\": \"Gardening\",\n \"invoiceId\": \"12345\",\n \"itemId\": \"12345\",\n \"amount\": 100,\n \"deliveryDate\": \"2017-07-31\",\n \"careRecipientId\": \"string\",\n \"updatedAtDateTime\": \"2009-08-15T02:41:54.707Z\"\n }\n ]\n}"},{"id":"cb2ea44c-0bd0-4d5d-891c-d60a9ffc63e7","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1",":budgetId"],"variable":[{"key":"budgetId","value":"string","description":"The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"06c08ebb-b98c-40b5-95fc-d4ccfe0a8faf"},{"name":"/acws/support-at-home/budgets/v1/:budgetId/rollover","id":"f4e2f494-ee67-4773-8f3b-b40b4b5a9f94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId/rollover","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","budgets","v1",":budgetId","rollover"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"d9086d05-9033-49ad-b970-5460e1df384a","description":{"content":"

The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis

\n","type":"text/plain"},"type":"any","value":"string","key":"budgetId"}]}},"response":[{"id":"976c48b2-f931-47a8-8fa9-69fd026bd44a","name":"Budget Rollover","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId/rollover","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1",":budgetId","rollover"],"variable":[{"key":"budgetId","value":"string","description":"The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"E\",\n \"shortText\": \"string\",\n \"longText\": \"string\"\n}"},{"id":"0d315476-5856-447e-9636-534c3f038afd","name":"Error","originalRequest":{"method":"POST","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/budgets/v1/:budgetId/rollover","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","budgets","v1",":budgetId","rollover"],"variable":[{"key":"budgetId","value":"string","description":"The Services Australia unique identifier for the budget instance.\nCan be found via budget summary apis"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"f4e2f494-ee67-4773-8f3b-b40b4b5a9f94"}],"id":"a44b3c7f-cc7e-477d-b38b-77b36fa1913b","description":"

Relates to the Support at Home Budgets

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • examples have been added and updated
    • \n
  • added updatedAtDateTime as query parameters for service provider budget summary GET call
    • \n
  • operationId has been updated
    • \n
  • call tags have been updated
    • \n
  • effectiveDateFrom and effectiveDateTo have been added as query parameters to Budget Summary, Service Provider and Care Recipient budget get calls
    • \n
  • Budget details path parameters has been updated
    • \n
  • budgetType enumerations been updated
    • \n
  • added createdAtDateTime to entitlementItems entity
    • \n
  • added updatedAtDateTime to usage entity
    • \n
  • path parameter for Budget details has been updated
    • \n
  • status has been added
    • \n
  • itemCode, startDate and endDate has been added to entitlementItems
    • \n
  • deliveryDate has been added to usage entity
    • \n
  • added budgetTypeCode
    • \n
\n
1.1.0\n
    \n
  • added entryDate, createdAtDateTime and updatedAtDateTime to BudgetDetails to align with what is currently being returned.
    • \n
  • added writeOff and rolloverDeduction to budget summary and budget details
    • \n
  • added ability to rollover the budget
    • \n
  • amended descriptions to clarify what fields will be returned when it is either a Care Recipient or Service Provider budget
    • \n
\n
","_postman_id":"a44b3c7f-cc7e-477d-b38b-77b36fa1913b","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"service-search-2.0.2","item":[{"name":"/acws/services/v2","id":"0050c27f-c96a-42b3-b83d-5d64ace85d8b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/services/v2?serviceNapsId=strin&serviceId=string&providerId=string&serviceName=string&limit=10&page=1&sort-fields=serviceName&sort=asc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","services","v2"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The Services Australia Identifier for the Service

\n","type":"text/plain"},"key":"serviceId","value":"string"},{"description":{"content":"

The Services Australia Identifier for the registered provider

\n","type":"text/plain"},"key":"providerId","value":"string"},{"description":{"content":"

The name of the service. Query is case insensitive and will match the start of a Service's name

\n","type":"text/plain"},"key":"serviceName","value":"string"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=serviceName,serviceId

\n","type":"text/plain"},"key":"sort-fields","value":"serviceName"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"eb1cae22-3025-42c9-bd5d-562261fe4222","name":"Service search response","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/services/v2?serviceNapsId=strin&serviceId=string&providerId=string&serviceName=string&limit=10&page=1&sort-fields=serviceName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","services","v2"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the Service","key":"serviceId","value":"string"},{"description":"The Services Australia Identifier for the registered provider","key":"providerId","value":"string"},{"description":"The name of the service. Query is case insensitive and will match the start of a Service's name","key":"serviceName","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=serviceName,serviceId","key":"sort-fields","value":"serviceName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"providerId\": \"12345\",\n \"serviceName\": \"Test Service\",\n \"careTypeCode\": \"RESI\",\n \"operationalStatus\": \"Operational\"\n },\n {\n \"serviceId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"providerId\": \"12345\",\n \"serviceName\": \"Test Service\",\n \"careTypeCode\": \"RESI\",\n \"operationalStatus\": \"Operational\"\n }\n]"},{"id":"34cc113d-2922-4cc7-81a0-37377f839897","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/services/v2?serviceNapsId=strin&serviceId=string&providerId=string&serviceName=string&limit=10&page=1&sort-fields=serviceName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","services","v2"],"query":[{"description":"The National Approved Provider System (NAPS) Identifier for the service","key":"serviceNapsId","value":"strin"},{"description":"The Services Australia Identifier for the Service","key":"serviceId","value":"string"},{"description":"The Services Australia Identifier for the registered provider","key":"providerId","value":"string"},{"description":"The name of the service. Query is case insensitive and will match the start of a Service's name","key":"serviceName","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=serviceName,serviceId","key":"sort-fields","value":"serviceName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"0050c27f-c96a-42b3-b83d-5d64ace85d8b"}],"id":"ae9ed447-1c71-4e3a-a1cd-12f5bacef18a","description":"

Provides the ability to search for an Aged Care Service.\nChanges

API Version Changes
2.0.0 New major version
2.0.1
  • sort-fields and sort have been added to the search services query.
  • Error entity has been updated
2.0.2
  • addition of enumeration for Support at Home
  • updated Id to Identifier
  • updated providerId to registered provider in titles and descriptions
  • updated Id in descriptions and titles to Identifier
  • added examples
  • operationId has been updated

\n","_postman_id":"ae9ed447-1c71-4e3a-a1cd-12f5bacef18a","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"provider-summary-2.0.2","item":[{"name":"/acws/providers/v2/:providerId","id":"cc99c27f-1864-4ed7-af19-ac4568121ef5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2/:providerId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","providers","v2",":providerId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"b941083c-5a09-4e3e-a494-03e78988645d","description":{"content":"

Registered Provider Identifier

\n","type":"text/plain"},"type":"any","value":"","key":"providerId"}]}},"response":[{"id":"37a5ebc3-3dcc-40b3-8dc6-fac1f58b7b9e","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2/:providerId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","providers","v2",":providerId"],"variable":[{"key":"providerId","value":"","description":"Registered Provider Identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"providerId\": \"string\",\n \"providerNapsId\": \"strin\",\n \"providerName\": \"string\",\n \"addresses\": [\n {\n \"type\": \"Postal\",\n \"streetLine1\": \"string\",\n \"streetLine2\": \"string\",\n \"city\": \"string\",\n \"state\": \"str\",\n \"postcode\": \"stri\",\n \"country\": \"string\",\n \"validFrom\": \"1989-03-23\",\n \"validTo\": \"1961-01-01\"\n },\n {\n \"type\": \"Postal\",\n \"streetLine1\": \"string\",\n \"streetLine2\": \"string\",\n \"city\": \"string\",\n \"state\": \"str\",\n \"postcode\": \"stri\",\n \"country\": \"string\",\n \"validFrom\": \"1973-05-12\",\n \"validTo\": \"1973-03-08\"\n }\n ],\n \"contacts\": [\n {\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\",\n \"validFrom\": \"1962-06-06\",\n \"validTo\": \"2024-09-29\"\n },\n {\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"phoneNumber\": \"string\",\n \"email\": \"string\",\n \"validFrom\": \"1999-10-09\",\n \"validTo\": \"1949-10-10\"\n }\n ],\n \"services\": [\n {\n \"serviceId\": \"string\",\n \"serviceNapsId\": \"strin\",\n \"providerId\": \"string\",\n \"serviceName\": \"string\",\n \"careTypeCode\": \"STRC\",\n \"operationalStatus\": \"string\"\n },\n {\n \"serviceId\": \"string\",\n \"serviceNapsId\": \"strin\",\n \"providerId\": \"string\",\n \"serviceName\": \"string\",\n \"careTypeCode\": \"HOME\",\n \"operationalStatus\": \"string\"\n }\n ]\n}"},{"id":"21cede20-1b1c-4e21-8ffd-b3cb63b79d5f","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2/:providerId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","providers","v2",":providerId"],"variable":[{"key":"providerId","value":"","description":"Registered Provider Identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"cc99c27f-1864-4ed7-af19-ac4568121ef5"}],"id":"fe291638-b28c-460f-bcf3-aaa0e11f71c9","description":"

Provides the ability to obtain summary information for a Aged Care Provider and associated services.

Version changes between 2.0.0 and 2.0.1

  • Error entity has been updated

Version changes between 2.0.1 and 2.0.2

  • addition of Support at Home enumeration for careTypeCode under service
  • updated Id to Identifier
  • updated provider to registered provider in titles and descriptions
  • operationId has been updated

\n","_postman_id":"fe291638-b28c-460f-bcf3-aaa0e11f71c9","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"provider-search-2.0.1","item":[{"name":"/acws/providers/v2","id":"ed34bae0-ff84-41af-bb1e-784874c961ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2?providerNapsId=strin&providerId=string&providerRacsId=stri&providerName=string&limit=10&page=1&sort-fields=providerName&sort=asc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","providers","v2"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The National Approved Provider System (NAPS) Id for the provider

\n","type":"text/plain"},"key":"providerNapsId","value":"strin"},{"description":{"content":"

The Services Australia Id for the provider

\n","type":"text/plain"},"key":"providerId","value":"string"},{"description":{"content":"

The Legacy Residential Aged Care System identifier

\n","type":"text/plain"},"key":"providerRacsId","value":"stri"},{"description":{"content":"

The name of the provider

\n","type":"text/plain"},"key":"providerName","value":"string"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=providerName,providerId

\n","type":"text/plain"},"key":"sort-fields","value":"providerName"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"6fe363c8-2618-4720-86ae-bcdb4b97a547","name":"Providers","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2?providerNapsId=strin&providerId=string&providerRacsId=stri&providerName=string&limit=10&page=1&sort-fields=providerName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","providers","v2"],"query":[{"description":"The National Approved Provider System (NAPS) Id for the provider","key":"providerNapsId","value":"strin"},{"description":"The Services Australia Id for the provider","key":"providerId","value":"string"},{"description":"The Legacy Residential Aged Care System identifier","key":"providerRacsId","value":"stri"},{"description":"The name of the provider","key":"providerName","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=providerName,providerId","key":"sort-fields","value":"providerName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"providerId\": \"string\",\n \"providerNapsId\": \"strin\",\n \"providerRacsId\": \"stri\",\n \"providerName\": \"string\"\n },\n {\n \"providerId\": \"string\",\n \"providerNapsId\": \"strin\",\n \"providerRacsId\": \"stri\",\n \"providerName\": \"string\"\n }\n]"},{"id":"3a388fa6-84d2-47a4-9b29-6723a6e190ae","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/providers/v2?providerNapsId=strin&providerId=string&providerRacsId=stri&providerName=string&limit=10&page=1&sort-fields=providerName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","providers","v2"],"query":[{"description":"The National Approved Provider System (NAPS) Id for the provider","key":"providerNapsId","value":"strin"},{"description":"The Services Australia Id for the provider","key":"providerId","value":"string"},{"description":"The Legacy Residential Aged Care System identifier","key":"providerRacsId","value":"stri"},{"description":"The name of the provider","key":"providerName","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma seperated ie sort-fields=providerName,providerId","key":"sort-fields","value":"providerName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"ed34bae0-ff84-41af-bb1e-784874c961ff"}],"id":"a9a626de-a111-414c-894c-2361dade7585","description":"

Provides the ability to search for an Aged Care Provider.

Version changes between 2.0.0 and 2.0.1

  • sort-fields and sort have been added to the search providers query.
  • Description for providerName has been updated
  • Error entity has been updated

\n","_postman_id":"a9a626de-a111-414c-894c-2361dade7585","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"event-search-2.0.2","item":[{"name":"/acws/events/v2","id":"1e75e012-c715-452b-b790-e17c6471dcad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/events/v2?serviceId=strin&serviceNapsId=strin&careRecipientId=string&careTypeCode=SAH&status=E_C&eventTypeCode=MNTH_INV&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtFrom=2004-10-11T02:49:29.486Z&updatedAtTo=2004-10-11T02:49:29.486Z&createdAtFrom=2004-10-11T02:49:29.486Z&createdAtTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","events","v2"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The Services Australia Unique Identifier for the service

\n","type":"text/plain"},"key":"serviceId","value":"strin"},{"description":{"content":"

The National Approved Provider System (NAPS) Identifier for the service

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential Care, Transition Care or Support at Home.

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

Care type the event is related to

\n
    \n
  • RESI - Residential Care
    • \n
  • HOME - Home care
    • \n
  • TRANS - Transition Care
    • \n
  • STRC - Short Term Restorative Care
    • \n
  • SAH - Support at Home
    • \n
\n","type":"text/plain"},"key":"careTypeCode","value":"SAH"},{"description":{"content":"

The status of the event version

\n
    \n

  • HLD - Held. Event version is awaiting manual action. For example: pending approval.

    \n
    • \n

  • REJ - Rejected. Event version has been rejected

    \n
    • \n

  • DEL - Deleted. Event version has been deleted

    \n
    • \n

  • ACC - Accepted. Event version has been accepted and will be included for payment

    \n
    • \n

  • Home Care, Transition Care and Short Term Restorative Care status's

    \n
    • \n

  • BP - Being processed

    \n
    • \n

  • HOLD - Held

    \n
    • \n

  • ERR - Error

    \n
    • \n

  • REJ - Rejected

    \n
    • \n

  • PROCD - Processed

    \n
    • \n

  • E_CLM - Event claimed

    \n
    • \n

  • APP_D - Delegate approval required

    \n
    • \n

  • DEL - Deleted

    \n
    • \n

  • DEL_D - Delegate approval for deletion

    \n
    • \n

  • RETRO - Retro event created

    \n
    • \n

  • REJ_D - Rejected by delegate

    \n
    • \n

  • DUP - Duplicate

    \n
    • \n

  • SUP - Superseded

    \n
    • \n

  • OPEN - Open

    \n
    • \n

  • LOC_I - Invalid location

    \n
    • \n
\n","type":"text/plain"},"key":"status","value":"E_C"},{"description":{"content":"

Specific payment related information sent from an Aged Care Service to Services Australia of an occurrence to a care recipient.

\n
    \n
  • PERM_ENTRY - Permanent Entry ( Residential Care )
    • \n
  • RESP_ENTRY - Respite Entry ( Residential Care )
    • \n
  • DEPARTURE - Departure ( All care types )
    • \n
  • LEAVE - Leave ( Residential Care, Home Care, and Short Term Restorative Care )
    • \n
  • EXTRA_SRV - Extra Service ( Residential Care )
    • \n
  • OXYGEN - Oxygen ( Residential Care, Home care and Support at Home )
    • \n
  • ENTERAL_F - Enteral Feeding ( Residential Care, Home care and Support at Home )
    • \n
  • ENTRY - Entry ( Home Care, Transition Care, Short Term Restorative Care)
    • \n
  • MNTH_INV - Invoice amount ( Home care )
    • \n
  • UNSPENT - Commonwealth unspent amount on departure ( Home care )
    • \n
  • CWUA_OPTIN - Reported commonwealth unspent amount ( Home care )
    • \n
  • LOCATION - Viability ( Home care )
    • \n
  • CARE_SET - Care setting days ( Home care )
    • \n
  • SaH ongoing - Support at Home Ongoing
    • \n
  • Restorative - Support at Home Restorative Care Pathway
    • \n
  • End of Life - Support at Home End-of-life Pathway
    • \n
  • Assistive Technology - Support at Home Assistive-Technology
    • \n
  • Home Modifications - Support at Home Home-modifications
    • \n
  • SaH Transitioned HCP - care recipient was entered under the Home Care Packages \nor Short Term Restorative Care programs prior to 1 July 2025 and have transitioned into Support at Home program from 1 July 2025
    • \n
\n","type":"text/plain"},"key":"eventTypeCode","value":"MNTH_INV"},{"description":{"content":"

This field can be used by Software Vendors as an external identifier to distinguish the events within their software.

\n","type":"text/plain"},"key":"externalReferenceId","value":"string"},{"description":{"content":"

The start of range query of event start date field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"startDateFrom","value":"1960-01-12"},{"description":{"content":"

The end of range query of event start date field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"startDateTo","value":"1960-01-12"},{"description":{"content":"

The start of range query of event end date field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"endDateFrom","value":"1960-01-12"},{"description":{"content":"

The end of range query of event end date field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"endDateTo","value":"1960-01-12"},{"description":{"content":"

The start of range query of event updatedAt date time field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"updatedAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of event updatedAt date time field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"updatedAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The start of range query of event createdAt date time field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"createdAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of event createdAt date time field. Response will be inclusive of date provided.

\n","type":"text/plain"},"key":"createdAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided. * asc - ascending order * desc - descending order

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"1b138caf-c042-4205-9de7-07c9af4099d8","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/events/v2?serviceId=strin&serviceNapsId=strin&careRecipientId=string&careTypeCode=SAH&status=E_C&eventTypeCode=MNTH_INV&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtFrom=2004-10-11T02:49:29.486Z&updatedAtTo=2004-10-11T02:49:29.486Z&createdAtFrom=2004-10-11T02:49:29.486Z&createdAtTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","events","v2"],"query":[{"description":"The Services Australia Unique Identifier for the service","key":"serviceId","value":"strin"},{"description":"The National Approved Provider System (NAPS) Identifier for the service","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential Care, Transition Care or Support at Home.","key":"careRecipientId","value":"string"},{"description":"Care type the event is related to
\n * RESI - Residential Care\n * HOME - Home care\n * TRANS - Transition Care\n * STRC - Short Term Restorative Care\n * SAH - Support at Home","key":"careTypeCode","value":"SAH"},{"description":"The status of the event version
\n * HLD - Held. Event version is awaiting manual action. For example: pending approval.
\n * REJ - Rejected. Event version has been rejected
\n * DEL - Deleted. Event version has been deleted
\n * ACC - Accepted. Event version has been accepted and will be included for payment
\n\n * Home Care, Transition Care and Short Term Restorative Care status's \n * BP - Being processed\n * HOLD - Held\n * ERR - Error\n * REJ - Rejected\n * PROCD - Processed\n * E_CLM - Event claimed\n * APP_D - Delegate approval required\n * DEL - Deleted\n * DEL_D - Delegate approval for deletion\n * RETRO - Retro event created\n * REJ_D - Rejected by delegate\n * DUP - Duplicate\n * SUP - Superseded\n * OPEN - Open\n * LOC_I - Invalid location","key":"status","value":"E_C"},{"description":"Specific payment related information sent from an Aged Care Service to Services Australia of an occurrence to a care recipient.
\n * PERM_ENTRY - Permanent Entry ( Residential Care )\n * RESP_ENTRY - Respite Entry ( Residential Care )\n * DEPARTURE - Departure ( All care types )\n * LEAVE - Leave ( Residential Care, Home Care, and Short Term Restorative Care )\n * EXTRA_SRV - Extra Service ( Residential Care )\n * OXYGEN - Oxygen ( Residential Care, Home care and Support at Home )\n * ENTERAL_F - Enteral Feeding ( Residential Care, Home care and Support at Home )\n * ENTRY - Entry ( Home Care, Transition Care, Short Term Restorative Care)\n * MNTH_INV - Invoice amount ( Home care )\n * UNSPENT - Commonwealth unspent amount on departure ( Home care )\n * CWUA_OPTIN - Reported commonwealth unspent amount ( Home care )\n * LOCATION - Viability ( Home care )\n * CARE_SET - Care setting days ( Home care )\n * SaH ongoing - Support at Home Ongoing\n * Restorative - Support at Home Restorative Care Pathway\n * End of Life - Support at Home End-of-life Pathway\n * Assistive Technology - Support at Home Assistive-Technology\n * Home Modifications - Support at Home Home-modifications\n * SaH Transitioned HCP - care recipient was entered under the Home Care Packages \n or Short Term Restorative Care programs prior to 1 July 2025 and have transitioned into Support at Home program from 1 July 2025","key":"eventTypeCode","value":"MNTH_INV"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"The start of range query of event start date field. Response will be inclusive of date provided.","key":"startDateFrom","value":"1960-01-12"},{"description":"The end of range query of event start date field. Response will be inclusive of date provided.","key":"startDateTo","value":"1960-01-12"},{"description":"The start of range query of event end date field. Response will be inclusive of date provided.","key":"endDateFrom","value":"1960-01-12"},{"description":"The end of range query of event end date field. Response will be inclusive of date provided.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of event updatedAt date time field. Response will be inclusive of date provided.","key":"updatedAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of event updatedAt date time field. Response will be inclusive of date provided.","key":"updatedAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The start of range query of event createdAt date time field. Response will be inclusive of date provided.","key":"createdAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of event createdAt date time field. Response will be inclusive of date provided.","key":"createdAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided. * asc - ascending order * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"eventId\": \"12345\",\n \"versionNumber\": \"000010\",\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"Residential Care\",\n \"channel\": \"B2G\",\n \"eventTypeCode\": \"PERM_ENTRY\",\n \"eventTypeText\": \"Permanent Entry\",\n \"statusCode\": \"ACC\",\n \"statusText\": \"Accepted\",\n \"externalReferenceId\": \"Ext Number 1234\",\n \"serviceNapsId\": \"12345\",\n \"serviceId\": \"12345\",\n \"serviceName\": \"string\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"startDate\": \"2024-09-23\",\n \"endDate\": \"2024-10-23\",\n \"entryId\": \"12345\",\n \"createdAtDateTime\": \"1957-04-28T11:04:30.771Z\",\n \"updatedAtDateTime\": \"2012-12-22T00:47:58.087Z\"\n },\n {\n \"eventId\": \"12345\",\n \"versionNumber\": \"000010\",\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"Residential Care\",\n \"channel\": \"B2G\",\n \"eventTypeCode\": \"PERM_ENTRY\",\n \"eventTypeText\": \"Permanent Entry\",\n \"statusCode\": \"ACC\",\n \"statusText\": \"Accepted\",\n \"externalReferenceId\": \"Ext Number 1234\",\n \"serviceNapsId\": \"12345\",\n \"serviceId\": \"12345\",\n \"serviceName\": \"string\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"startDate\": \"2024-09-23\",\n \"endDate\": \"2024-10-23\",\n \"entryId\": \"12345\",\n \"createdAtDateTime\": \"1997-11-07T07:51:30.080Z\",\n \"updatedAtDateTime\": \"1966-03-23T00:13:40.185Z\"\n }\n]"},{"id":"6d9c9fa8-ab14-468f-af4f-bdad23972035","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/events/v2?serviceId=strin&serviceNapsId=strin&careRecipientId=string&careTypeCode=SAH&status=E_C&eventTypeCode=MNTH_INV&externalReferenceId=string&startDateFrom=1960-01-12&startDateTo=1960-01-12&endDateFrom=1960-01-12&endDateTo=1960-01-12&updatedAtFrom=2004-10-11T02:49:29.486Z&updatedAtTo=2004-10-11T02:49:29.486Z&createdAtFrom=2004-10-11T02:49:29.486Z&createdAtTo=2004-10-11T02:49:29.486Z&limit=10&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","events","v2"],"query":[{"description":"The Services Australia Unique Identifier for the service","key":"serviceId","value":"strin"},{"description":"The National Approved Provider System (NAPS) Identifier for the service","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential Care, Transition Care or Support at Home.","key":"careRecipientId","value":"string"},{"description":"Care type the event is related to
\n * RESI - Residential Care\n * HOME - Home care\n * TRANS - Transition Care\n * STRC - Short Term Restorative Care\n * SAH - Support at Home","key":"careTypeCode","value":"SAH"},{"description":"The status of the event version
\n * HLD - Held. Event version is awaiting manual action. For example: pending approval.
\n * REJ - Rejected. Event version has been rejected
\n * DEL - Deleted. Event version has been deleted
\n * ACC - Accepted. Event version has been accepted and will be included for payment
\n\n * Home Care, Transition Care and Short Term Restorative Care status's \n * BP - Being processed\n * HOLD - Held\n * ERR - Error\n * REJ - Rejected\n * PROCD - Processed\n * E_CLM - Event claimed\n * APP_D - Delegate approval required\n * DEL - Deleted\n * DEL_D - Delegate approval for deletion\n * RETRO - Retro event created\n * REJ_D - Rejected by delegate\n * DUP - Duplicate\n * SUP - Superseded\n * OPEN - Open\n * LOC_I - Invalid location","key":"status","value":"E_C"},{"description":"Specific payment related information sent from an Aged Care Service to Services Australia of an occurrence to a care recipient.
\n * PERM_ENTRY - Permanent Entry ( Residential Care )\n * RESP_ENTRY - Respite Entry ( Residential Care )\n * DEPARTURE - Departure ( All care types )\n * LEAVE - Leave ( Residential Care, Home Care, and Short Term Restorative Care )\n * EXTRA_SRV - Extra Service ( Residential Care )\n * OXYGEN - Oxygen ( Residential Care, Home care and Support at Home )\n * ENTERAL_F - Enteral Feeding ( Residential Care, Home care and Support at Home )\n * ENTRY - Entry ( Home Care, Transition Care, Short Term Restorative Care)\n * MNTH_INV - Invoice amount ( Home care )\n * UNSPENT - Commonwealth unspent amount on departure ( Home care )\n * CWUA_OPTIN - Reported commonwealth unspent amount ( Home care )\n * LOCATION - Viability ( Home care )\n * CARE_SET - Care setting days ( Home care )\n * SaH ongoing - Support at Home Ongoing\n * Restorative - Support at Home Restorative Care Pathway\n * End of Life - Support at Home End-of-life Pathway\n * Assistive Technology - Support at Home Assistive-Technology\n * Home Modifications - Support at Home Home-modifications\n * SaH Transitioned HCP - care recipient was entered under the Home Care Packages \n or Short Term Restorative Care programs prior to 1 July 2025 and have transitioned into Support at Home program from 1 July 2025","key":"eventTypeCode","value":"MNTH_INV"},{"description":"This field can be used by Software Vendors as an external identifier to distinguish the events within their software.","key":"externalReferenceId","value":"string"},{"description":"The start of range query of event start date field. Response will be inclusive of date provided.","key":"startDateFrom","value":"1960-01-12"},{"description":"The end of range query of event start date field. Response will be inclusive of date provided.","key":"startDateTo","value":"1960-01-12"},{"description":"The start of range query of event end date field. Response will be inclusive of date provided.","key":"endDateFrom","value":"1960-01-12"},{"description":"The end of range query of event end date field. Response will be inclusive of date provided.","key":"endDateTo","value":"1960-01-12"},{"description":"The start of range query of event updatedAt date time field. Response will be inclusive of date provided.","key":"updatedAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of event updatedAt date time field. Response will be inclusive of date provided.","key":"updatedAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The start of range query of event createdAt date time field. Response will be inclusive of date provided.","key":"createdAtFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of event createdAt date time field. Response will be inclusive of date provided.","key":"createdAtTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"10"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=careRecipientid,updatedAtDateTime","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided. * asc - ascending order * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"1e75e012-c715-452b-b790-e17c6471dcad"}],"id":"68eaa234-0b10-4535-804e-51457ea42ca8","description":"

Provides the ability to search for events. Changes

API Version Changes
2.0.0 New major version
2.0.1
  • sort-fields and sort have been added to the get departure events query.
  • createdAt has been changed to createdAtDateTime
  • updatedAt has been changed to updatedAtDateTime
  • Error entity has been updated
2.0.2
  • addition of Support at Home enumeration for careTypeCode
  • description for eventTypeCode has been updated
  • Id in descriptions and titles been updated to Identifier
  • examples have been added
  • operationId has been updated

\n","_postman_id":"68eaa234-0b10-4535-804e-51457ea42ca8","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"care-recipient-summary-2.1.0","item":[{"name":"/acws/care-recipients/v2","id":"72985714-e989-4b6f-9e07-57d490159d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2?firstName=string&lastName=string&gender=F&birthDate=1960-01-12&myAgedCareGatewayId=string&sparcId=string&limit=1000&page=1&sort-fields=lastName&sort=asc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","care-recipients","v2"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The first name or given name of the Care Recipient. Query is case insensitive and will match the start of a Care recipients firstname.

\n","type":"text/plain"},"key":"firstName","value":"string"},{"description":{"content":"

The last name or surname of Care Recipient. Query is case insensitive and will match the start of a Care recipients lastname.

\n","type":"text/plain"},"key":"lastName","value":"string"},{"description":{"content":"

The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified

\n","type":"text/plain"},"key":"gender","value":"F"},{"description":{"content":"

The date of birth of Care Recipient

\n","type":"text/plain"},"key":"birthDate","value":"1960-01-12"},{"description":{"content":"

The unique Identifier of the Care Recipient in My Aged Care Gateway

\n","type":"text/plain"},"key":"myAgedCareGatewayId","value":"string"},{"description":{"content":"

The unique Identifier for legacy SPARC system. New Care recipients will not have a SPARC id

\n","type":"text/plain"},"key":"sparcId","value":"string"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"1000"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=lastName,firstName

\n","type":"text/plain"},"key":"sort-fields","value":"lastName"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"2e883e4c-e370-470a-a766-70beac692918","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2?firstName=string&lastName=string&gender=F&birthDate=1960-01-12&myAgedCareGatewayId=string&sparcId=string&limit=1000&page=1&sort-fields=lastName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","v2"],"query":[{"description":"The first name or given name of the Care Recipient. Query is case insensitive and will match the start of a Care recipients firstname.","key":"firstName","value":"string"},{"description":"The last name or surname of Care Recipient. Query is case insensitive and will match the start of a Care recipients lastname.","key":"lastName","value":"string"},{"description":"The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified","key":"gender","value":"F"},{"description":"The date of birth of Care Recipient","key":"birthDate","value":"1960-01-12"},{"description":"The unique Identifier of the Care Recipient in My Aged Care Gateway","key":"myAgedCareGatewayId","value":"string"},{"description":"The unique Identifier for legacy SPARC system. New Care recipients will not have a SPARC id","key":"sparcId","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"1000"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=lastName,firstName","key":"sort-fields","value":"lastName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"careRecipientId\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"birthDate\": \"1993-02-16\",\n \"gender\": \"X\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\"\n },\n {\n \"careRecipientId\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"birthDate\": \"1998-06-11\",\n \"gender\": \"F\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\"\n }\n]"},{"id":"d564cd59-4a0e-446d-b95a-12abe0c155f3","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2?firstName=string&lastName=string&gender=F&birthDate=1960-01-12&myAgedCareGatewayId=string&sparcId=string&limit=1000&page=1&sort-fields=lastName&sort=asc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","v2"],"query":[{"description":"The first name or given name of the Care Recipient. Query is case insensitive and will match the start of a Care recipients firstname.","key":"firstName","value":"string"},{"description":"The last name or surname of Care Recipient. Query is case insensitive and will match the start of a Care recipients lastname.","key":"lastName","value":"string"},{"description":"The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified","key":"gender","value":"F"},{"description":"The date of birth of Care Recipient","key":"birthDate","value":"1960-01-12"},{"description":"The unique Identifier of the Care Recipient in My Aged Care Gateway","key":"myAgedCareGatewayId","value":"string"},{"description":"The unique Identifier for legacy SPARC system. New Care recipients will not have a SPARC id","key":"sparcId","value":"string"},{"description":"The number of items the user wants to return per page","key":"limit","value":"1000"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on. Multiple values can be provided comma separated ie sort-fields=lastName,firstName","key":"sort-fields","value":"lastName"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"asc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"72985714-e989-4b6f-9e07-57d490159d64"},{"name":"/acws/care-recipients/v2/:careRecipientId","id":"c8feb1d3-d577-4470-a34c-538bfdf0326d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"temp-access-key","value":"","description":"

Temporary access key. Conditional. Required when retrieving data for a care recipient that is not currently, or has not previously been in your care. Temporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2/:careRecipientId","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","care-recipients","v2",":careRecipientId"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[],"variable":[{"id":"ee90acd9-a9a1-48e6-b3a8-210dfa38bf40","description":{"content":"

The identifier of a person who has been assessed to be requiring Residential Care/Transition Care/Support at Home.

\n","type":"text/plain"},"type":"any","value":"","key":"careRecipientId"}]}},"response":[{"id":"23605507-2aab-4d4e-88cc-6dfc33188bf8","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"Temporary access key. Conditional. Required when retrieving data for a care recipient that is not currently, or has not previously been in your care. Temporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.","key":"temp-access-key","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2/:careRecipientId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","v2",":careRecipientId"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential Care/Transition Care/Support at Home."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"birthDate\": \"2011-06-28\",\n \"gender\": \"M\",\n \"myAgedCareGatewayId\": \"string\",\n \"sparcId\": \"string\",\n \"firstNations\": \"string\",\n \"homeless\": \"string\",\n \"careLeavers\": \"string\",\n \"careFindersProgram\": \"string\",\n \"modifiedMonashModelRating\": \"string\",\n \"anaccClassifications\": [\n {\n \"classification\": \"3\",\n \"classificationText\": \"string\",\n \"classificationTypeText\": \"string\",\n \"careType\": \"Residential Care\",\n \"careSubType\": \"Respite Care\",\n \"startDate\": \"1976-07-29\",\n \"endDate\": \"2013-10-24\",\n \"updatedAtDateTime\": \"1999-07-03T16:54:34.805Z\"\n },\n {\n \"classification\": \"103\",\n \"classificationText\": \"string\",\n \"classificationTypeText\": \"string\",\n \"careType\": \"Residential Care\",\n \"careSubType\": \"Permanent Care\",\n \"startDate\": \"1955-05-30\",\n \"endDate\": \"1957-02-19\",\n \"updatedAtDateTime\": \"1958-08-16T14:42:34.777Z\"\n }\n ],\n \"packages\": [\n {\n \"assignedLevel\": \"L1_L2\",\n \"startDate\": \"1988-09-03\",\n \"endDate\": \"1988-12-29\"\n },\n {\n \"assignedLevel\": \"L4\",\n \"startDate\": \"2011-04-24\",\n \"endDate\": \"2003-11-07\"\n }\n ],\n \"assessments\": [\n {\n \"assessmentId\": \"string\",\n \"thirdPartyId\": \"string\",\n \"acatId\": \"string\",\n \"status\": \"Additional Data\",\n \"approvalDate\": \"2017-09-18\",\n \"careDetails\": [\n {\n \"assessedCareLevelCode\": \"L4\",\n \"assessedCareLevelText\": \"string\",\n \"careTypeCode\": \"TRANS\",\n \"careTypeText\": \"string\",\n \"careSubTypeCode\": \"TC\",\n \"careSubTypeText\": \"string\",\n \"timeLimitedIndicator\": true,\n \"status\": \"Partial Approval / Rejection\",\n \"endDate\": \"1977-02-19\"\n },\n {\n \"assessedCareLevelCode\": \"L4\",\n \"assessedCareLevelText\": \"string\",\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"string\",\n \"careSubTypeCode\": \"PERM\",\n \"careSubTypeText\": \"string\",\n \"timeLimitedIndicator\": true,\n \"status\": \"Error\",\n \"endDate\": \"1963-12-13\"\n }\n ]\n },\n {\n \"assessmentId\": \"string\",\n \"thirdPartyId\": \"string\",\n \"acatId\": \"string\",\n \"status\": \"Cancelled successfully\",\n \"approvalDate\": \"1981-10-05\",\n \"careDetails\": [\n {\n \"assessedCareLevelCode\": \"RESI\",\n \"assessedCareLevelText\": \"string\",\n \"careTypeCode\": \"FLEXI\",\n \"careTypeText\": \"string\",\n \"careSubTypeCode\": \"TC\",\n \"careSubTypeText\": \"string\",\n \"timeLimitedIndicator\": false,\n \"status\": \"Pending Approval\",\n \"endDate\": \"2017-04-29\"\n },\n {\n \"assessedCareLevelCode\": \"L2\",\n \"assessedCareLevelText\": \"string\",\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"string\",\n \"careSubTypeCode\": \"TC\",\n \"careSubTypeText\": \"string\",\n \"timeLimitedIndicator\": true,\n \"status\": \"Approved\",\n \"endDate\": \"1954-05-27\"\n }\n ]\n }\n ],\n \"careExtensions\": [\n {\n \"careType\": \"Transition Care\",\n \"careSubType\": \"\",\n \"numberOfDaysExtended\": 4031.3722579970167,\n \"dateExtensionCommences\": \"2012-10-25\"\n },\n {\n \"careType\": \"Transition Care\",\n \"careSubType\": \"\",\n \"numberOfDaysExtended\": 9196.23250563663,\n \"dateExtensionCommences\": \"1986-06-28\"\n }\n ],\n \"placeAllocations\": [\n {\n \"placeIdentifier\": \"string\",\n \"effectiveStartDate\": \"2004-10-05\",\n \"effectiveEndDate\": \"1959-02-19\",\n \"status\": \"Withdrawn\",\n \"statusReason\": \"string\",\n \"currentPlaceIndicator\": \"Y\",\n \"updatedAtDateTime\": \"2026-01-20T09:09:01.590Z\"\n },\n {\n \"placeIdentifier\": \"string\",\n \"effectiveStartDate\": \"1949-04-24\",\n \"effectiveEndDate\": \"1946-12-21\",\n \"status\": \"Allocated\",\n \"statusReason\": \"string\",\n \"currentPlaceIndicator\": \"N\",\n \"updatedAtDateTime\": \"1956-04-01T16:00:56.438Z\"\n }\n ],\n \"classifications\": [\n {\n \"classificationType\": \"Short-term\",\n \"classificationCode\": \"524\",\n \"classificationText\": \"SAH Class 1\",\n \"effectiveStartDate\": \"2008-06-26\",\n \"effectiveEndDate\": \"1968-09-11\",\n \"updatedAtDateTime\": \"2005-04-22T21:37:29.461Z\"\n },\n {\n \"classificationType\": \"Ongoing\",\n \"classificationCode\": \"56\",\n \"classificationText\": \"SAH Class 1\",\n \"effectiveStartDate\": \"1962-06-19\",\n \"effectiveEndDate\": \"1981-09-18\",\n \"updatedAtDateTime\": \"2009-05-01T21:16:13.919Z\"\n }\n ],\n \"approvals\": [\n {\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"Residential Care\",\n \"careSubTypeCode\": \"PERM\",\n \"careSubTypeText\": \"Permanent Care\",\n \"classificationLevelCode\": \"U\",\n \"classificationLevelText\": \"string\",\n \"approvalStartDate\": \"2024-10-01\",\n \"approvalEndDate\": \"2024-11-01\",\n \"updatedAtDateTime\": \"2016-05-15T23:45:38.312Z\",\n \"approvedServices\": [\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1991-03-04\",\n \"effectiveEndDate\": \"1949-03-21\",\n \"updatedAtDateTime\": \"2025-10-09T18:11:08.218Z\"\n },\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1979-02-28\",\n \"effectiveEndDate\": \"2020-07-01\",\n \"updatedAtDateTime\": \"1974-05-10T22:23:39.233Z\"\n }\n ]\n },\n {\n \"careTypeCode\": \"RESI\",\n \"careTypeText\": \"Residential Care\",\n \"careSubTypeCode\": \"PERM\",\n \"careSubTypeText\": \"Permanent Care\",\n \"classificationLevelCode\": \"S\",\n \"classificationLevelText\": \"string\",\n \"approvalStartDate\": \"2024-10-01\",\n \"approvalEndDate\": \"2024-11-01\",\n \"updatedAtDateTime\": \"2024-05-11T04:53:43.621Z\",\n \"approvedServices\": [\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1946-08-07\",\n \"effectiveEndDate\": \"1975-10-21\",\n \"updatedAtDateTime\": \"1964-10-15T01:55:14.003Z\"\n },\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1996-02-28\",\n \"effectiveEndDate\": \"1985-04-18\",\n \"updatedAtDateTime\": \"1960-07-14T06:37:46.348Z\"\n }\n ]\n }\n ],\n \"approvedServices\": [\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1995-10-22\",\n \"effectiveEndDate\": \"1965-09-07\",\n \"updatedAtDateTime\": \"2001-01-24T06:40:58.463Z\"\n },\n {\n \"serviceGroupId\": \"string\",\n \"serviceGroupText\": \"string\",\n \"serviceTypeId\": \"string\",\n \"serviceTypeText\": \"string\",\n \"serviceId\": \"string\",\n \"serviceText\": \"string\",\n \"effectiveStartDate\": \"1956-03-26\",\n \"effectiveEndDate\": \"1980-12-04\",\n \"updatedAtDateTime\": \"1973-10-22T11:19:41.035Z\"\n }\n ],\n \"supplements\": [\n {\n \"supplementType\": \"string\",\n \"startDate\": \"1983-12-10\",\n \"endDate\": \"2019-04-08\",\n \"rate\": \"string\",\n \"updatedAtDateTime\": \"1965-10-15T22:50:04.323Z\"\n },\n {\n \"supplementType\": \"string\",\n \"startDate\": \"2019-10-21\",\n \"endDate\": \"1965-08-31\",\n \"rate\": \"string\",\n \"updatedAtDateTime\": \"1949-10-03T06:52:40.311Z\"\n }\n ],\n \"messages\": [\n {\n \"type\": \"E\",\n \"message\": \"string\"\n },\n {\n \"type\": \"E\",\n \"message\": \"string\"\n }\n ]\n}"},{"id":"18957212-7351-4796-ae5e-54419c995138","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"description":"Temporary access key. Conditional. Required when retrieving data for a care recipient that is not currently, or has not previously been in your care. Temporary access key is returned in care recipient search response. When expired, search will need to be performed again to get new key.","key":"temp-access-key","value":""},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/v2/:careRecipientId","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","v2",":careRecipientId"],"variable":[{"key":"careRecipientId","value":"","description":"The identifier of a person who has been assessed to be requiring Residential Care/Transition Care/Support at Home."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"c8feb1d3-d577-4470-a34c-538bfdf0326d"}],"id":"fdd0ca71-0ed8-47de-a84c-47a2b26c539e","description":"

Provides the summary information about a Care Recipient.

Version changes between 2.0.0 and 2.0.1

  • sort-fields and sort have been added to the search care recipients query
  • Messages entity has been added
  • Descriptions for the following fields have been updated
    • firstName
    • lastName
  • Description and enumerations have been update for status under the assessment entity
  • Error entity has been updated
  • Care recipient Gender updated to provide enumeration
  • Updated Class 98 and 99 descriptions

Version changes between 2.0.1 and 2.1.0

  • added place allocation information and updatedAtDateTime been added
  • added classificationTypeText and updatedAtDateTime for ANACC Classification
  • added approved services, classification and supplement entities
  • operationId has been updated
  • progressiveConditionIndicator has been removed
  • enumerations for classificationCode have been updated
  • added Approvals entity

\n","_postman_id":"fdd0ca71-0ed8-47de-a84c-47a2b26c539e","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"care-recipient-search-2.0.1","item":[{"name":"/acws/care-recipients/search/v2","id":"f370e4fa-d488-4595-81b0-c6ea42000b02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/search/v2?careRecipientId=string&firstName=string&middleName=string&lastName=string&gender=F&birthDate=1960-01-12&postCode=stri&state=QLD","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","care-recipients","search","v2"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The identifier of a person who has been assessed to be requiring residential, home or flexible care

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

The first name or given name of the Care Recipient

\n","type":"text/plain"},"key":"firstName","value":"string"},{"description":{"content":"

The middle name of the Care Recipient

\n","type":"text/plain"},"key":"middleName","value":"string"},{"description":{"content":"

The last name or surname of the Care Recipient

\n","type":"text/plain"},"key":"lastName","value":"string"},{"description":{"content":"

The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified

\n","type":"text/plain"},"key":"gender","value":"F"},{"description":{"content":"

The date of birth of the Care Recipient

\n","type":"text/plain"},"key":"birthDate","value":"1960-01-12"},{"description":{"content":"

Post Code

\n","type":"text/plain"},"key":"postCode","value":"stri"},{"description":{"content":"

State

\n","type":"text/plain"},"key":"state","value":"QLD"}],"variable":[]}},"response":[{"id":"84b3ce1c-0ade-43c0-96fc-56efc45efd8c","name":"Retrieved entities","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/search/v2?careRecipientId=string&firstName=string&middleName=string&lastName=string&gender=F&birthDate=1960-01-12&postCode=stri&state=QLD","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","search","v2"],"query":[{"description":"The identifier of a person who has been assessed to be requiring residential, home or flexible care","key":"careRecipientId","value":"string"},{"description":"The first name or given name of the Care Recipient","key":"firstName","value":"string"},{"description":"The middle name of the Care Recipient","key":"middleName","value":"string"},{"description":"The last name or surname of the Care Recipient","key":"lastName","value":"string"},{"description":"The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified","key":"gender","value":"F"},{"description":"The date of birth of the Care Recipient","key":"birthDate","value":"1960-01-12"},{"description":"Post Code","key":"postCode","value":"stri"},{"description":"State","key":"state","value":"QLD"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"careRecipientId\": \"string\",\n \"firstName\": \"string\",\n \"middleName\": \"string\",\n \"lastName\": \"string\",\n \"birthDate\": \"1967-03-26\",\n \"gender\": \"F\",\n \"tempAccessKey\": \"string\",\n \"tempAccessExpiry\": \"1980-01-07T09:36:33.836Z\",\n \"messages\": [\n {\n \"type\": \"W\",\n \"message\": \"string\"\n },\n {\n \"type\": \"I\",\n \"message\": \"string\"\n }\n ]\n}"},{"id":"ab214800-352d-417e-8ecd-738659b78aa8","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/care-recipients/search/v2?careRecipientId=string&firstName=string&middleName=string&lastName=string&gender=F&birthDate=1960-01-12&postCode=stri&state=QLD","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","care-recipients","search","v2"],"query":[{"description":"The identifier of a person who has been assessed to be requiring residential, home or flexible care","key":"careRecipientId","value":"string"},{"description":"The first name or given name of the Care Recipient","key":"firstName","value":"string"},{"description":"The middle name of the Care Recipient","key":"middleName","value":"string"},{"description":"The last name or surname of the Care Recipient","key":"lastName","value":"string"},{"description":"The gender of Care Recipient * M - Male * F - Female * X - Indeterminate/Intersex/Unspecified","key":"gender","value":"F"},{"description":"The date of birth of the Care Recipient","key":"birthDate","value":"1960-01-12"},{"description":"Post Code","key":"postCode","value":"stri"},{"description":"State","key":"state","value":"QLD"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"f370e4fa-d488-4595-81b0-c6ea42000b02"}],"id":"eb1ad5b1-58cb-488f-b9d4-c54c911e8b15","description":"

Ability to search for a Care Recipient.
\n

Additional Information


One of the following permutations of search parameters are required.

  • (careRecipientId + lastName + birthDate) or
  • (firstName + lastName + birthDate + gender)
\nPlease refer to tempAccessKey for further information about the requirement to show that a search was completed before entering a care recipient into care.

Version changes between 2.0.0 and 2.0.1

  • Messages entity has been added under the CareRecipientSummary
  • Error response entity has been updated
  • Care recipient Gender updated to provide enumeration

\n","_postman_id":"eb1ad5b1-58cb-488f-b9d4-c54c911e8b15","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}},{"name":"care-recipient-individual-contribution-1.0.0","item":[{"name":"/acws/support-at-home/care-recipients/individual-contribution/v1","id":"51da10c3-a1a6-41a9-8c5a-bd3fbbf878b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"provider-id","value":"string","description":"

QuickClaim provider ID

\n"},{"key":"org-id","value":"string","description":"

QuickClaim organization ID

\n"},{"key":"Accept","value":"application/json"}],"url":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/care-recipients/individual-contribution/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&effectiveDateFrom=current-date - 3 months&effectiveDateTo=current-date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}},"urlObject":{"path":["acws","support-at-home","care-recipients","individual-contribution","v1"],"host":["https://api.quickclaim.io/sah/gateway/native"],"query":[{"description":{"content":"

The Services Australia Identifier for the Service provider

\n","type":"text/plain"},"key":"serviceProviderId","value":"string"},{"description":{"content":"

The National Approved Provider System(NAPS) Identifier for the service provider

\n","type":"text/plain"},"key":"serviceNapsId","value":"strin"},{"description":{"content":"

The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home

\n","type":"text/plain"},"key":"careRecipientId","value":"string"},{"description":{"content":"

The start of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateFrom","value":"current-date - 3 months"},{"description":{"content":"

The end of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"effectiveDateTo","value":"current-date"},{"description":{"content":"

The start of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The end of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.

\n","type":"text/plain"},"key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":{"content":"

The number of items the user wants to return per page

\n","type":"text/plain"},"key":"limit","value":"100"},{"description":{"content":"

The page the user wants to return

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime

\n","type":"text/plain"},"key":"sort-fields","value":"createdAtDateTime"},{"description":{"content":"

The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.

\n
    \n
  • asc - ascending order
    • \n
  • desc - descending order
    • \n
\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"5ec7c2e2-982f-4ee6-b98d-b184dcba8d6d","name":"Care recipients","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/care-recipients/individual-contribution/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&effectiveDateFrom=current-date - 3 months&effectiveDateTo=current-date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","care-recipients","individual-contribution","v1"],"query":[{"description":"The Services Australia Identifier for the Service provider","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System(NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"The start of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current-date - 3 months"},{"description":"The end of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current-date"},{"description":"The start of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime ","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"entryDate\": \"2023-09-09\",\n \"contributionType\": \"Support at Home\",\n \"participantContributionCategory\": \"Everyday living\",\n \"contributionPercentage\": 50,\n \"startDate\": \"2023-09-10\",\n \"endDate\": \"2023-10-10\",\n \"updatedAtDateTime\": \"1991-10-24T18:41:33.518Z\"\n },\n {\n \"serviceProviderId\": \"12345\",\n \"serviceNapsId\": \"12345\",\n \"careRecipientId\": \"12345\",\n \"careRecipientFirstName\": \"Test\",\n \"careRecipientLastName\": \"Care Recipient\",\n \"entryDate\": \"2023-09-09\",\n \"contributionType\": \"Support at Home\",\n \"participantContributionCategory\": \"Clinical supports\",\n \"contributionPercentage\": 50,\n \"startDate\": \"2023-09-10\",\n \"endDate\": \"2023-10-10\",\n \"updatedAtDateTime\": \"1955-10-01T05:19:55.213Z\"\n }\n]"},{"id":"915d659a-2ba5-4685-8b26-732320dc2407","name":"Error","originalRequest":{"method":"GET","header":[{"description":"QuickClaim provider ID","key":"provider-id","value":"string"},{"description":"QuickClaim organization ID","key":"org-id","value":"string"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: apikey","key":"Authorization","value":""}],"url":{"raw":"https://api.quickclaim.io/sah/gateway/native/acws/support-at-home/care-recipients/individual-contribution/v1?serviceProviderId=string&serviceNapsId=strin&careRecipientId=string&effectiveDateFrom=current-date - 3 months&effectiveDateTo=current-date&updatedAtDateTimeFrom=2004-10-11T02:49:29.486Z&updatedAtDateTimeTo=2004-10-11T02:49:29.486Z&limit=100&page=1&sort-fields=createdAtDateTime&sort=desc","host":["https://api.quickclaim.io/sah/gateway/native"],"path":["acws","support-at-home","care-recipients","individual-contribution","v1"],"query":[{"description":"The Services Australia Identifier for the Service provider","key":"serviceProviderId","value":"string"},{"description":"The National Approved Provider System(NAPS) Identifier for the service provider","key":"serviceNapsId","value":"strin"},{"description":"The identifier of a person who has been assessed to be requiring Residential\nCare, Transition Care or Support at Home ","key":"careRecipientId","value":"string"},{"description":"The start of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.","key":"effectiveDateFrom","value":"current-date - 3 months"},{"description":"The end of range query for care recipient individual contribution effective on Response will be inclusive of date time provided.","key":"effectiveDateTo","value":"current-date"},{"description":"The start of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeFrom","value":"2004-10-11T02:49:29.486Z"},{"description":"The end of range query of individual contribution updatedAtDateTime date time field. Response will be inclusive of date time provided.","key":"updatedAtDateTimeTo","value":"2004-10-11T02:49:29.486Z"},{"description":"The number of items the user wants to return per page","key":"limit","value":"100"},{"description":"The page the user wants to return","key":"page","value":"1"},{"description":"The fields the response will be sorted on.\nMultiple values can be provided comma separated ie sort-fields=careRecipientId,updatedAtDateTime ","key":"sort-fields","value":"createdAtDateTime"},{"description":"The order the fields will be sorted. This will apply to all sort-fields if multiple are provided.\n * asc - ascending order\n * desc - descending order","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"string\",\n \"codeType\": \"string\",\n \"message\": \"string\",\n \"details\": [\n {\n \"code\": \"string\",\n \"message\": \"string\"\n },\n {\n \"code\": \"string\",\n \"message\": \"string\"\n }\n ]\n}"}],"_postman_id":"51da10c3-a1a6-41a9-8c5a-bd3fbbf878b4"}],"id":"eb629ec5-70aa-4517-9516-4dcf27428af0","description":"

Relates to the individual contribution for a Care Recipient within Support at Home.

\n

Changes

\n\n \n \n \n \n \n \n \n \n \n \n \n \n
API VersionChanges
0.0.1Initial Draft
1.0.0\n
    \n
  • Id in descriptions and titles been updated to Identifier
    • \n
  • examples have been added and updated
    • \n
  • added updatedAtDateTime as query parameters for Get care recipient individual contribution GET call
    • \n
  • operationId has been updated
    • \n
  • contributionType has been added
    • \n
  • serviceNapsId has been added
    • \n
  • updated contributionPercentage
    • \n
\n
","_postman_id":"eb629ec5-70aa-4517-9516-4dcf27428af0","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":true,"source":{"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110","id":"88885618-8b48-4a52-97c1-7bcd847ec110","name":"Support At Home (Native)","type":"folder"}}}],"id":"88885618-8b48-4a52-97c1-7bcd847ec110","description":"

Overview

\n

quickclaim Support at Home Native API is a proxy pass-through gateway to Services Australia native Support at Home endpoints.

\n

This specification is generated from the official Services Australia OpenAPI files and adapted for QuickClaim native routing.

\n

How Requests Are Handled

\n
    \n

  • You call the QuickClaim native gateway base URLs in this document.

    \n
    • \n

  • QuickClaim forwards requests to upstream Services Australia endpoints.

    \n
    • \n

  • QuickClaim handles upstream authorization and required DHS integration headers on your behalf.

    \n
    • \n
\n

What You Must Send

\n

Include these QuickClaim headers on requests:

\n
    \n

  • Authorization with the required apikey prefix

    \n
    • \n

  • org-id

    \n
    • \n

  • provider-id

    \n
    • \n
\n

Also provide endpoint-specific request fields exactly as documented.

\n

Performance Note

\n

These APIs are passed through directly to Services Australia, so endpoint performance for these APIs is not guaranteed by QuickClaim.

\n

Known performance issues can occur, especially for:

\n
    \n

  • larger datasets

    \n
    • \n

  • search-heavy queries

    \n
    • \n

  • broad filtering queries

    \n
    • \n
\n","auth":{"type":"apikey","apikey":{"value":"","key":""},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"58593497-2004-467d-9bdc-986e973d02be","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"05238b21-ca38-49ce-9809-eeccf65ed347","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"88885618-8b48-4a52-97c1-7bcd847ec110"}],"event":[{"listen":"prerequest","script":{"id":"b6e1d95e-350a-4938-b488-df0bd7262115","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"0d99c156-6aa7-46ce-ae6c-64a5f8f39eb5","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseURL4","value":"https://api.quickclaim.io/ndis-native-api/4.0"},{"key":"baseURL3","value":"https://api.quickclaim.io/ndis-native-api/3.0"},{"key":"baseURL2","value":"https://api.quickclaim.io/ndis-native-api/2.0"},{"key":"baseURL1","value":"https://api.quickclaim.io/ndis-native-api/1.0"},{"key":"paceBaseURL","value":"https://api.quickclaim.io/ndis-native-api/ext-int-part/4.0"},{"key":"baseUrl","value":"https://api.quickclaim.io/public"},{"key":"diBaseUrl","value":"https://api.di.quickclaim.io"},{"key":"sahCatalogBaseUrl","value":"https://stage-api.quickclaim.io/sah/pub/v1/catalog"},{"key":"sahProviderBaseUrl","value":"https://stage-api.quickclaim.io/sah/pub/v1/provider"},{"key":"sahFinanceBaseUrl","value":"https://stage-api.quickclaim.io/sah/pub/v1/provider"},{"key":"sahTxBaseUrl","value":"https://stage-api.quickclaim.io/sah/pub/v1/tx"},{"key":"sahCareRecipientBaseUrl","value":"https://stage-api.quickclaim.io/sah/pub/v1/care-recipient"},{"key":"sahBudgetBaseUrl","value":""},{"key":"sahNativeBaseUrl","value":"https://api.quickclaim.io/sah/gateway/native"}]}