PtEverywhere OpenAPI

https://openapi.pteverywhere.com/api/v2
Admin
PtEverywhere OpenAPI provides functionalities for authentication, reporting, master data management,...
Tokens:8,718
Snippets:32
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### GET /appointment/available-blocks

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieve available appointment blocks for a given date range and therapist.

```APIDOC
## GET /appointment/available-blocks

### Description
Get available block appointments for a specified date range and therapist.

### Method
GET

### Endpoint
/appointment/available-blocks

### Parameters
#### Query Parameters
- **startDate** (string) - Required - The start date for the availability search (e.g., "2024-01-01").
- **endDate** (string) - Required - The end date for the availability search (e.g., "2024-01-08").
- **therapist** (string) - Required - The ID of the therapist to check availability for (e.g., "5ef1b527c4419d4c9f4fb6ef").

### Response
#### Success Response (200)
- (object) - Contains the available appointment blocks.

#### Response Example
{
  "example": "{\n  \"availableBlocks\": [\n    {\n      \"startTime\": \"2024-01-01T09:00:00Z\",\n      \"endTime\": \"2024-01-01T10:00:00Z\"\n    }\n  ]\n}"
}
```

--------------------------------

### Get Usage Details

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves the usage details for services. This endpoint requires an access token for authentication.

```APIDOC
## GET /usage

### Description
Retrieves the usage details for services, including total and used amounts for each service.

### Method
GET

### Endpoint
/usage

### Parameters
#### Query Parameters
- **service** (string) - Optional - Filter usage by a specific service.

### Request Example
```http
GET /usage?service=example_service HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
```

### Response
#### Success Response (200)
- **detail** (array) - An array of objects, where each object contains:
  - **service** (string) - The name of the service.
  - **total** (number) - The total allocated amount for the service.
  - **used** (number) - The amount of the service that has been used.

#### Response Example
```json
{
  "detail": [
    {
      "service": "example_service",
      "total": 1000,
      "used": 500
    }
  ]
}
```

#### Error Responses
- **400** - Bad request.
- **401** - Unauthorized.
- **403** - You do not have permission to access the API.
- **404** - Not found.
- **500** - Internal server error.
```

--------------------------------

### GET /masterdata/therapists

Source: https://openapi.pteverywhere.com/api/v2/swagger

List all therapist in your clinic that match searching criteria. You can filter by name and use pagination.

```APIDOC
## GET /masterdata/therapists

### Description
List all therapist in your clinic that match searching criteria. Leaving the name parameter blank will result in a full list returned.

### Method
GET

### Endpoint
/masterdata/therapists

### Parameters
#### Query Parameters
- **name** (string) - Optional - A part or the entire User name you are searching for.
- **pagination** (object) - Optional - Pagination parameters.

### Response
#### Success Response (200)
- (array of objects) - A list of clinic user responses.

#### Response Example
{
  "example": "[ \n  { \n    \"_id\": \"60f3b3b3b3b3b3b3b3b3b3b3\", \n    \"name\": \"John Doe\", \n    \"email\": \"john.doe@example.com\" \n  } \n]"
}
```

--------------------------------

### Get Appointments

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of appointments with detailed information including patient, provider, service, location, and invoice status. Supports filtering and sorting.

```APIDOC
## GET /appointments

### Description
Retrieves a list of appointments. This endpoint allows fetching detailed information about appointments, including associated patient, provider, service, location, and invoice details. It supports filtering by various criteria and sorting the results.

### Method
GET

### Endpoint
/appointments

### Parameters
#### Query Parameters
- **patientId** (string) - Optional - Filter appointments by patient ID.
- **providerId** (string) - Optional - Filter appointments by provider ID.
- **locationId** (string) - Optional - Filter appointments by location ID.
- **dateOfService** (string) - Optional - Filter appointments by date of service (YYYY-MM-DD).
- **appointmentStatus** (string) - Optional - Filter appointments by status (e.g., 'Scheduled', 'Completed', 'Cancelled').
- **sortBy** (string) - Optional - Field to sort the results by (e.g., 'dateOfService', 'patient.fullName').
- **sortOrder** (string) - Optional - Order of sorting ('asc' or 'desc').

### Response
#### Success Response (200)
- **docs** (array) - An array of appointment objects. Each object contains:
  - **_id** (string) - Appointment ID.
  - **patient** (object) - Patient's information:
    - **_id** (string) - Patient ID.
    - **fullName** (string) - Patient name.
    - **firstName** (string) - Patient's first name.
    - **lastName** (string) - Patient's last name.
    - **email** (string) - Patient's email.
    - **patientCode** (string) - Patient Code.
    - **totalAppointmentVisit** (number) - Total number of appointments for the patient.
  - **dateOfService** (string) - Date of Service.
  - **appointmentStatus** (string) - Appointment Status.
  - **provider** (object) - Provider's information (referencing schema).
  - **service** (object) - Service information (referencing schema).
  - **location** (object) - Location information (referencing schema).
  - **invoice** (object) - Invoice information:
    - **invoiceStatus** (string) - Invoice status (paid, unpaid, or partlypaid).
    - **invoiceNo** (string) - The unique code of the invoice.
    - **currentResponsibility** (string) - The responsibilities of the invoice.
    - **packageInvoiceNumber** (string) - Invoice Package Number.
    - **packageInvoiceName** (string) - Invoice Package Name.
  - **claimCreatedInfo** (string) - Indicates if the claim has been created.
  - **charges** (number) - Charges amount of the invoice.
  - **payments** (number) - Payment amount of the invoice.
  - **units** (number) - CPT units of the invoice.
  - **createdBy** (number) - The creator of the invoice.
  - **reason** (string) - Reason value.
  - **lastUpdateBy** (string) - User who last updated the record.
  - **lastUpdateDate** (string) - Date of the last update.
  - **cancellationNotice** (string) - Notice regarding cancellation.

#### Response Example
{
  "docs": [
    {
      "_id": "appt123",
      "patient": {
        "_id": "pat456",
        "fullName": "John Doe",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "patientCode": "P1001",
        "totalAppointmentVisit": 5
      },
      "dateOfService": "2023-10-27",
      "appointmentStatus": "Completed",
      "provider": {
        "_id": "prov789",
        "fullName": "Dr. Jane Smith"
      },
      "service": {
        "_id": "srv012",
        "name": "General Checkup"
      },
      "location": {
        "_id": "loc345",
        "name": "Downtown Clinic"
      },
      "invoice": {
        "invoiceStatus": "paid",
        "invoiceNo": "INV-001",
        "currentResponsibility": "Patient",
        "packageInvoiceNumber": null,
        "packageInvoiceName": null
      },
      "claimCreatedInfo": "true",
      "charges": 150.00,
      "payments": 150.00,
      "units": 1,
      "createdBy": 101,
      "reason": "Routine checkup",
      "lastUpdateBy": "admin",
      "lastUpdateDate": "2023-10-27T10:00:00Z",
      "cancellationNotice": null
    }
  ]
}
```

--------------------------------

### Appointment Available Block Request

Source: https://openapi.pteverywhere.com/api/v2/swagger

This endpoint allows you to find available appointment blocks for a specific therapist within a given date range. It requires the start and end dates of the search range, and the therapist's ID.

```APIDOC
## POST /appointments/available-blocks

### Description
Find available appointment blocks for a therapist within a specified date range.

### Method
POST

### Endpoint
/appointments/available-blocks

### Parameters
#### Request Body
- **startDate** (string) - Required - Start date (DOS) of the finding range in your clinic time zone. Example: "2024-01-01"
- **endDate** (string) - Required - End date (DOS) of the finding range in your clinic time zone. Example: "2024-01-08"
- **therapist** (string) - Required - The ID of the therapist. Example: "600902030b0e1745d02e097d"

### Request Example
{
  "startDate": "2024-01-01",
  "endDate": "2024-01-08",
  "therapist": "600902030b0e1745d02e097d"
}

### Response
#### Success Response (200)
- **docs** (array) - An array of available appointment blocks.
  - **startDateTime** (string) - The start date and time of the available block.
  - **endDateTime** (string) - The end date and time of the available block.
  - **location** (object) - Details of the appointment location.
  - **service** (object) - Details of the service offered.

#### Response Example
{
  "docs": [
    {
      "startDateTime": "2024-01-05T09:00:00Z",
      "endDateTime": "2024-01-05T10:00:00Z",
      "location": { ... },
      "service": { ... }
    }
  ]
}
```

--------------------------------

### Get Patient Report

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a report of patients based on specified criteria. This endpoint allows filtering by date ranges, locations, and provider involvement.

```APIDOC
## GET /api/patients/report

### Description
Retrieves a report of patients based on specified criteria. This endpoint allows filtering by date ranges, locations, and provider involvement.

### Method
GET

### Endpoint
/api/patients/report

### Parameters
#### Query Parameters
- **startDate** (string) - Optional - Start date for filtering findings.
- **endDate** (string) - Optional - End date for filtering findings.
- **locations** (array of strings) - Optional - Location IDs to filter by.
- **createdBy** (array of strings) - Optional - Provider IDs who created the patient.
- **firstSeenBy** (array of strings) - Optional - Provider IDs who first saw the patient.
- **lastSeenBy** (array of strings) - Optional - Provider IDs who last saw the patient.
- **accountAccess** (array of strings) - Optional - Filter by patient account access status (e.g., "LoggedIn", "PendingFirstLogin").
- **hasAppointments** (array of strings) - Optional - Filter by whether the patient has scheduled appointments ('Y' or 'N').
- **patientStatus** (array of strings) - Optional - Filter by patient account activation status ('Y' or 'N').

### Response
#### Success Response (200)
- **patientName** (string) - The name of the patient.
- **patientId** (string) - The unique identifier for the patient.
- **email** (string) - The email address of the patient.
- **phone** (string) - The phone number of the patient.
- **registrationDateStr** (string) - The patient's registration date.
- **registrationBy** (string) - The provider who registered the patient.
- **firstLoginDateStr** (string) - The date of the patient's first login.
- **lastLoginDateStr** (string) - The date of the patient's last login.
- **totalLastLogins** (number) - The total number of times the patient has logged in.
- **firstAppointment** (object) - Details about the patient's first appointment.
  - **_id** (string) - The ID of the first appointment.
  - **startDate** (string) - The start date of the first appointment.
- **lastAppointment** (object) - Details about the patient's last appointment.
  - **_id** (string) - The ID of the last appointment.
  - **startDate** (string) - The start date of the last appointment.
- **nextAppointment** (object) - Details about the patient's next appointment.
  - **_id** (string) - The ID of the next appointment.
  - **startDate** (string) - The start date of the next appointment.
- **lastTherapist** (object) - Details about the patient's last therapist.
  - **_id** (string) - The ID of the therapist.
  - **name** (string) - The name of the therapist.
  - **email** (string) - The email of the therapist.
- **packageMembership** (object) - Information about the patient's package membership.
- **firstAppointmentLocation** (string) - The location of the patient's first appointment.
- **firstSeenBy** (string) - The provider who first saw the patient.
- **lastSeenBy** (string) - The provider who last saw the patient.

### Request Example
```json
{
  "startDate": "2023-09-01",
  "endDate": "2023-09-05",
  "locations": ["loc_123"],
  "createdBy": ["prov_abc"],
  "firstSeenBy": ["prov_xyz"],
  "lastSeenBy": ["prov_pqr"],
  "accountAccess": ["LoggedIn"],
  "hasAppointments": ["Y"],
  "patientStatus": ["Y"]
}
```

### Response Example
```json
{
  "patientName": "John Doe",
  "patientId": "pat_789",
  "email": "john.doe@example.com",
  "phone": "123-456-7890",
  "registrationDateStr": "2023-01-15",
  "registrationBy": "Dr. Smith",
  "firstLoginDateStr": "2023-01-16",
  "lastLoginDateStr": "2023-09-01",
  "totalLastLogins": 15,
  "firstAppointment": {
    "_id": "appt_001",
    "startDate": "2023-02-01T10:00:00Z"
  },
  "lastAppointment": {
    "_id": "appt_050",
    "startDate": "2023-08-15T14:30:00Z"
  },
  "nextAppointment": {
    "_id": "appt_055",
    "startDate": "2023-09-10T11:00:00Z"
  },
  "lastTherapist": {
    "_id": "ther_456",
    "name": "Dr. Emily White",
    "email": "emily.white@example.com"
  },
  "packageMembership": {
    "packageName": "Standard Package",
    "expiryDate": "2024-12-31"
  },
  "firstAppointmentLocation": "Main Clinic",
  "firstSeenBy": "Dr. Emily White",
  "lastSeenBy": "Dr. Emily White"
}
```
```

--------------------------------

### POST /appointment/create

Source: https://openapi.pteverywhere.com/api/v2/swagger

Create a new appointment.

```APIDOC
## POST /appointment/create

### Description
Create Appointment.

### Method
POST

### Endpoint
/appointment/create

### Response
#### Success Response (200)
- (object) - Confirmation of appointment creation.

#### Response Example
{
  "example": "{\n  \"message\": \"Appointment created successfully\",\n  \"appointmentId\": \"60f3b3b3b3b3b3b3b3b3b3b3\"\n}"
}
```

--------------------------------

### CreateAppointment

Source: https://openapi.pteverywhere.com/api/v2/swagger

Creates a new appointment. This operation allows for the creation of appointments with specified details.

```APIDOC
## POST /appointments

### Description
Creates a new appointment.

### Method
POST

### Endpoint
/appointments

### Request Body
- **appointment** (AppointmentCreateRequest) - Required - Details for creating the appointment.

### Request Example
```json
{
  "appointment": {
    "patientId": "string",
    "providerId": "string",
    "locationId": "string",
    "startTime": "string",
    "endTime": "string",
    "notes": "string"
  }
}
```

### Response
#### Success Response (200)
- **appointment** (AppointmentCreateResponse) - Details of the created appointment.

#### Response Example
```json
{
  "appointment": {
    "id": "string",
    "patientId": "string",
    "providerId": "string",
    "locationId": "string",
    "startTime": "string",
    "endTime": "string",
    "status": "string"
  }
}
```
```

--------------------------------

### List Packages, Memberships & Clinic Credits

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of packages, memberships, and clinic credits, with optional filtering by name and pagination.

```APIDOC
## GET /masterdata/packages-memberships

### Description
List all Packages, Memberships & Clinic Credits in your clinic that match searching criteria.

### Method
GET

### Endpoint
/masterdata/packages-memberships

### Parameters
#### Query Parameters
- **name** (string) - Optional - A part or the entire Package, Membership or Clinic Credit name you are searching for. Leaving it blank will result in a full list returned.
- **pagination** (object) - Optional - Pagination parameters for the request.

### Response
#### Success Response (200)
- **items** (array of packageMembershipCredit objects) - A list of package, membership, or credit objects.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"pkg_xyz\",\n    \"name\": \"Gold Membership\",\n    \"description\": \"Access to premium services.\",\n    \"price\": 100.00,\n    \"currency\": \"USD\"\n  }\n]"
}
```

--------------------------------

### POST /report/general-visit

Source: https://openapi.pteverywhere.com/api/v2/swagger

Generates a general visit report.

```APIDOC
## POST /report/general-visit

### Description
General Visit Report

### Method
POST

### Endpoint
/report/general-visit
```

--------------------------------

### Create Appointment

Source: https://openapi.pteverywhere.com/api/v2/swagger

Allows for the creation of new appointments within the system. It requires details about the service, provider, location, patient, and the desired time frame.

```APIDOC
## POST /appointments

### Description
Creates a new appointment for a patient.

### Method
POST

### Endpoint
/appointments

### Parameters
#### Request Body
- **service** (string) - Required - The ID of the service to book.
- **provider** (string) - Required - The ID of the provider for the appointment.
- **location** (string) - Required - The ID of the location for the appointment.
- **patient** (string) - Required - The ID of the patient booking the appointment.
- **date** (string) - Required - The date of the appointment in YYYY-MM-DD format.
- **startTime** (string) - Required - The start time of the appointment in HH:MM format.
- **endTime** (string) - Required - The end time of the appointment in HH:MM format.

### Request Example
{
  "service": "5ef1b527c4419d4c9f4fb6f0",
  "provider": "5a339fda25169f36f8868cf2",
  "location": "5a339fda25169f36f8868cf2",
  "patient": "5a339fda25169f36f8868cf1",
  "date": "2024-01-05",
  "startTime": "15:10",
  "endTime": "15:50"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the appointment was booked.
```

--------------------------------

### POST /auth/token

Source: https://openapi.pteverywhere.com/api/v2/swagger

Authenticates user credentials to obtain authorized access and refresh tokens.

```APIDOC
## POST /auth/token

### Description
Authenticates user credentials to obtain authorized access and refresh tokens.

### Method
POST

### Endpoint
/auth/token

### Parameters
#### Request Body
- **email** (string) - Optional - Default: openapi@pteverywhere.com
- **password** (string) - Optional - Default: Ii@123456

### Request Example
```json
{
  "email": "openapi@pteverywhere.com",
  "password": "Ii@123456"
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - Description: 
- **refreshToken** (string) - Description: 
```

--------------------------------

### List Services

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of services offered by the clinic, with optional filtering by service name and pagination.

```APIDOC
## GET /masterdata/services

### Description
List all services in your clinic that match searching criteria.

### Method
GET

### Endpoint
/masterdata/services

### Parameters
#### Query Parameters
- **serviceName** (string) - Optional - A part or the entire Service name you are searching for. Leaving it blank will result in a full list returned.
- **pagination** (object) - Optional - Pagination parameters for the request.

### Response
#### Success Response (200)
- **items** (array of service objects) - A list of service objects.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"srv_123\",\n    \"name\": \"Standard Consultation\",\n    \"description\": \"A general consultation service.\",\n    \"price\": 50.00,\n    \"currency\": \"USD\"\n  }\n]"
}
```

--------------------------------

### POST /auth/confirm-password

Source: https://openapi.pteverywhere.com/api/v2/swagger

Confirms a user's password using an email, new password, and verification code. Returns access and refresh tokens upon successful confirmation.

```APIDOC
## POST /auth/confirm-password

### Description
Confirms a user's password using an email, new password, and verification code. Returns access and refresh tokens upon successful confirmation.

### Method
POST

### Endpoint
/auth/confirm-password

### Parameters
#### Request Body
- **email** (string) - Optional - Default: smstest0101@gmail.com
- **newPassword** (string) - Optional - Default: 123456Aa@
- **verificationCode** (string) - Optional - Default: abcdef

### Request Example
```json
{
  "email": "smstest0101@gmail.com",
  "newPassword": "123456Aa@",
  "verificationCode": "abcdef"
}
```

### Response
#### Success Response (200)
- **accessToken** (string) - Description: 
- **refreshToken** (string) - Description: 
```

--------------------------------

### POST /report/provider-revenue

Source: https://openapi.pteverywhere.com/api/v2/swagger

Generates a report detailing provider revenue, including expected, deferred, and collected amounts. This report excludes revenue from packages, memberships, or credits.

```APIDOC
## POST /report/provider-revenue

### Description
Displays all expected, deferred (money received but services are not provided yet) and collected/earned revenue excluding sessions paid by packages/memberships or credits.

### Method
POST

### Endpoint
/report/provider-revenue

### Request Body
This endpoint accepts a request body that combines schemas for ProviderRevenueReportRequest and SearchSortPagingRequest.

### Response
#### Success Response (200)
- **docs** (array) - An array of provider revenue report entries.

### Response Example
```json
{
  "docs": [
    // ... ProviderRevenueReportResponse objects
  ]
}
```
```

--------------------------------

### Appointment Create Request

Source: https://openapi.pteverywhere.com/api/v2/swagger

This endpoint allows you to create a new appointment. It requires provider and location information, and optionally accepts patient contact details.

```APIDOC
## POST /appointments

### Description
Create a new appointment for a patient.

### Method
POST

### Endpoint
/appointments

### Parameters
#### Request Body
- **provider** (string) - Required - The ID of the provider. Example: "5ef1b527c4419d4c9f4fb6ef"
- **location** (string) - Required - The ID of the location. Example: "5ef1b527c4419d4c9f4fb6fb"
- **email** (string) - Optional - The patient's email address. Example: "qwert12@yopmail.com"
- **phone** (string) - Optional - The patient's phone number. Example: "12055555555"
- **patient** (string) - Optional - The ID of the patient.

### Request Example
{
  "provider": "5ef1b527c4419d4c9f4fb6ef",
  "location": "5ef1b527c4419d4c9f4fb6fb",
  "email": "qwert12@yopmail.com",
  "phone": "12055555555",
  "patient": "somePatientId"
}

### Response
(Response details not provided in the source text)
```

--------------------------------

### POST /report/patient

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a patient report based on account registration and appointment information. This endpoint displays patients based on their account registration and first/last appointment info.

```APIDOC
## POST /report/patient

### Description
Displays patients based on their account registration and first/last appointment info.

### Method
POST

### Endpoint
/report/patient

### Request Body
- **schema** (object) - Required - The request body schema, which includes patient report specific fields and search/sort/paging parameters.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **docs** (array) - An array of patient report entries.

#### Response Example
```json
{
  "docs": [
    {
      "example": "patient report entry"
    }
  ]
}
```
```

--------------------------------

### Contact Logs Report

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a report of contact logs based on account registration. Supports searching, sorting, and pagination.

```APIDOC
## POST /report/contact-logs

### Description
Displays contact log based on their account registration.

### Method
POST

### Endpoint
/report/contact-logs

### Request Body
- **schema** (object) - Required - The request body must conform to the ContactLogReportRequest and SearchSortPagingRequest schemas.

### Response
#### Success Response (200)
- **docs** (array) - An array of contact log report items.

#### Response Example
{
  "docs": [
    {
      "example": "ContactLogReportResponse object"
    }
  ]
}
```

--------------------------------

### Package Membership Report

Source: https://openapi.pteverywhere.com/api/v2/swagger

Generates a report of patients based on their account registration and appointment information. Supports searching, sorting, and pagination.

```APIDOC
## POST /report/packages-memberships

### Description
Displays patients based on their account registration and first/last appointment info.

### Method
POST

### Endpoint
/report/packages-memberships

### Request Body
- **schema** (object) - Required - The request body must conform to the PackageMemberShipReportRequest and SearchSortPagingRequest schemas.

### Response
#### Success Response (200)
- **docs** (array) - An array of package membership report items.

#### Response Example
{
  "docs": [
    {
      "example": "PackageMemberShipReportResponse object"
    }
  ]
}
```

--------------------------------

### Inventory Item List

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of all products in the clinic inventory that match the specified search criteria. This endpoint is useful for managing and querying inventory data.

```APIDOC
## GET /masterdata/inventories

### Description
List all products in your clinic inventory that match searching criteria.

### Method
GET

### Endpoint
/masterdata/inventories

#### Query Parameters
- **productName** (string) - Optional - A part or the entire Inventory Item name you are searching for. Leaving it blank will result in a full list returned.
- **pagination** (object) - Optional - Specifies pagination parameters for the request.

### Response
#### Success Response (200)
- **items** (array) - A list of inventory items.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"inv_123\",\n    \"name\": \"Product A\",\n    \"quantity\": 100\n  }\n]"
}
```

--------------------------------

### Package Membership Report

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a report detailing package memberships, including details about the membership type, expiration, service charges, and associated services.

```APIDOC
## GET /reports/package-membership

### Description
Retrieves a report of package memberships.

### Method
GET

### Endpoint
/reports/package-membership

### Response
#### Success Response (200)
- **_id** (string) - The unique identifier for the package membership.
- **name** (string) - The name of the package membership.
- **type** (string) - The type of the package membership.
- **expirationRenewal** (string) - The expiration or renewal date of the membership.
- **serviceCharges** (number) - The total service charges for the membership.
- **servicesClasses** (array) - An array of service classes included in the membership.
  - **_id** (string) - The unique identifier for the service class.
  - **serviceClass** (string) - The name of the service class.
  - **price** (number) - The price of the service class.
  - **numberOfSessions** (number) - The number of sessions included for this service class.
  - **totalAmount** (number) - The total amount for this service class.
- **patients** (array) - An array of patient objects associated with this membership.
  - **_id** (string) - The unique identifier for the patient.
```

--------------------------------

### User List

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of all clinic user accounts that match the specified search criteria. This endpoint is used for managing user access and information.

```APIDOC
## GET /masterdata/clinic-users

### Description
List all clinic user accounts in your clinic that match searching criteria.

### Method
GET

### Endpoint
/masterdata/clinic-users

#### Query Parameters
- **userName** (string) - Optional - A part or the entire User name you are searching for. Leaving it blank will result in a full list returned.
- **roles** (string) - Optional - A part or the entire role you are searching for. Leaving it blank will result in a full list returned.

### Response
#### Success Response (200)
- **items** (array) - A list of clinic users.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"user_789\",\n    \"name\": \"Jane Smith\",\n    \"role\": \"Doctor\"\n  }\n]"
}
```

--------------------------------

### List Locations

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of clinic locations, with optional filtering by location name and pagination.

```APIDOC
## GET /masterdata/locations

### Description
List all locations of your clinic that match searching criteria.

### Method
GET

### Endpoint
/masterdata/locations

### Parameters
#### Query Parameters
- **locationName** (string) - Optional - A part or the entire Location name you are searching for. Leaving it blank will result in a full list returned.
- **pagination** (object) - Optional - Pagination parameters for the request.

### Response
#### Success Response (200)
- **items** (array of location objects) - A list of location objects.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"loc_abc\",\n    \"name\": \"Downtown Clinic\",\n    \"address\": \"123 Main St\",\n    \"city\": \"Anytown\",\n    \"country\": \"USA\"\n  }\n]"
}
```

--------------------------------

### Patient Report Request

Source: https://openapi.pteverywhere.com/api/v2/swagger

Defines the structure for requesting patient reports, with filtering options based on creation date and first appointment date.

```APIDOC
## PatientReportRequest

### Description
This object defines the parameters for requesting a patient report. You can filter by the creation date of the record or the date of the patient's first appointment.

### Properties
- **createdDate** (object) - Required - Specifies the date range for when the patient record was created.
  - **startDate** (string) - Required - The start date for the creation date range (e.g., "2023-01-01").
  - **endDate** (string) - Required - The end date for the creation date range (e.g., "2023-09-08").
  - **timeRange** (string) - Optional - Specifies the time range for the creation date (e.g., "All").
- **firstAppointmentDate** (object) - Specifies the date range for the patient's first appointment.
  - **startDate** (string) - The start date for the first appointment range.
```

--------------------------------

### Demographics Report Request

Source: https://openapi.pteverywhere.com/api/v2/swagger

Defines the structure for requesting demographic reports. Allows filtering by month, insurance status, year range, and zip code.

```APIDOC
## DemographicsReportRequest

### Description
This object defines the parameters for requesting a demographics report. You can filter the report by specifying a list of months, insurance status, a date range for the years, and a specific zip code.

### Properties
- **listMonth** (array[number]) - Optional - A list of months (1-12) to include in the report.
- **listInsurance** (array[string]) - Optional - Filters by insurance status. Accepts 'hasIns' or 'none'.
- **fromYear** (number) - Optional - The starting year for the report data. Defaults to 1970.
- **toYear** (number) - Optional - The ending year for the report data. Defaults to 2023.
- **zipCode** (string) - Optional - Filters the report by a specific zip code. Defaults to an empty string.
```

--------------------------------

### Patient List

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a list of all patients in the clinic that match the specified search criteria. This endpoint is essential for accessing and managing patient information.

```APIDOC
## GET /masterdata/patients

### Description
List all patients in your clinic that match searching criteria.

### Method
GET

### Endpoint
/masterdata/patients

#### Query Parameters
- **patientName** (string) - Optional - A part or the entire Patient name you are searching for. Leaving it blank will result in a full list returned.
- **pagination** (object) - Optional - Specifies pagination parameters for the request.

### Response
#### Success Response (200)
- **items** (array) - A list of patients.

#### Response Example
{
  "example": "[\n  {\n    \"id\": \"pat_456\",\n    \"name\": \"John Doe\",\n    \"dob\": \"1990-01-01\"\n  }\n]"
}
```

--------------------------------

### POST /report/demographics

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves a report of patient demographics. This endpoint displays all patients and their personal demographic information.

```APIDOC
## POST /report/demographics

### Description
Displays all patients and their personal demographic information.

### Method
POST

### Endpoint
/report/demographics

### Request Body
- **schema** (object) - Required - The request body schema, which includes demographic report specific fields and search/sort/paging parameters.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **docs** (array) - An array of demographic report entries.

#### Response Example
```json
{
  "docs": [
    {
      "example": "demographics report entry"
    }
  ]
}
```
```

--------------------------------

### POST /auth/renewtokens

Source: https://openapi.pteverywhere.com/api/v2/swagger

Renews access tokens using a valid refresh token.

```APIDOC
## POST /auth/renewtokens

### Description
Renews access tokens using a valid refresh token.

### Method
POST

### Endpoint
/auth/renewtokens

### Parameters
#### Request Body
- **email** (string) - Optional - Default: smstest0101@gmail.com
- **refreshToken** (string) - Description: 
```

--------------------------------

### Contact Log Report

Source: https://openapi.pteverywhere.com/api/v2/swagger

Retrieves contact log reports based on specified methods and patients. This endpoint allows filtering contact logs by communication method and specific patients.

```APIDOC
## GET /reports/contact-log

### Description
Retrieves contact log reports. Allows filtering by communication methods and patients.

### Method
GET

### Endpoint
/reports/contact-log

### Parameters
#### Query Parameters
- **methods** (array[string]) - Optional - The communication methods to filter by.
- **patients** (array[string]) - Optional - The patient IDs to filter by.

### Response
#### Success Response (200)
- **_id** (string) - The unique identifier for the contact log entry.
- **method** (string) - The communication method used.
- **topic** (object) - Information about the topic of the contact.
  - **_id** (string) - The unique identifier for the topic.
  - **name** (string) - The name of the topic.
- **createdBy** (object) - Information about the user who created the log entry.
  - **_id** (string) - The unique identifier for the creator.
  - **name** (string) - The name of the creator.
- **patient** (object) - Information about the patient associated with the log entry.
  - **_id** (string) - The unique identifier for the patient.
  - **name** (string) - The name of the patient.
- **logTime** (string) - The timestamp when the contact occurred.
- **createdAt** (string) - The timestamp when the log entry was created.
- **previousLog** (object) - Information about the previous log entry, if any.
  - **_id** (string) - The unique identifier for the previous log.
  - **logTime** (string) - The timestamp of the previous contact.
  - **method** (string) - The communication method of the previous contact.
  - **topic** (object) - Information about the topic of the previous contact.
    - **_id** (string) - The unique identifier for the previous topic.
    - **name** (string) - The name of the previous topic.
```

--------------------------------

### Demographics Report Response

Source: https://openapi.pteverywhere.com/api/v2/swagger

Represents the structure of a demographics report response, containing patient details and insurance information.

```APIDOC
## DemographicsReportResponse

### Description
This object represents the data returned in a demographics report, including patient personal information, contact details, address, and insurance status.

### Properties
- **_id** (string) - The unique identifier for the report entry.
- **firstName** (string) - Patient's First Name.
- **lastName** (string) - Patient's Last Name.
- **email** (string) - Patient's Email address.
- **dateOfBirth** (number) - Patient's date of birth (numeric representation).
- **monthOfBirth** (number) - Patient's month of birth.
- **yearOfBirth** (number) - Patient's year of birth.
- **phoneNumber** (string) - Patient's phone number.
- **zipCode** (string) - Patient's zip code.
- **address** (string) - Patient's street address.
- **city** (string) - Patient's city.
- **state** (string) - Patient's state.
- **insuranceInfo** (string) - Patient's insurance information.
- **openCaseStr** (string) - Patient's ICD Open case information.
- **closeCaseStr** (string) - Patient's ICD Close case information.
- **dependentOf** (object) - Information about the dependent relationship, referencing `dependentOfResponse` schema.
```
Tokens:
Raw