{"info":{"_postman_id":"22ebbcef-928c-4606-90d5-97c8e188cf19","name":"Aloha Customer API","description":"

The Aloha Customer API allows you to programmatically access data stored in Aloha Practice Management Software with ease.

\n

Overview

\n
    \n

  1. You need a valid clientId and secretKey to generate a short-lived bearer access_token which will be required to send requests to the API endpoints. You can get your authentication credentials by reaching out to our Support Portal. Include the bearer access_token in the Authorization header of your requests as Authorization: Bearer .

    \n
    2. \n

  2. The API has an access rate limit applied to it.

    \n
    3. \n

  3. The API will only respond to secured communication done over HTTPS. HTTP requests will be sent a 301 redirect to corresponding HTTPS resources.

    \n
    4. \n

  4. The API supports only TLS 1.3 and TLS 1.2 protocols for secure communication. It is recommended to use TLS 1.3 as it is faster and more secure.

    \n
    5. \n

  5. It is recommended to use HTTP/2 (h2) ALPN over HTTP/1.1 as it provides better performance and efficiency.

    \n
    6. \n

  6. The API is versioned. Include the version in your endpoint paths, e.g., /v1/resource.

    \n
    7. \n

  7. Response to every request is sent in JSON format. In case the API request results in an error, it is represented by an \"errors\": {} key in the JSON response.

    \n
    8. \n

  8. The request method (verb) determines the nature of action you intend to perform. A request made using the GET method implies that you want to fetch something from the API, PUT implies that you want to add something new to the API, POST implies that you want to update something to the API and DELETE implies that you want to delete something from the API.

    \n
    9. \n

  9. The API calls will respond with appropriate HTTP status codes for all requests.

    \n
    10. \n
\n

Authentication

\n

Valid bearer access_token is required to be sent as part of every request to the Aloha Customer API, in the form of an Authorization request header. You need to generate access_token by calling Generate AccessToken endpoint. The bearer access_token are short-lived and requiring refresh every 3 hours from the generation time.

\n
\n

If you do not have clientId and secretKey, you can easily get one by reaching out to our Support Portal.

\n
\n

Error Codes

\n

What errors and status codes can a user expect?

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderDescription
400A validation error had occurred
401A not authenticated error had occurred
403A not authorized error had occurred
404A path not found or primary entity not found
429Rate limit exceeded, or you are not hitting the correct URL. Please refer to the error message that came with the code.
500An internal error has occurred, this is probably not your fault.
\n

Rate Limits

\n

API access rate limits are applied at a per-key basis in unit time. Access to the API using a key is limited to 1,000 requests per day. In addition, every API response is accompanied by the following set of headers to identify the status of your consumption.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HeaderDescription
X-RateLimit-LimitThe maximum number of requests that the consumer is permitted to make per day.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetThe time at which the current rate limit window resets in UTC epoch seconds.
\n

Once you hit the rate limit, you will receive a response similar to the following JSON, with a status code of 429 Too Many Requests.

\n
{\n    \"status\": 429,\n    \"message\": \"Too Many Requests\",\n    \"errors\": [\n        {\n            \"name\": \"RateLimitError\",\n            \"message\": \"Rate Limit exceeded. Please retry at 1716595200\"\n        }\n    ]\n}\n\n
\n

Service Status

\n

Before contacting Support, please check our live Status Page for any active Incidents, Announcements, or Scheduled Events that may affect the Customer API at https://status.alohaaba.com/

\n

If the Status Page shows an incident impacting you, subscribe to updates there. If everything is green, but you're still having issues, reach out to Technical Support.

\n

Support

\n

For help regarding accessing the Aloha Customer API, feel free to drop in a line at support@alohaaba.com.

\n

In the event you receive a 500 response from our servers, it implies that we have hit an unexpected spike in API access traffic and would usually be operational within the next 15 minutes. If the outage persists, or you receive any other form of 5xx error, kindly let us know.

\n

Terms of Use

\n

For information on API terms of use and privacy, refer to our policy document at https://alohaaba.com/terms and https://alohaaba.com/privacy-policy

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate Limits","slug":"rate-limits"},{"content":"Service Status","slug":"service-status"},{"content":"Support","slug":"support"},{"content":"Terms of Use","slug":"terms-of-use"}],"owner":"33696820","collectionId":"22ebbcef-928c-4606-90d5-97c8e188cf19","publishedId":"2sA3JT3e7J","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-21T23:58:51.000Z"},"item":[{"name":"Authorization","item":[{"name":"Generate AccessToken","event":[{"listen":"test","script":{"id":"2e2765f8-4beb-450e-bb0f-a35aef8f5dfa","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let jsonResponse = pm.response.json();\r"," pm.collectionVariables.set('access_token', jsonResponse['data']['accessToken']);\r"," pm.collectionVariables.set('refresh_token', jsonResponse['data']['refreshToken']);\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bc464b7a-0688-43d2-a0d0-3dc326d6f6e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{{clientId}}\",\r\n \"secretKey\": \"{{secretKey}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiProtocol}}{{apiHost}}/token","description":"

Generate AccessToken Request

\n

This endpoint allows the client to obtain a access_token by providing the client ID and secret key in the request payload.

\n

Request Body

\n\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"isSuccess\": {\n            \"type\": \"boolean\"\n        },\n        \"data\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"username\": {\n                    \"type\": \"string\"\n                },\n                \"accessToken\": {\n                    \"type\": \"string\"\n                },\n                \"accessTokenExpiration\": {\n                    \"type\": \"string\"\n                },\n                \"refreshToken\": {\n                    \"type\": \"string\"\n                },\n                \"subscriptionId\": {\n                    \"type\": \"string\"\n                }\n            }\n        },\n        \"errorMessage\": {\n            \"type\": [\"string\", \"null\"]\n        }\n    }\n}\n\n
\n","urlObject":{"path":["token"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"bd637470-4988-46b2-8121-9eb28ed16db8","name":"Generate AccessToken","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{{client_id}}\",\r\n \"secretKey\": \"{{secret_key}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiProtocol}}{{apiHost}}/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 31 May 2024 22:41:19 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-remaining","value":"0"},{"key":"x-ratelimit-reset","value":"1717200000"},{"key":"x-span","value":"0.2057833"},{"key":"x-trace-id","value":"13b4e5c3-51ef-4d02-962a-5b87a19701a9"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": {\n \"username\": \"Aloha.Client.ACME\",\n \"accessToken\": \"eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQWxvaGEuQ2xpZW50LkFiYW50IiwiU3Vic2NyaXB0aW9uSUQiOiIyNjM5ZjYzZS1lMDEwLTRhNjctYTI2Ny1jOWJlMTZlMzI0ZTYiLCJleHAiOjE3MTcyMDYwNzksImlzcyI6Imh0dHBzOi8vYWxvaGFhYmEuY29tLyIsImF1ZCI6Imh0dHBzOi8vYWxvaGFhYmEuY29tLyJ9.7ZHufETsibBxs8k9X8j6Yw57-37hjep3usxk5LS2hwQ\",\n \"accessTokenExpiration\": \"2024-06-01T01:41:19Z\",\n \"refreshToken\": \"ZNsAOKVqkN+XssUYuTAmPQBsJngCmipwggWm7Z9c4ug=\",\n \"subscriptionId\": \"2639f63e-e010-4a67-a267-c9be16e324e6\"\n }\n}"}],"_postman_id":"bc464b7a-0688-43d2-a0d0-3dc326d6f6e4"},{"name":"Refresh AccessToken","event":[{"listen":"test","script":{"id":"2e2765f8-4beb-450e-bb0f-a35aef8f5dfa","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let jsonResponse = pm.response.json();\r"," pm.collectionVariables.set('access_token', jsonResponse['data']['accessToken']);\r"," pm.collectionVariables.set('refresh_token', jsonResponse['data']['refreshToken']);\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{}}}],"id":"824e7296-352d-423b-9f76-f02a6efdd95a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{{clientId}}\",\r\n \"accessToken\": \"\",\r\n \"refreshToken\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiProtocol}}{{apiHost}}/refresh-token","description":"

Refresh Token Request

\n

This endpoint is used to refresh the access token by providing the client ID, access token, and refresh token in the request payload.

\n

Request Body

\n\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n

JSON Schema for Response

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"isSuccess\": {\n            \"type\": \"boolean\"\n        },\n        \"data\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"username\": {\n                    \"type\": \"string\"\n                },\n                \"accessToken\": {\n                    \"type\": \"string\"\n                },\n                \"accessTokenExpiration\": {\n                    \"type\": \"string\"\n                },\n                \"refreshToken\": {\n                    \"type\": \"string\"\n                },\n                \"subscriptionId\": {\n                    \"type\": \"string\"\n                }\n            }\n        },\n        \"errorMessage\": {\n            \"type\": [\"string\", \"null\"]\n        }\n    }\n}\n\n
\n","urlObject":{"path":["refresh-token"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"de4656e4-a484-4059-b380-56a4d128f00f","name":"Refresh AccessToken","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"clientId\": \"{{client_id}}\",\r\n \"accessToken\": \"\",\r\n \"refreshToken\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{apiProtocol}}{{apiHost}}/refresh-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 31 May 2024 22:42:17 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-remaining","value":"0"},{"key":"x-ratelimit-reset","value":"1717200000"},{"key":"x-span","value":"0.0269587"},{"key":"x-trace-id","value":"c49545a6-1407-4957-872b-e7054b139d6a"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": {\n \"username\": \"Aloha.Client.ACME\",\n \"accessToken\": \"eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIjoiQWxvaGEuQ2xpZW50LkFiYW50IiwiU3Vic2NyaXB0aW9uSUQiOiIyNjM5ZjYzZS1lMDEwLTRhNjctYTI2Ny1jOWJlMTZlMzI0ZTYiLCJleHAiOjE3MTcyMDYxMzgsImlzcyI6Imh0dHBzOi8vYWxvaGFhYmEuY29tLyIsImF1ZCI6Imh0dHBzOi8vYWxvaGFhYmEuY29tLyJ9.2v1BL990B94-8Ym_gskDvn-MEeprHSQDlvkOEZkqUuA\",\n \"accessTokenExpiration\": \"2024-06-01T01:42:18Z\",\n \"refreshToken\": \"qVAti36CIyvXj7MeeQpxsiqGncRavslhKdwFN5eKI7E=\",\n \"subscriptionId\": \"2639f63e-e010-4a67-a267-c9be16e324e6\"\n }\n}"}],"_postman_id":"824e7296-352d-423b-9f76-f02a6efdd95a"}],"id":"8b313342-0019-44dc-a7bd-8f3d6c8c795a","_postman_id":"8b313342-0019-44dc-a7bd-8f3d6c8c795a","description":""},{"name":"Reports","item":[{"name":"List Clients","event":[{"listen":"test","script":{"id":"a1048b13-5e4f-443d-8dd3-9654fd4a1bd5","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let template = `\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r","\r"," {{#each response.data}}\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," {{/each}}\r","
No#IDFirstNameLastNameAliasNameAvatarUrlOfficeIDisActiveStreetCityStateZipInactiveDate
{{@index}}{{clientId}}{{firstName}}{{lastName}}{{aliasName}}{{imageUrl}}{{officeId}}{{isActive}}{{street}}{{city}}{{state}}{{zip}}{{inActiveDate}}
\r"," `;\r","\r"," pm.visualizer.set(template, {\r"," // Pass the response body parsed as JSON as `data`\r"," response: pm.response.json()\r"," });\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"19eba433-43c0-4f05-a94b-8b5eda0b1749","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"4d21acbc-9e26-4d3f-91e6-392086bad3e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/clients","description":"

The GET /v1/report/clients endpoint retrieves detailed information about the clients associated with a specific customer in Aloha. The report includes various columns such as client name, alias name, date of birth (DOB), gender, and other relevant client information.

\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"status\": {\n            \"type\": \"integer\"\n        },\n        \"message\": {\n            \"type\": \"string\"\n        },\n        \"data\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                    \"clientId\": {\n                        \"type\": \"integer\"\n                    },\n                    \"firstName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"250\"\n                    },\n                    \"lastName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"aliasName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"imageUrl\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"500\"\n                    },\n                    \"officeId\": {\n                        \"type\": \"integer\"\n                    },\n                    \"office\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"250\"\n                    },\n                    \"isActive\": {\n                        \"type\": \"boolean\"\n                    },\n                    \"street\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"city\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"state\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"zip\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"inActiveDate\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ]\n                    }\n                }\n            }\n        }\n    }\n}\n\n
\n","urlObject":{"path":["report","clients"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[],"variable":[]}},"response":[{"id":"538b2564-1277-4799-9687-70629565e862","name":"List clients","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Sat, 25 May 2024 05:45:53 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"805"},{"key":"x-ratelimit-reset","value":"1716681600"},{"key":"x-span","value":"0.0811668"},{"key":"x-trace-id","value":"2d71a8f4-efcf-477b-b6fb-08d9241751e7"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"clientId\": 101,\n \"firstName\": \"Alice\",\n \"lastName\": \"Winston\",\n \"aliasName\": \"AW1234\",\n \"imageUrl\": \"https://example.com/images/alice.jpg\",\n \"officeId\": 10,\n \"isActive\": true,\n \"street\": \"1023 Willow Lane\",\n \"city\": \"Miami\",\n \"state\": \"Florida\",\n \"zip\": \"33101\",\n \"inActiveDate\": null\n },\n {\n \"clientId\": 102,\n \"firstName\": \"Robert\",\n \"lastName\": \"Smith\",\n \"aliasName\": \"RS5678\",\n \"imageUrl\": \"https://example.com/images/robert.jpg\",\n \"officeId\": 11,\n \"isActive\": true,\n \"street\": \"5467 Pine Street\",\n \"city\": \"Houston\",\n \"state\": \"Texas\",\n \"zip\": \"77002\",\n \"inActiveDate\": null\n },\n {\n \"clientId\": 103,\n \"firstName\": \"Sophia\",\n \"lastName\": \"Garcia\",\n \"aliasName\": \"SG9101\",\n \"imageUrl\": null,\n \"officeId\": 12,\n \"isActive\": false,\n \"street\": \"3209 Oak Avenue\",\n \"city\": \"Phoenix\",\n \"state\": \"Arizona\",\n \"zip\": \"85001\",\n \"inActiveDate\": \"06-15-2023\"\n },\n {\n \"clientId\": 104,\n \"firstName\": \"James\",\n \"lastName\": \"Thompson\",\n \"aliasName\": \"JT4321\",\n \"imageUrl\": \"https://example.com/images/james.jpg\",\n \"officeId\": 13,\n \"isActive\": false,\n \"street\": \"7543 Cedar Street\",\n \"city\": \"Atlanta\",\n \"state\": \"Georgia\",\n \"zip\": \"30301\",\n \"inActiveDate\": \"07-20-2024\"\n },\n {\n \"clientId\": 105,\n \"firstName\": \"Isabella\",\n \"lastName\": \"Martinez\",\n \"aliasName\": \"IM5643\",\n \"imageUrl\": \"https://example.com/images/isabella.jpg\",\n \"officeId\": 14,\n \"isActive\": true,\n \"street\": \"3412 Birch Avenue\",\n \"city\": \"Dallas\",\n \"state\": \"Texas\",\n \"zip\": \"75201\",\n \"inActiveDate\": null\n }\n ]\n}"}],"_postman_id":"4d21acbc-9e26-4d3f-91e6-392086bad3e3"},{"name":"List Appointments","event":[{"listen":"test","script":{"id":"a1048b13-5e4f-443d-8dd3-9654fd4a1bd5","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let template = `\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r","\r"," {{#each response.data}}\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," {{/each}}\r","
@indexappointmentId\r"," clientIdclaimIdappointmentDateappointmentStartdateBilledappointmentEndclientNamestaffNamegenderappointmentLocationpatientAddressinsuredIdofficerenderingProviderNPIrenderingProviderdiagnosticCodesdiagnosticCodes2diagnosticCodes3payerNameauthorizationNumberchargeLineTimeZoneofficeTimeZoneserviceFacilityserviceFacilityAddressclientCitybillingAddresscanceledTypeserviceNamebillingProviderNPIbillingProviderbillingCodeadditionalCodemodifiermodifier2modifier3placeOfServiceunitsunitSizechargechargeRatecontractRatecontractAmountdobreferringProviderNamereferringProviderNPIbillingMinutesbillingHourscompleted
{{@index }}{{appointmentId}}{{clientId}}{{claimId}}{{appointmentDate}}{{appointmentStart}}{{dateBilled}}{{appointmentEnd}}{{clientName}}{{staffName}}{{gender}}{{appointmentLocation}}{{patientAddress}}{{insuredId}}{{office}}{{renderingProviderNPI}}{{renderingProvider}}{{diagnosticCodes}}{{diagnosticCodes2}}{{diagnosticCodes3}}{{payerName}}{{authorizationNumber}}{{chargeLineTimeZone}}{{officeTimeZone}}{{serviceFacility}}{{serviceFacilityAddress}}{{clientCity}}{{billingAddress}}{{canceledType}}{{serviceName}}{{billingProviderNPI}}{{billingProvider}}{{billingCode}}{{additionalCode}}{{modifier}}{{modifier2}}{{modifier3}}{{placeOfService}}{{units}}{{unitSize}}{{charge}}{{chargeRate}}{{contractRate}}{{contractAmount}}{{dob}}{{referringProviderName}}{{referringProviderNPI}}{{billingMinutes}}{{billingHours}}{{completed}}
\r"," `;\r","\r"," pm.visualizer.set(template, {\r"," // Pass the response body parsed as JSON as `data`\r"," response: pm.response.json()\r"," });\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"9ab80283-5022-477b-9eb2-19e753168148","exec":["const moment = require('moment');\r","\r","// Get the beginning of the current month\r","const startOfMonth = moment().startOf('month').add(-1, 'month').format('YYYY-MM-DD');\r","pm.variables.set(\"startDate\", startOfMonth); // Beginning of the Date\r","\r","// Get the end of the current month\r","const endOfMonth = moment().endOf('month').add(-1, 'month').format('YYYY-MM-DD');\r","pm.variables.set(\"endDate\", endOfMonth); // End of the Day"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"337fdcec-63b4-44fe-92eb-f2ec723fd562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/appointments?startDate={{startDate}}&endDate={{endDate}}","description":"

The GET /v1/report/appointments endpoint retrieves detailed information about the appointments associated with a specific subscriber in Aloha. The report includes various columns such as appointment date, client name, staff name, and other relevant appointment details.

\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"status\": {\n            \"type\": \"integer\"\n        },\n        \"message\": {\n            \"type\": \"string\"\n        },\n        \"data\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                    \"appointmentId\": {\n                        \"type\": \"integer\"\n                    },\n                    \"clientId\": {\n                        \"type\": \"integer\"\n                    },\n                    \"claimId\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"100\"\n                    },\n                    \"appointmentDate\": {\n                        \"type\": \"string\",\n                        \"format\": \"date\"\n                    },\n                    \"appointmentStart\": {\n                        \"type\": \"string\",\n                        \"format\": \"time\"\n                    },\n                    \"appointmentEnd\": {\n                        \"type\": \"string\",\n                        \"format\": \"time\"\n                    },\n                    \"clientName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"staffName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"gender\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"appointmentLocation\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"100\"\n                    },\n                    \"patientAddress\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"450\"\n                    },\n                    \"insuredId\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"100\"\n                    },\n                    \"office\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"250\"\n                    },\n                    \"renderingProviderNPI\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"renderingProvider\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"diagnosticCodes\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"diagnosticCodes2\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"150\"\n                    },\n                    \"diagnosticCodes3\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"150\"\n                    },\n                    \"payerName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"250\"\n                    },\n                    \"authorizationNumber\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"chargeLineTimeZone\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"500\"\n                    },\n                    \"officeTimeZone\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"500\"\n                    },\n                    \"serviceFacility\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"serviceFacilityAddress\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"450\"\n                    },\n                    \"clientCity\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"billingAddress\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"450\"\n                    },\n                    \"canceledType\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"6\"\n                    },\n                    \"serviceName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"billingProviderNPI\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"50\"\n                    },\n                    \"billingProvider\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"billingCode\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"210\"\n                    },\n                    \"additionalCode\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"100\"\n                    },\n                    \"modifier\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"150\"\n                    },\n                    \"modifier2\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"150\"\n                    },\n                    \"modifier3\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"150\"\n                    },\n                    \"placeOfService\": {\n                        \"type\": [\n                            \"integer\",\n                            \"null\"\n                        ]\n                    },\n                    \"units\": {\n                        \"type\": \"number\"\n                    },\n                    \"unitSize\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"150\"\n                    },\n                    \"charge\": {\n                        \"type\": \"number\"\n                    },\n                    \"chargeRate\": {\n                        \"type\": \"number\"\n                    },\n                    \"contractRate\": {\n                        \"type\": \"number\"\n                    },\n                    \"contractAmount\": {\n                        \"type\": \"number\"\n                    },\n                    \"dob\": {\n                        \"type\": \"string\",\n                        \"format\": \"mm-dd-yyyy\"\n                    },\n                    \"referringProviderName\": {\n                        \"type\": \"string\",\n                        \"maxLength\": \"360\"\n                    },\n                    \"referringProviderNPI\": {\n                        \"type\": [\n                            \"string\",\n                            \"null\"\n                        ],\n                        \"maxLength\": \"50\"\n                    },\n                    \"billingMinutes\": {\n                        \"type\": \"number\"\n                    },\n                    \"billingHours\": {\n                        \"type\": \"number\"\n                    },\n                    \"completed\": {\n                        \"type\": \"string\",\n                        \"enum\": [\n                            \"Yes\",\n                            \"No\"\n                        ],\n                        \"maxLength\": \"3\"\n                    }\n                }\n            }\n        }\n    }\n}\n\n
\n","urlObject":{"path":["report","appointments"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[{"description":{"content":"

Start Date for search. e.g. 2024-01-01

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

End Date for serach. e.g. 2024-01-31

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"}],"variable":[]}},"response":[{"id":"d3e08d98-5e8f-4d66-8fdb-85edfe22c3d4","name":"List Appointments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":{"raw":"{{apiProtocol}}{{apiHost}}/report/appointments?startDate={{startDate}}&endDate={{endDate}}","host":["{{apiProtocol}}{{apiHost}}"],"path":["report","appointments"],"query":[{"key":"startDate","value":"{{startDate}}","description":"Start Date for Report"},{"key":"endDate","value":"{{endDate}}","description":"End Date for Report"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"date","value":"Fri, 31 May 2024 22:45:51 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"965"},{"key":"x-ratelimit-reset","value":"1717200000"},{"key":"x-span","value":"8.3374528"},{"key":"x-trace-id","value":"ffaabfb3-dfeb-4056-81a3-12955456383a"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"appointmentId\": 100245,\n \"clientId\": 3001,\n \"claimId\": null,\n \"appointmentDate\": \"02-14-2024\",\n \"appointmentStart\": \"09:00 AM\",\n \"dateBilled\": null,\n \"appointmentEnd\": \"10:00 AM\",\n \"clientName\": \"Smith, John\",\n \"staffName\": \"Johnson, Emily\",\n \"gender\": \"Male\",\n \"appointmentLocation\": \"456 Elm Street, Springfield, Illinois, 62701\",\n \"patientAddress\": \"456 Elm Street, Springfield, Illinois, 62701\",\n \"insuredId\": \"A123456789\",\n \"office\": \"Springfield Therapy Group\",\n \"renderingProviderNPI\": \"1234567890\",\n \"renderingProvider\": \"Smith, Jane\",\n \"diagnosticCodes\": \"F32.1\",\n \"diagnosticCodes2\": null,\n \"diagnosticCodes3\": null,\n \"payerName\": \"Blue Cross Blue Shield\",\n \"authorizationNumber\": \"12345ABC\",\n \"chargeLineTimeZone\": null,\n \"officeTimeZone\": \"Central Standard Time\",\n \"serviceFacility\": \"Springfield Therapy Group\",\n \"serviceFacilityAddress\": \"789 Pine Road, Springfield, Illinois, 62702\",\n \"clientCity\": \"Springfield\",\n \"billingAddress\": \"789 Pine Road, Springfield, Illinois, 62702\",\n \"canceledType\": \"Client Cancellation\",\n \"serviceName\": \"Therapy Session\",\n \"billingProviderNPI\": \"0987654321\",\n \"billingProvider\": \"Springfield Therapy Group\",\n \"billingCode\": \"90834\",\n \"additionalCode\": null,\n \"modifier\": null,\n \"modifier2\": null,\n \"modifier3\": null,\n \"placeOfService\": 11,\n \"units\": 1,\n \"unitSize\": \"15 Minutes\",\n \"charge\": 150,\n \"chargeRate\": 150,\n \"contractRate\": 145,\n \"contractAmount\": 145,\n \"dob\": \"08-23-1985\",\n \"referringProviderName\": \"Jones, Michael\",\n \"referringProviderNPI\": \"1234509876\",\n \"billingMinutes\": 60,\n \"billingHours\": 1,\n \"completed\": \"Yes\"\n },\n {\n \"appointmentId\": 100246,\n \"clientId\": 3002,\n \"claimId\": null,\n \"appointmentDate\": \"03-22-2024\",\n \"appointmentStart\": \"11:00 AM\",\n \"dateBilled\": null,\n \"appointmentEnd\": \"12:00 PM\",\n \"clientName\": \"Doe, Jane\",\n \"staffName\": \"Brown, Kevin\",\n \"gender\": \"Female\",\n \"appointmentLocation\": \"123 Maple Ave, Denver, Colorado, 80201\",\n \"patientAddress\": \"123 Maple Ave, Denver, Colorado, 80201\",\n \"insuredId\": \"B987654321\",\n \"office\": \"Denver Wellness Center\",\n \"renderingProviderNPI\": \"1122334455\",\n \"renderingProvider\": \"Anderson, Kate\",\n \"diagnosticCodes\": \"F41.1\",\n \"diagnosticCodes2\": null,\n \"diagnosticCodes3\": null,\n \"payerName\": \"United Healthcare\",\n \"authorizationNumber\": \"67890XYZ\",\n \"chargeLineTimeZone\": null,\n \"officeTimeZone\": \"Mountain Standard Time\",\n \"serviceFacility\": \"Denver Wellness Center\",\n \"serviceFacilityAddress\": \"321 Oak Street, Denver, Colorado, 80202\",\n \"clientCity\": \"Denver\",\n \"billingAddress\": \"321 Oak Street, Denver, Colorado, 80202\",\n \"canceledType\": \"No Show\",\n \"serviceName\": \"Consultation\",\n \"billingProviderNPI\": \"2233445566\",\n \"billingProvider\": \"Denver Wellness Center\",\n \"billingCode\": \"99213\",\n \"additionalCode\": null,\n \"modifier\": null,\n \"modifier2\": null,\n \"modifier3\": null,\n \"placeOfService\": 22,\n \"units\": 1,\n \"unitSize\": \"15 Minutes\",\n \"charge\": 200,\n \"chargeRate\": 200,\n \"contractRate\": 195,\n \"contractAmount\": 195,\n \"dob\": \"06-15-1990\",\n \"referringProviderName\": \"Taylor, Sarah\",\n \"referringProviderNPI\": \"3344556677\",\n \"billingMinutes\": 60,\n \"billingHours\": 1,\n \"completed\": \"No\"\n },\n {\n \"appointmentId\": 100247,\n \"clientId\": 3003,\n \"claimId\": null,\n \"appointmentDate\": \"04-05-2024\",\n \"appointmentStart\": \"02:00 PM\",\n \"dateBilled\": null,\n \"appointmentEnd\": \"03:30 PM\",\n \"clientName\": \"Taylor, Alice\",\n \"staffName\": \"Martinez, Carlos\",\n \"gender\": \"Female\",\n \"appointmentLocation\": \"789 Birch Lane, Seattle, Washington, 98101\",\n \"patientAddress\": \"789 Birch Lane, Seattle, Washington, 98101\",\n \"insuredId\": \"C1122334455\",\n \"office\": \"Seattle Health Services\",\n \"renderingProviderNPI\": \"4455667788\",\n \"renderingProvider\": \"Williams, James\",\n \"diagnosticCodes\": \"G47.00\",\n \"diagnosticCodes2\": null,\n \"diagnosticCodes3\": null,\n \"payerName\": \"Aetna\",\n \"authorizationNumber\": \"45678LMN\",\n \"chargeLineTimeZone\": null,\n \"officeTimeZone\": \"Pacific Standard Time\",\n \"serviceFacility\": \"Seattle Health Services\",\n \"serviceFacilityAddress\": \"123 Pine Street, Seattle, Washington, 98102\",\n \"clientCity\": \"Seattle\",\n \"billingAddress\": \"123 Pine Street, Seattle, Washington, 98102\",\n \"canceledType\": \"Staff Cancellation\",\n \"serviceName\": \"Sleep Study\",\n \"billingProviderNPI\": \"5566778899\",\n \"billingProvider\": \"Seattle Health Services\",\n \"billingCode\": \"95806\",\n \"additionalCode\": null,\n \"modifier\": null,\n \"modifier2\": null,\n \"modifier3\": null,\n \"placeOfService\": 21,\n \"units\": 1,\n \"unitSize\": \"15 Minutes\",\n \"charge\": 300,\n \"chargeRate\": 300,\n \"contractRate\": 295,\n \"contractAmount\": 295,\n \"dob\": \"09-12-1978\",\n \"referringProviderName\": \"King, David\",\n \"referringProviderNPI\": \"9988776655\",\n \"billingMinutes\": 90,\n \"billingHours\": 1.5,\n \"completed\": \"Yes\"\n }\n ]\n}"}],"_postman_id":"337fdcec-63b4-44fe-92eb-f2ec723fd562"},{"name":"List Client Authorizations","event":[{"listen":"test","script":{"id":"a1048b13-5e4f-443d-8dd3-9654fd4a1bd5","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let template = `\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r","\r"," {{#each response.data}}\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," {{/each}}\r","
@indexStartDate\r"," EndDateScheduled_AppointmentsCompleted_AppointmentsScheduled_HoursCompleted_HoursRangeType
{{@index }}{{startDate}}{{endDate}}{{scheduledAppointments}}{{completedAppointments}}{{scheduledHours}}{{completedHours}}{{rangeType}}
\r"," `;\r","\r"," pm.visualizer.set(template, {\r"," // Pass the response body parsed as JSON as `data`\r"," response: pm.response.json()\r"," });\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"9ab80283-5022-477b-9eb2-19e753168148","exec":["const moment = require('moment');\r","\r","// Get the beginning of the current month\r","const startOfMonth = moment().startOf('month').format('YYYY-MM-DD');\r","pm.variables.set(\"startDate\", startOfMonth); // Beginning of the Date\r","\r","// Get the end of the current month\r","const endOfMonth = moment().endOf('month').format('YYYY-MM-DD');\r","pm.variables.set(\"endDate\", endOfMonth); // End of the Day"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"a68e165e-1220-4fc5-b980-33f03f7cad31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/client-authorizations?startDate={{startDate}}&endDate={{endDate}}","description":"

The API endpoint retrieves a list of client authorizations within a specified date range. This endpoint offers an overview of client authorizations, detailing the amount of authorization used, the remaining balance, and the quantities that have been scheduled and completed. It helps in managing and monitoring client authorizations effectively.

\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"status\": {\n            \"type\": \"integer\"\n        },\n        \"message\": {\n            \"type\": \"string\"\n        },\n        \"data\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"properties\": {\n                    \"startDate\": {\n                        \"type\": \"string\"\n                    },\n                    \"endDate\": {\n                        \"type\": \"string\"\n                    },\n                    \"scheduledAppointments\": {\n                        \"type\": \"integer\"\n                    },\n                    \"completedAppointments\": {\n                        \"type\": \"integer\"\n                    },\n                    \"scheduledHours\": {\n                        \"type\": \"number\"\n                    },\n                    \"completedHours\": {\n                        \"type\": \"number\"\n                    },\n                    \"rangeType\": {\n                        \"type\": \"string\",\n                        \"note\": \"(It is a system enum so, value will be fixed)\"\n                    }\n                }\n            }\n        }\n    }\n}\n\n
\n","urlObject":{"path":["report","client-authorizations"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[{"description":{"content":"

Start Date for search. e.g. 2024-01-01

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

End Date for serach. e.g. 2024-01-31

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"}],"variable":[]}},"response":[{"id":"03929fbe-d74a-4ed8-9b8b-664044492984","name":"List Client Authorizations","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":{"raw":"{{apiProtocol}}{{apiHost}}/report/client-authorizations?startDate={{startDate}}&endDate={{endDate}}","host":["{{apiProtocol}}{{apiHost}}"],"path":["report","client-authorizations"],"query":[{"key":"startDate","value":"{{startDate}}","description":"Start Date for Report"},{"key":"endDate","value":"{{endDate}}","description":"End Date for Report"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 31 May 2024 22:53:15 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"964"},{"key":"x-ratelimit-reset","value":"1717200000"},{"key":"x-span","value":"4.6884408"},{"key":"x-trace-id","value":"83569794-3a69-45c2-a699-d46a656ba6a1"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"startDate\": \"01-01-2024\",\n \"endDate\": \"03-31-2024\",\n \"scheduledAppointments\": 3330,\n \"completedAppointments\": 1608,\n \"scheduledHours\": 3434.9,\n \"completedHours\": 1698.9,\n \"rangeType\": \"MNTH_RNGTYP\"\n }\n ]\n}"}],"_postman_id":"a68e165e-1220-4fc5-b980-33f03f7cad31"},{"name":"List Billing Ledger","event":[{"listen":"test","script":{"id":"a1048b13-5e4f-443d-8dd3-9654fd4a1bd5","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let template = `\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r","\r"," {{#each response.data}}\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," {{/each}}\r","
No#invoiceIdinvoiceChargeLineIdchargeLineIddateOfServiceclientIdclientNameofficeclientCitybillingCodemodifiersplaceOfServicebilledAmountbilledUnitscontractAmountprimaryPayerprimaryBilledDateprimaryPaymentDateprimaryPaymentprimaryPaymentRefcopaycoinsurancedeductibleprimaryPostedDatesecondaryPayersecondaryBilledDatesecondaryPaymentDatesecondaryPaymentsecondaryPaymentRefsecondaryPostedDatetertiaryPayertertiaryBilledDatetertiaryPaymentDatetertiaryPaymenttertiaryPaymentReftertiaryPostedDateclientBilledDateclientPaymentDateclientPaymentclientPaymentRefclientPostedDateclientBalancepayerBalanceadjustmentsnotesidWithPayerrenderingProvidercontractBalance
{{@index}}{{invoiceId}}{{invoiceChargeLineId}}{{chargeLineId}}{{dateOfService}}{{clientId}}{{clientName}}{{office}}{{clientCity}}{{billingCode}}{{modifiers}}{{placeOfService}}{{billedAmount}}{{billedUnits}}{{contractAmount}}{{primaryPayer}}{{primaryBilledDate}}{{primaryPaymentDate}}{{primaryPayment}}{{primaryPaymentRef}}{{copay}}{{coinsurance}}{{deductible}}{{primaryPostedDate}}{{secondaryPayer}}{{secondaryBilledDate}}{{secondaryPaymentDate}}{{secondaryPayment}}{{secondaryPaymentRef}}{{secondaryPostedDate}}{{tertiaryPayer}}{{tertiaryBilledDate}}{{tertiaryPaymentDate}}{{tertiaryPayment}}{{tertiaryPaymentRef}}{{tertiaryPostedDate}}{{clientBilledDate}}{{clientPaymentDate}}{{clientPayment}}{{clientPaymentRef}}{{clientPostedDate}}{{clientBalance}}{{payerBalance}}{{adjustments}}{{notes}}{{idWithPayer}}{{renderingProvider}}{{contractBalance}}
\r"," `;\r","\r"," pm.visualizer.set(template, {\r"," // Pass the response body parsed as JSON as `data`\r"," response: pm.response.json()\r"," });\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"9ab80283-5022-477b-9eb2-19e753168148","exec":["const moment = require('moment');\r","\r","// Get the beginning of the current month\r","const startOfMonth = moment().startOf('month').add(-1, 'month').format('YYYY-MM-DD');\r","pm.variables.set(\"startDate\", startOfMonth); // Beginning of the Date\r","\r","// Get the end of the current month\r","const endOfMonth = moment().endOf('month').add(-1, 'month').format('YYYY-MM-DD');\r","pm.variables.set(\"endDate\", endOfMonth); // End of the Day"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"dfe78c1f-1dc5-4053-8401-b247de27b0de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/billing-ledger?startDate={{startDate}}&endDate={{endDate}}","description":"

The API endpoint retrieves the Billing Ledger Report within a specified date range. This endpoint generates a summary report of claims paid by payers, including primary and secondary payers. It details co-pays, co-insurance, deductibles, and any adjustments made. The report helps in understanding the financial transactions and adjustments associated with client billing.

\n

Request

\n\n

Response

\n

The response for this request is a JSON object with the following properties:

\n\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n    \"type\": \"object\",\n    \"properties\": {\n        \"invoiceId\": {\n            \"type\": \"integer\"\n        },\n        \"invoiceChargeLineId\": {\n            \"type\": \"integer\"\n        },\n        \"chargeLineId\": {\n            \"type\": \"integer\"\n        },\n        \"dateOfService\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n        },\n        \"clientId\": {\n            \"type\": \"integer\"\n        },\n        \"clientName\": {\n            \"type\": \"string\",\n            \"maxLength\": \"360\"\n        },\n        \"office\": {\n            \"type\": \"string\",\n            \"maxLength\": \"250\"\n        },\n        \"clientCity\": {\n            \"type\": \"string\",\n            \"maxLength\": \"50\"\n        },\n        \"billingCode\": {\n            \"type\": \"string\",\n            \"maxLength\": \"100\"\n        },\n        \"modifiers\": {\n            \"type\": \"string\",\n            \"maxLength\": \"100\"\n        },\n        \"placeOfService\": {\n            \"type\": \"integer\"\n        },\n        \"billedAmount\": {\n            \"type\": \"number\"\n        },\n        \"billedUnits\": {\n            \"type\": \"integer\"\n        },\n        \"contractAmount\": {\n            \"type\": \"number\"\n        },\n        \"primaryPayer\": {\n            \"type\": \"string\",\n            \"maxLength\": \"250\"\n        },\n        \"primaryBilledDate\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n        },\n        \"primaryPaymentDate\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n        },\n        \"primaryPayment\": {\n            \"type\": \"number\"\n        },\n        \"primaryPaymentRef\": {\n            \"type\": \"string\",\n            \"maxLength\": \"100\"\n        },\n        \"copay\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        },\n        \"coinsurance\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        },\n        \"deductible\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        },\n        \"primaryPostedDate\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n        },\n        \"secondaryPayer\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"250\"\n        },\n        \"secondaryBilledDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"secondaryPaymentDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"secondaryPayment\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        },\n        \"secondaryPaymentRef\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"100\"\n        },\n        \"secondaryPostedDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"tertiaryPayer\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"250\"\n        },\n        \"tertiaryBilledDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"tertiaryPaymentDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"tertiaryPayment\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        },\n        \"tertiaryPaymentRef\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"100\"\n        },\n        \"tertiaryPostedDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"clientBilledDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"clientPaymentDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"clientPayment\": {\n            \"type\": \"number\"\n        },\n        \"clientPaymentRef\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"100\"\n        },\n        \"clientPostedDate\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"format\": \"date\"\n        },\n        \"clientBalance\": {\n            \"type\": \"number\"\n        },\n        \"payerBalance\": {\n            \"type\": \"number\"\n        },\n        \"adjustments\": {\n            \"type\": \"number\"\n        },\n        \"notes\": {\n            \"type\": [\n                \"string\",\n                \"null\"\n            ],\n            \"maxLength\": \"1000\"\n        },\n        \"idWithPayer\": {\n            \"type\": \"string\",\n            \"maxLength\": \"50\"\n        },\n        \"renderingProvider\": {\n            \"type\": \"string\",\n            \"maxLength\": \"360\"\n        },\n        \"contractBalance\": {\n            \"type\": [\n                \"number\",\n                \"null\"\n            ]\n        }\n    }\n}\n\n
\n","urlObject":{"path":["report","billing-ledger"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[{"description":{"content":"

Start Date for search. e.g. 2024-01-01

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

End Date for serach. e.g. 2024-01-31

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"}],"variable":[]}},"response":[{"id":"4a8e703f-0261-49bc-8d85-bf3265c3eca3","name":"List Billing Ledger","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":{"raw":"{{apiProtocol}}{{apiHost}}/report/billing-ledger?startDate={{startDate}}&endDate={{endDate}}","host":["{{apiProtocol}}{{apiHost}}"],"path":["report","billing-ledger"],"query":[{"key":"startDate","value":"{{startDate}}","description":"Start Date for Report"},{"key":"endDate","value":"{{endDate}}","description":"End Date for Report"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Fri, 31 May 2024 22:53:37 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"963"},{"key":"x-ratelimit-reset","value":"1717200000"},{"key":"x-span","value":"9.6262351"},{"key":"x-trace-id","value":"445fcc91-3205-49dd-89b4-1b4aea05bf1f"},{"key":"x-subscription-id","value":"f3f4e8a2-098c-401b-bc9f-5c537548b6c9"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"invoiceId\": 90001,\n \"invoiceChargeLineId\": 200001,\n \"chargeLineId\": 200010,\n \"dateOfService\": \"01-02-2024\",\n \"clientId\": 5001,\n \"clientName\": \"Smith, John\",\n \"office\": \"Evergreen Health Services\",\n \"clientCity\": \"Dallas\",\n \"billingCode\": \"H2019\",\n \"modifiers\": \"HN\",\n \"placeOfService\": 11,\n \"billedAmount\": 125.75,\n \"billedUnits\": 7,\n \"contractAmount\": 175.50,\n \"primaryPayer\": \"Aetna Health\",\n \"primaryBilledDate\": \"01-12-2024\",\n \"primaryPaymentDate\": \"01-20-2024\",\n \"primaryPayment\": 125.75,\n \"primaryPaymentRef\": \"1010101010\",\n \"copay\": null,\n \"coinsurance\": null,\n \"deductible\": null,\n \"primaryPostedDate\": \"01-21-2024\",\n \"secondaryPayer\": null,\n \"secondaryBilledDate\": null,\n \"secondaryPaymentDate\": null,\n \"secondaryPayment\": null,\n \"secondaryPaymentRef\": null,\n \"secondaryPostedDate\": null,\n \"tertiaryPayer\": null,\n \"tertiaryBilledDate\": null,\n \"tertiaryPaymentDate\": null,\n \"tertiaryPayment\": null,\n \"tertiaryPaymentRef\": null,\n \"tertiaryPostedDate\": null,\n \"clientBilledDate\": null,\n \"clientPaymentDate\": null,\n \"clientPayment\": 0,\n \"clientPaymentRef\": null,\n \"clientPostedDate\": null,\n \"clientBalance\": 0,\n \"payerBalance\": 0,\n \"adjustments\": 0,\n \"notes\": null,\n \"idWithPayer\": \"A123456789\",\n \"renderingProvider\": \"Doe, Jane\",\n \"contractBalance\": null\n },\n {\n \"invoiceId\": 90002,\n \"invoiceChargeLineId\": 200002,\n \"chargeLineId\": 200011,\n \"dateOfService\": \"01-03-2024\",\n \"clientId\": 5002,\n \"clientName\": \"Doe, Emily\",\n \"office\": \"Evergreen Health Services\",\n \"clientCity\": \"Houston\",\n \"billingCode\": \"H2014\",\n \"modifiers\": \"HO\",\n \"placeOfService\": 12,\n \"billedAmount\": 98.50,\n \"billedUnits\": 5,\n \"contractAmount\": 150.00,\n \"primaryPayer\": \"United Healthcare\",\n \"primaryBilledDate\": \"01-12-2024\",\n \"primaryPaymentDate\": \"01-18-2024\",\n \"primaryPayment\": 98.50,\n \"primaryPaymentRef\": \"2020202020\",\n \"copay\": null,\n \"coinsurance\": null,\n \"deductible\": null,\n \"primaryPostedDate\": \"01-19-2024\",\n \"secondaryPayer\": null,\n \"secondaryBilledDate\": null,\n \"secondaryPaymentDate\": null,\n \"secondaryPayment\": null,\n \"secondaryPaymentRef\": null,\n \"secondaryPostedDate\": null,\n \"tertiaryPayer\": null,\n \"tertiaryBilledDate\": null,\n \"tertiaryPaymentDate\": null,\n \"tertiaryPayment\": null,\n \"tertiaryPaymentRef\": null,\n \"tertiaryPostedDate\": null,\n \"clientBilledDate\": null,\n \"clientPaymentDate\": null,\n \"clientPayment\": 0,\n \"clientPaymentRef\": null,\n \"clientPostedDate\": null,\n \"clientBalance\": 0,\n \"payerBalance\": 0,\n \"adjustments\": 0,\n \"notes\": null,\n \"idWithPayer\": \"B987654321\",\n \"renderingProvider\": \"Smith, John\",\n \"contractBalance\": null\n },\n {\n \"invoiceId\": 90003,\n \"invoiceChargeLineId\": 200003,\n \"chargeLineId\": 200012,\n \"dateOfService\": \"01-04-2024\",\n \"clientId\": 5003,\n \"clientName\": \"Johnson, Michael\",\n \"office\": \"Evergreen Health Services\",\n \"clientCity\": \"Austin\",\n \"billingCode\": \"97153\",\n \"modifiers\": \"HM\",\n \"placeOfService\": 12,\n \"billedAmount\": 140.00,\n \"billedUnits\": 10,\n \"contractAmount\": 140.00,\n \"primaryPayer\": \"Blue Cross Blue Shield\",\n \"primaryBilledDate\": \"01-13-2024\",\n \"primaryPaymentDate\": \"01-20-2024\",\n \"primaryPayment\": 140.00,\n \"primaryPaymentRef\": \"3030303030\",\n \"copay\": null,\n \"coinsurance\": null,\n \"deductible\": null,\n \"primaryPostedDate\": \"01-21-2024\",\n \"secondaryPayer\": null,\n \"secondaryBilledDate\": null,\n \"secondaryPaymentDate\": null,\n \"secondaryPayment\": null,\n \"secondaryPaymentRef\": null,\n \"secondaryPostedDate\": null,\n \"tertiaryPayer\": null,\n \"tertiaryBilledDate\": null,\n \"tertiaryPaymentDate\": null,\n \"tertiaryPayment\": null,\n \"tertiaryPaymentRef\": null,\n \"tertiaryPostedDate\": null,\n \"clientBilledDate\": null,\n \"clientPaymentDate\": null,\n \"clientPayment\": 0,\n \"clientPaymentRef\": null,\n \"clientPostedDate\": null,\n \"clientBalance\": 0,\n \"payerBalance\": 0,\n \"adjustments\": 0,\n \"notes\": null,\n \"idWithPayer\": \"C1122334455\",\n \"renderingProvider\": \"Brown, Emily\",\n \"contractBalance\": null\n },\n {\n \"invoiceId\": 90004,\n \"invoiceChargeLineId\": 200004,\n \"chargeLineId\": 200013,\n \"dateOfService\": \"01-05-2024\",\n \"clientId\": 5004,\n \"clientName\": \"Martinez, Isabella\",\n \"office\": \"Evergreen Health Services\",\n \"clientCity\": \"San Antonio\",\n \"billingCode\": \"S5111\",\n \"modifiers\": \"\",\n \"placeOfService\": 12,\n \"billedAmount\": 112.25,\n \"billedUnits\": 8,\n \"contractAmount\": 160.00,\n \"primaryPayer\": \"Cigna\",\n \"primaryBilledDate\": \"01-14-2024\",\n \"primaryPaymentDate\": \"01-21-2024\",\n \"primaryPayment\": 112.25,\n \"primaryPaymentRef\": \"4040404040\",\n \"copay\": null,\n \"coinsurance\": null,\n \"deductible\": null,\n \"primaryPostedDate\": \"01-22-2024\",\n \"secondaryPayer\": null,\n \"secondaryBilledDate\": null,\n \"secondaryPaymentDate\": null,\n \"secondaryPayment\": null,\n \"secondaryPaymentRef\": null,\n \"secondaryPostedDate\": null,\n \"tertiaryPayer\": null,\n \"tertiaryBilledDate\": null,\n \"tertiaryPaymentDate\": null,\n \"tertiaryPayment\": null,\n \"tertiaryPaymentRef\": null,\n \"tertiaryPostedDate\": null,\n \"clientBilledDate\": null,\n \"clientPaymentDate\": null,\n \"clientPayment\": 0,\n \"clientPaymentRef\": null,\n \"clientPostedDate\": null,\n \"clientBalance\": 0,\n \"payerBalance\": 0,\n \"adjustments\": 0,\n \"notes\": null,\n \"idWithPayer\": \"D2233445566\",\n \"renderingProvider\": \"Garcia, Maria\",\n \"contractBalance\": null\n },\n {\n \"invoiceId\": 90005,\n \"invoiceChargeLineId\": 200005,\n \"chargeLineId\": 200014,\n \"dateOfService\": \"01-06-2024\",\n \"clientId\": 5005,\n \"clientName\": \"Anderson, Sophia\",\n \"office\": \"Evergreen Health Services\",\n \"clientCity\": \"Fort Worth\",\n \"billingCode\": \"S5110\",\n \"modifiers\": \"HN\",\n \"placeOfService\": 12,\n \"billedAmount\": 89.75,\n \"billedUnits\": 5,\n \"contractAmount\": 125.00,\n \"primaryPayer\": \"Humana\",\n \"primaryBilledDate\": \"01-15-2024\",\n \"primaryPaymentDate\": \"01-22-2024\",\n \"primaryPayment\": 89.75,\n \"primaryPaymentRef\": \"5050505050\",\n \"copay\": null,\n \"coinsurance\": null,\n \"deductible\": null,\n \"primaryPostedDate\": \"01-23-2024\",\n \"secondaryPayer\": null,\n \"secondaryBilledDate\": null,\n \"secondaryPaymentDate\": null,\n \"secondaryPayment\": null,\n \"secondaryPaymentRef\": null,\n \"secondaryPostedDate\": null,\n \"tertiaryPayer\": null,\n \"tertiaryBilledDate\": null,\n \"tertiaryPaymentDate\": null,\n \"tertiaryPayment\": null,\n \"tertiaryPaymentRef\": null,\n \"tertiaryPostedDate\": null,\n \"clientBilledDate\": null,\n \"clientPaymentDate\": null,\n \"clientPayment\": 0,\n \"clientPaymentRef\": null,\n \"clientPostedDate\": null,\n \"clientBalance\": 0,\n \"payerBalance\": 0,\n \"adjustments\": 0,\n \"notes\": null,\n \"idWithPayer\": \"E3344556677\",\n \"renderingProvider\": \"Thompson, James\",\n \"contractBalance\": null\n }\n ]\n}"}],"_postman_id":"dfe78c1f-1dc5-4053-8401-b247de27b0de"},{"name":"Authorizations Without Appointments","event":[{"listen":"test","script":{"id":"a1048b13-5e4f-443d-8dd3-9654fd4a1bd5","exec":["// Unit Test #1\r","pm.test('Response Status code is 200', function () {\r"," pm.response.to.have.status(200);\r","\r"," // If status is 200, continue with additional tests and visualizations if any!\r"," if (pm.response.code === 200) {\r","\r"," // Unit Test #2\r"," pm.test('Response content type is application/json', function () {\r"," pm.expect(pm.response.headers.get('Content-Type')).to.include('application/json');\r","\r"," // If the content type is JSON, proceed to check if it contains the data property\r"," if (pm.response.headers.get('Content-Type').includes('application/json')) {\r","\r"," // Unit Test #3\r"," pm.test('Response contains a data property', function () {\r"," let jsonData = pm.response.json();\r"," pm.expect(jsonData).to.have.property('data');\r","\r"," // If the data property exists, set the access_token and refresh_token\r"," if (jsonData.hasOwnProperty('data')) {\r"," let template = `\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r","\r"," {{#each response.data}}\r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," \r"," {{/each}}\r","
@indexClient IDPayer IDAuthorizationGroupService IDOffice\r"," Client NamePayer NameID with PayerAuthorization NumberReferring ProviderService NameAllowed Limit\r"," TypeFrequencyStart DateEnd DateStart Date 1End Date 1Rendering ProviderPlace of ServiceService FacilityDiagnostic Codes 1Diagnostic Codes 2Diagnostic Codes 3
{{@index }}{{client_Id}}{{payer_Id}}{{authorizationGroupService_Id}}{{office}}{{client_Name}}{{payer_Name}}{{iD_with_Payer}}{{authorization_Number}}{{referring_Provider}}{{service_Name}}{{allowed_Limit}}{{type}}{{frequency}}{{startDate}}{{endDate}}{{start_Date1}}{{end_Date1}}{{rendering_Provider}}{{placeOfService}}{{service_Facility}}{{diagnostic_Codes}}{{diagnostic_Codes2}}{{diagnostic_Codes3}}
\r"," `;\r","\r"," pm.visualizer.set(template, {\r"," // Pass the response body parsed as JSON as `data`\r"," response: pm.response.json()\r"," });\r"," }\r"," });\r"," }\r"," });\r"," }\r","});"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"prerequest","script":{"id":"9ab80283-5022-477b-9eb2-19e753168148","exec":["const moment = require('moment');\r","\r","// Get the beginning of the current month\r","const startOfMonth = moment().startOf('month').format('YYYY-MM-DD');\r","pm.variables.set(\"startDate\", startOfMonth); // Beginning of the Date\r","\r","// Get the end of the current month\r","const endOfMonth = moment().endOf('month').format('YYYY-MM-DD');\r","pm.variables.set(\"endDate\", endOfMonth); // End of the Day"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"0e5766c3-1411-42de-812f-cb88b5d63f23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":"{{apiProtocol}}{{apiHost}}/report/authorizations-without-appointments?startDate={{startDate}}&endDate={{endDate}}","description":"

The API endpoint retrieves a list of client authorizations without appointments within a specified date range. It helps in managing and monitoring client authorizations effectively.

\n

The response for this request can be documented as a JSON schema as follows:

\n
{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"integer\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"office\": {\n            \"type\": \"string\"\n          },\n          \"client_Name\": {\n            \"type\": \"string\"\n          },\n          \"payer_Name\": {\n            \"type\": \"string\"\n          },\n          \"iD_with_Payer\": {\n            \"type\": \"string\"\n          },\n          \"authorization_Number\": {\n            \"type\": \"string\"\n          },\n          \"referring_Provider\": {\n            \"type\": \"string\"\n          },\n          \"service_Name\": {\n            \"type\": \"string\"\n          },\n          \"allowed_Limit\": {\n            \"type\": \"integer\"\n          },\n          \"type\": {\n            \"type\": \"string\"\n          },\n          \"frequency\": {\n            \"type\": \"string\"\n          },\n          \"startDate\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n          },\n          \"endDate\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n          },\n          \"start_Date1\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n          },\n          \"end_Date1\": {\n            \"type\": \"string\",\n            \"format\": \"date\"\n          },\n          \"rendering_Provider\": {\n            \"type\": \"string\"\n          },\n          \"placeOfService\": {\n            \"type\": \"string\"\n          },\n          \"service_Facility\": {\n            \"type\": \"string\"\n          },\n          \"diagnostic_Codes\": {\n            \"type\": \"string\"\n          },\n          \"diagnostic_Codes2\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"diagnostic_Codes3\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"client_Id\": {\n            \"type\": \"integer\"\n          },\n          \"payer_Id\": {\n            \"type\": \"integer\"\n          },\n          \"authorizationGroupService_Id\": {\n            \"type\": \"integer\"\n          }\n        },\n        \"required\": [\n          \"office\",\n          \"client_Name\",\n          \"payer_Name\",\n          \"iD_with_Payer\",\n          \"authorization_Number\",\n          \"referring_Provider\",\n          \"service_Name\",\n          \"allowed_Limit\",\n          \"type\",\n          \"frequency\",\n          \"startDate\",\n          \"endDate\",\n          \"start_Date1\",\n          \"end_Date1\",\n          \"rendering_Provider\",\n          \"placeOfService\",\n          \"service_Facility\",\n          \"diagnostic_Codes\",\n          \"client_Id\",\n          \"payer_Id\",\n          \"authorizationGroupService_Id\"\n        ]\n      }\n    }\n  },\n  \"required\": [\"status\", \"message\", \"data\"]\n}\n\n
\n","urlObject":{"path":["report","authorizations-without-appointments"],"host":["{{apiProtocol}}{{apiHost}}"],"query":[{"description":{"content":"

Start Date for search. e.g. 2024-01-01

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

End Date for serach. e.g. 2024-01-31

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"}],"variable":[]}},"response":[{"id":"0d2a644d-a54f-4fec-a2da-3550fe82dd92","name":"Authorizations Without Appointments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer "}],"url":{"raw":"{{apiProtocol}}{{apiHost}}/report/authorizations-without-appointments?startDate={{startDate}}&endDate={{endDate}}","host":["{{apiProtocol}}{{apiHost}}"],"path":["report","authorizations-without-appointments"],"query":[{"key":"startDate","value":"{{startDate}}","description":"Start Date for search. e.g. 2024-01-01"},{"key":"endDate","value":"{{endDate}}","description":"End Date for serach. e.g. 2024-01-31"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"date","value":"Wed, 22 Jan 2025 23:58:06 GMT"},{"key":"transfer-encoding","value":"chunked"},{"key":"x-cache","value":"false"},{"key":"x-ratelimit-limit","value":"1000"},{"key":"x-ratelimit-remaining","value":"974"},{"key":"x-ratelimit-reset","value":"1737590400"},{"key":"x-span","value":"0.1082183"},{"key":"x-trace-id","value":"9128c258-52c7-41ca-a836-bf76286e57f7"},{"key":"x-subscription-id","value":"5ebd88b4-815e-4048-a2a0-88c9b184de09"},{"key":"x-via-backend","value":"be_aloha_customerapi_prod"},{"key":"x-via-lb","value":"lb-aloha-customerapi-prod"},{"key":"x-frame-options","value":"sameorigin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubdomains; preload"},{"key":"content-security-policy","value":"frame-ancestors self; report-uri /cspvr"},{"key":"referrer-policy","value":"no-referrer-when-downgrade"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"permissions-policy","value":"accelerometer=(), camera=(), geolocation=(self), gyroscope=(), magnetometer=(), microphone=(), payment=(), usb=()"},{"key":"vary","value":"Accept-Encoding"},{"key":"content-encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"data\": [\n {\n \"office\": \"Sample Office (XYZ 1001)\",\n \"client_Name\": \"Doe, John\",\n \"payer_Name\": \"Sample Insurance\",\n \"iD_with_Payer\": \"XXXXXX001\",\n \"authorization_Number\": \"AUTH-1234-5678\",\n \"referring_Provider\": \"\",\n \"service_Name\": \"Sample Assessment by BCBA (97151)\",\n \"allowed_Limit\": 32,\n \"type\": \"Units\",\n \"frequency\": \"Authorization\",\n \"startDate\": \"2024-10-26T00:00:00Z\",\n \"endDate\": \"2025-04-26T00:00:00Z\",\n \"start_Date1\": \"10-26-2024\",\n \"end_Date1\": \"04-26-2025\",\n \"rendering_Provider\": \"Smith, Jane\",\n \"placeOfService\": \"12 - Home\",\n \"service_Facility\": \"Sample Office (XYZ 1001)\",\n \"diagnostic_Codes\": \"FXX.X\",\n \"diagnostic_Codes2\": null,\n \"diagnostic_Codes3\": null,\n \"client_Id\": 10001,\n \"payer_Id\": 20001,\n \"authorizationGroupService_Id\": 0\n },\n {\n \"office\": \"Sample Office (XYZ 1001)\",\n \"client_Name\": \"Roe, Richard\",\n \"payer_Name\": \"Test Health Plan\",\n \"iD_with_Payer\": \"ZZZZZZ002\",\n \"authorization_Number\": \"AUTH-2345-6789\",\n \"referring_Provider\": \"\",\n \"service_Name\": \"Family Guidance by BCBA (97156)\",\n \"allowed_Limit\": 104,\n \"type\": \"Units\",\n \"frequency\": \"Authorization\",\n \"startDate\": \"2024-12-23T00:00:00Z\",\n \"endDate\": \"2025-06-23T00:00:00Z\",\n \"start_Date1\": \"12-23-2024\",\n \"end_Date1\": \"06-23-2025\",\n \"rendering_Provider\": \"Smith, Jane\",\n \"placeOfService\": \"12 - Home\",\n \"service_Facility\": \"Sample Office (XYZ 1001)\",\n \"diagnostic_Codes\": \"FXX.X\",\n \"diagnostic_Codes2\": null,\n \"diagnostic_Codes3\": null,\n \"client_Id\": 10002,\n \"payer_Id\": 20002,\n \"authorizationGroupService_Id\": 0\n },\n {\n \"office\": \"Sample Office (XYZ 1001)\",\n \"client_Name\": \"Roe, Richard\",\n \"payer_Name\": \"Test Health Plan\",\n \"iD_with_Payer\": \"ZZZZZZ002\",\n \"authorization_Number\": \"AUTH-2345-6789\",\n \"referring_Provider\": \"\",\n \"service_Name\": \"Sample Assessment by BCBA (97151)\",\n \"allowed_Limit\": 32,\n \"type\": \"Units\",\n \"frequency\": \"Authorization\",\n \"startDate\": \"2024-12-23T00:00:00Z\",\n \"endDate\": \"2025-06-23T00:00:00Z\",\n \"start_Date1\": \"12-23-2024\",\n \"end_Date1\": \"06-23-2025\",\n \"rendering_Provider\": \"Smith, Jane\",\n \"placeOfService\": \"12 - Home\",\n \"service_Facility\": \"Sample Office (XYZ 1001)\",\n \"diagnostic_Codes\": \"FXX.X\",\n \"diagnostic_Codes2\": null,\n \"diagnostic_Codes3\": null,\n \"client_Id\": 10002,\n \"payer_Id\": 20002,\n \"authorizationGroupService_Id\": 0\n }\n ]\n}"}],"_postman_id":"0e5766c3-1411-42de-812f-cb88b5d63f23"}],"id":"297d1c4c-67f4-4953-a6b0-18fcfa1860fe","event":[{"listen":"prerequest","script":{"id":"d293f524-792f-4d47-bf68-01f7f7d1ccb6","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"873b09bf-bfb0-4b75-98cc-9a6125c4774a","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"297d1c4c-67f4-4953-a6b0-18fcfa1860fe","description":""}],"event":[{"listen":"prerequest","script":{"id":"f62bbd63-7a85-4f79-bcee-9275738192f4","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"fff7a733-7189-4beb-ac62-b17b25718ac9","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"access_token","value":""},{"key":"refresh_token","value":""}]}