ClientEngagement


Table of contents

    Overview

    A ClientEngagement contains plan information, linked service bookings and limited contact information for participant and representative.

    To call the ClientEngagement endpoint, use one of the URLs from the following tables:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/clientengagement ✔
    https://api.mypcorp.com/clientengagement/{ClientEngagementGuid} ✔

    NB: Currently, ClientEngagement endpoint only returns NDIA(Portal/NON-PACE) client engagements. It’s planned to refactor this endpoint to return PACE client engagements with new properties in the future.

    GET

    The following table illustrates which fields can be included when receiving a GET response.

    NB: Nested properties are hidden by default. To expand all nested properties, add $expand=* to the URL. To expand a specific nested property, set the property name after $expand= (i.e. $expand=LineItems).

    Client Engagement
    Field Name Description
    ClientEngagementGuid
    Guid (Identifier)     		The ClientEngagement’s id.
    ParticipantType
    String    		 Type of participant. Currently, only “NDIA” (Portal/Non-PACE) is available. “PACE” will be introduced in the future.
    PlanStartDate
    Date    		 Start date of the plan.
    PlanEndDate
    Date    		 End date of the plan.
    BookingStartDate
    Date    		 Start date of the service bookings.
    BookingEndDate
    Date    		 End date of the service bookings.
    PlanCommencementDate
    Date    		 Commence date of the plan.
    NoActivePlanFromDate
    Date    		 Date of no active plan from of the plan.
    IsAgencyManaged
    Boolean    		 Indicates whether the plan is agency-managed or not.
    IsSelfManaged
    Boolean     		Indicates whether the plan is self-managed or not.
    IsPlanManaged
    Boolean    		 Indicates whether the plan is plan-managed or not.
    SupportCoordinatorContactGuid
    Guid    		 ContactGuid of the plan support coordinator. To view the contact’s details, refer to Contact endpoint.
    PersonResponsibleForDirectFeesContactGuid
    Guid    		 ContactGuid of the person who is responsible for direct fee. To view the contact’s details, refer to Contact endpoint.
    PlanManagerClientGuid
    Guid    		 ClientGuid of plan manager. To view the client’s details, refer to Client endpoint.
    TotalBudgetAmount
    Decimal    		 Total budget amount of the plan.
    TotalAllocateAmount
    Decimal    		 Total amount that has been allocated.
    UnAllocateAmount
    Decimal    		 Total amount that hasn’t been allocated.
    ModifiedDate
    Datetimeoffset    		 Last modified datetime of the client engagement.
    ArchiveDate
    Datetimeoffset    		 Datetime when the client engagement was archived, if it has been.
    Participant
    Object    		 Contact information of the participant. To view the participant details, refer to the following Participant table.
    Representative
    Object    		 Contact information of the representative. To view the representative details, refer to the following Representative table.
    ServiceBookings
    Object    		 List of service bookings of the client engagement. To view service booking details, refer to the following Service Booking table.
    NB: This object is exclusive of Portal(non-PACE)’s client engagement.
    Participant
    Field Name Description
    ContactGuid
    Guid (Identifier)     		Contact Guid of the participant. To view more details which are not included in this object, refer to Contact endpoint.
    FirstName
    String    		 First name of the participant.
    LastName
    String    		 Last name of the participant.
    Birthday
    Date    		 Birthday of the participant.
    NdisNumber
    String    		 Ndis number of the participant.
    NdisPriceGuideRegion
    String    		 Price guide region of the participant.
    Possible values are:
    “ACT/NSW/QLD/VIC”
    “NT/SA/TAS/WA”
    “Remote”
    “Very Remote”
    AccountManagerStaffGuid
    Guid    		 Staff Guid of participant’s account manager. To view staff’s details, refer to Staff endpoint.
    PhoneNumber1
    String    		 Participant’s phone number.
    PhoneNumber2
    String    		 Participant’s secondary phone number, if applicable.
    PrimaryEmail
    String    		 Participant’s primary email, if applicable.
    Address
    Object    		 Address of the participant. To view the address details, refer to the following Address table.
    Address
    Field Name Description
    StreetAddress
    String    		 Contact’s home street address.
    StreetAddress2
    String    		 Second field for Contact’s home street address.
    Suburb
    String    		 Contact’s suburb.
    City
    String    		 Contact’s town or city.
    State
    String    		 Contact’s home state.
    Country
    String    		 Contact’s home country.
    PostCode
    String    		 Contact’s home postcode.
    Representative
    Field Name Description
    ContactGuid
    Guid
    (Identifier)    		 Contact Guid of the representative. To view more details which are not included in this object, refer to Contact endpoint.
    FirstName
    String    		 First name of the representative.
    LastName
    String    		 Last name of the representative.
    RepresentativeRelationship
    String    		 Relationship with the participant.
    PhoneNumber1
    String    		 Representative’s phone number.
    PhoneNumber2
    String    		 Representative’s secondary phone number, if applicable.
    PrimaryEmail
    String    		 Representative’s primary email, if applicable.
    Address
    Object    		 Address of the representative. To view the address details, refer to the following Address table.
    Service booking
    Field Name Description
    ServiceBookingGuid
    Guid
    (Identifier)    		 The Service booking’s Id
    SupportPurpose
    String    		 Service booking’s support purpose.
    Possible values are:
    “Core”
    “Capital”
    “Capacity Building”
    “Custom Purpose”
    SupportItem
    String    		 Service booking’s support item code.
    BudgetManagerStaffGuid
    Guid    		 Staff Guid of budget manager. To view staff’s details, refer to Staff endpoint.
    Budget
    Decimal    		 Service booking’s support category.
    ManagementType
    String    		 Service booking’s management type.
    Possible values are:
    “Agency”
    “Plan”
    “Self”
    BookingStartDate
    Date    		 Service booking’s start date.
    BookingEndDate
    Date    		 Service booking’s end date.
    BookingNumber
    String    		 Service booking’s booking number.
    Category
    Object    		 Service booking’s support category. To view category details, refer to Category table.
    Category
    Field name Description
    CategoryGuid
    Guid    		 Category’s Id.
    Name
    String    		 Category’s name.
    ArchivedDate
    Datetimeoffset    		 Category’s archived datetime.

    Example JSON response:

    {
    "@odata.context": "https://api.mypcorp.com/$metadata#ClientEngagement(Participant(Address()),Representative(Address()),ServiceBookings())",
    "value": [
        {
            "ClientEngagementGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
            "ParticipantType": "NDIA",
            "PlanStartDate": "2020-06-01",
            "PlanEndDate": "2024-06-30",
            "BookingStartDate": "2020-06-01",
            "BookingEndDate": "2024-06-30",
            "PlanCommencementDate": null,
            "NoActivePlanFromDate": null,
            "IsAgencyManaged": true,
            "IsSelfManaged": false,
            "IsPlanManaged": true,
            "SupportCoordinatorContactGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
            "PersonResponsibleForDirectFeesContactGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
            "PlanManagerClientGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
            "TotalBudgetAmount": 10000.00,
            "TotalAllocateAmount": 2244.00,
            "UnAllocateAmount": 7756.00,
            "ModifiedDate": "2023-08-22T09:17:59.53+10:00",
            "ArchiveDate": null,
            "Participant": {
                "ContactGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                "FirstName": "Ben",
                "LastName": "Red",
                "Birthday": "1987-08-01",
                "NdisNumber": "",
                "NdisPriceGuideRegion": "ACT/NSW/QLD/VIC",
                "AccountManagerStaffGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                "PhoneNumber1": "110101012",
                "PhoneNumber2": "",
                "PrimaryEmail": "Rben@testemail.com",
                "Address": {
                    "StreetAddress": "14/8 Metroplex Ave",
                    "StreetAddress2": "",
                    "Suburb": "Murarrie",
                    "City": "Brisbane",
                    "State": "Queensland",
                    "Country": "Australia",
                    "PostCode": "4172"
                }
            },
            "Representative": {
                "ContactGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                "FirstName": "Lucas",
                "LastName": "Red",
                "RepresentativeRelationship": "Patient of",
                "PhoneNumber1": "1213141",
                "PhoneNumber2": "",
                "PrimaryEmail": "",
                "Address": {
                    "StreetAddress": "14/8 Metroplex Ave",
                    "StreetAddress2": "",
                    "Suburb": "Murarrie",
                    "City": "Brisbane",
                    "State": "Queensland",
                    "Country": "Australia",
                    "PostCode": "4172"
                }
            },
            "ServiceBookings": [
                {
                    "ServiceBookingGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                    "SupportPurpose": "Core",
                    "SupportItem": "04_105_0125_6_1",
                    "BudgetManagerStaffGuid": null,
                    "Budget": 1123.00,
                    "ManagementType": "Plan",
                    "BookingStartDate": null,
                    "BookingEndDate": null,
                    "BookingNumber": null,
                    "Category":{
                        "CategoryGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                        "Name": "Assistance with daily life (includes Supported Independent Living)",
                        "ArchivedDate": null
                    }
                },
                {
                    "ServiceBookingGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                    "SupportPurpose": "Core",
                    "SupportItem": null,
                    "BudgetManagerStaffGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                    "Budget": 1121.00,
                    "ManagementType": "Plan",
                    "BookingStartDate": "2023-08-01",
                    "BookingEndDate": "2023-08-31",
                    "BookingNumber": "112121",
                    "Category":{
                        "CategoryGuid": "F1B9405A-0BC7-43CF-A514-312B8AD69FEF",
                        "Name": "Assistance with daily life (includes Supported Independent Living)",
                        "ArchivedDate": null
                    }
                }
            ]
        }
    ]
}


    Previous article Return home