PUT api/v1/Client/{id}/Contract

Update a client contract

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id number of the client	integer	Required

Body Parameters

ClientContract object

ClientContract

Name	Description	Type
Id		integer
ClientId		integer
EffectiveDateStart		date
EffectiveDateEnd		date
PlanName		string
PlanBillingCode		string
ItemId		integer
Price		decimal number
DiscountAmount		decimal number
ClientContractDetails		Collection of ClientContractDetail
ModifiedDateTime	Modified datetime for the object. This will be added by the system.	date
ExecutionTime	How long the method took in milliseconds. System supplied value.	integer
TxID	Transaction ID of the call. Will be added for the response. Not needed in the request.	string

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "clientId": 2,
  "effectiveDateStart": "2025-08-14T01:25:23.3413509+00:00",
  "effectiveDateEnd": "2025-08-14T01:25:23.3413509+00:00",
  "planName": "sample string 5",
  "planBillingCode": "sample string 6",
  "itemId": 7,
  "price": 8.0,
  "discountAmount": 9.0,
  "clientContractDetails": [
    {
      "id": 1,
      "clientContractId": 2,
      "healthCoachInboundCalls": 3.0,
      "healthCoachInboundCallsMax": 4.0,
      "additionalHealthCoachCallPrice": 5.0,
      "additionalHealthCoachCallDiscountAmount": 6.0,
      "additionalHealthCoachCallItemId": 7,
      "clinicalCalls": 8.0,
      "clinicalCallsMax": 9.0,
      "additionalDieticianCallPrice": 10.0,
      "additionalDieticianCallDiscountAmount": 11.0,
      "additionalDieticianCallItemId": 12,
      "additionalNurseCallPrice": 13.0,
      "additionalNurseCallDiscountAmount": 14.0,
      "additionalNurseCallItemId": 15,
      "reportingType": "sample string 16",
      "collectBiometricData": true,
      "rewardsProgram": true,
      "nutritionPlans": true,
      "resupplyGoal": 20.0,
      "resupplyLimit": 21.0,
      "replacementWelcomeKitPrice": 22.0,
      "replacementWelcomeKitItemId": 23,
      "replacementGlucometerPrice": 24.0,
      "replacementGlucometerItemId": 25,
      "replacementDeviceBandPrice": 26.0,
      "replacementDeviceBandItemId": 27,
      "modifiedDateTime": "2025-08-14T01:25:23.3413509+00:00",
      "executionTime": 30,
      "txID": "sample string 31"
    },
    {
      "id": 1,
      "clientContractId": 2,
      "healthCoachInboundCalls": 3.0,
      "healthCoachInboundCallsMax": 4.0,
      "additionalHealthCoachCallPrice": 5.0,
      "additionalHealthCoachCallDiscountAmount": 6.0,
      "additionalHealthCoachCallItemId": 7,
      "clinicalCalls": 8.0,
      "clinicalCallsMax": 9.0,
      "additionalDieticianCallPrice": 10.0,
      "additionalDieticianCallDiscountAmount": 11.0,
      "additionalDieticianCallItemId": 12,
      "additionalNurseCallPrice": 13.0,
      "additionalNurseCallDiscountAmount": 14.0,
      "additionalNurseCallItemId": 15,
      "reportingType": "sample string 16",
      "collectBiometricData": true,
      "rewardsProgram": true,
      "nutritionPlans": true,
      "resupplyGoal": 20.0,
      "resupplyLimit": 21.0,
      "replacementWelcomeKitPrice": 22.0,
      "replacementWelcomeKitItemId": 23,
      "replacementGlucometerPrice": 24.0,
      "replacementGlucometerItemId": 25,
      "replacementDeviceBandPrice": 26.0,
      "replacementDeviceBandItemId": 27,
      "modifiedDateTime": "2025-08-14T01:25:23.3413509+00:00",
      "executionTime": 30,
      "txID": "sample string 31"
    }
  ],
  "modifiedDateTime": "2025-08-14T01:25:23.3413509+00:00",
  "executionTime": 12,
  "txID": "sample string 13"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

Response Information

Resource Description

Client Object

Client

Name	Description	Type	Additional information
Id	Database ID for the client. Do not supply this value. It will be generated by the system	integer
Name	Client Name from Dynamics	string	Required
ShortName	Common Name that is in dynamics but it is how we know the clients	string	Required
Code	Client Code for the ID	string	Required
Active	Active status of the client	boolean	Required
ParentClient	Parent Client for the client. Leave empty if one doesn't exist	string
Description	Description of the client	string
ErpId	ERP ID for the client. From Dynamics	string
ErpNumber	ERP Number for the client. From Dynamics	string
Address1	Address information for the client	string
Address2	Address information for the client	string
City	City information for the client	string
State	State information for the client	string
Zip	Zip information for the client	string
Email	Email information for the client	string
Phone	Phone information for the client	string
ClientContracts	Client Contracts for the client	Collection of ClientContract
ModifiedDateTime	Modified datetime for the object. This will be added by the system.	date
ExecutionTime	How long the method took in milliseconds. System supplied value.	integer
TxID	Transaction ID of the call. Will be added for the response. Not needed in the request.	string

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "name": "sample string 2",
  "shortName": "sample string 3",
  "code": "sample string 4",
  "active": true,
  "parentClient": "sample string 6",
  "description": "sample string 7",
  "erpId": "sample string 8",
  "erpNumber": "sample string 9",
  "address1": "sample string 10",
  "address2": "sample string 11",
  "city": "sample string 12",
  "state": "sample string 13",
  "zip": "sample string 14",
  "email": "sample string 15",
  "phone": "sample string 16",
  "clientContracts": [
    {
      "id": 1,
      "clientId": 2,
      "effectiveDateStart": "2025-08-14T01:25:23.4038264+00:00",
      "effectiveDateEnd": "2025-08-14T01:25:23.4038264+00:00",
      "planName": "sample string 5",
      "planBillingCode": "sample string 6",
      "itemId": 7,
      "price": 8.0,
      "discountAmount": 9.0,
      "clientContractDetails": [
        {
          "id": 1,
          "clientContractId": 2,
          "healthCoachInboundCalls": 3.0,
          "healthCoachInboundCallsMax": 4.0,
          "additionalHealthCoachCallPrice": 5.0,
          "additionalHealthCoachCallDiscountAmount": 6.0,
          "additionalHealthCoachCallItemId": 7,
          "clinicalCalls": 8.0,
          "clinicalCallsMax": 9.0,
          "additionalDieticianCallPrice": 10.0,
          "additionalDieticianCallDiscountAmount": 11.0,
          "additionalDieticianCallItemId": 12,
          "additionalNurseCallPrice": 13.0,
          "additionalNurseCallDiscountAmount": 14.0,
          "additionalNurseCallItemId": 15,
          "reportingType": "sample string 16",
          "collectBiometricData": true,
          "rewardsProgram": true,
          "nutritionPlans": true,
          "resupplyGoal": 20.0,
          "resupplyLimit": 21.0,
          "replacementWelcomeKitPrice": 22.0,
          "replacementWelcomeKitItemId": 23,
          "replacementGlucometerPrice": 24.0,
          "replacementGlucometerItemId": 25,
          "replacementDeviceBandPrice": 26.0,
          "replacementDeviceBandItemId": 27,
          "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
          "executionTime": 30,
          "txID": "sample string 31"
        },
        {
          "id": 1,
          "clientContractId": 2,
          "healthCoachInboundCalls": 3.0,
          "healthCoachInboundCallsMax": 4.0,
          "additionalHealthCoachCallPrice": 5.0,
          "additionalHealthCoachCallDiscountAmount": 6.0,
          "additionalHealthCoachCallItemId": 7,
          "clinicalCalls": 8.0,
          "clinicalCallsMax": 9.0,
          "additionalDieticianCallPrice": 10.0,
          "additionalDieticianCallDiscountAmount": 11.0,
          "additionalDieticianCallItemId": 12,
          "additionalNurseCallPrice": 13.0,
          "additionalNurseCallDiscountAmount": 14.0,
          "additionalNurseCallItemId": 15,
          "reportingType": "sample string 16",
          "collectBiometricData": true,
          "rewardsProgram": true,
          "nutritionPlans": true,
          "resupplyGoal": 20.0,
          "resupplyLimit": 21.0,
          "replacementWelcomeKitPrice": 22.0,
          "replacementWelcomeKitItemId": 23,
          "replacementGlucometerPrice": 24.0,
          "replacementGlucometerItemId": 25,
          "replacementDeviceBandPrice": 26.0,
          "replacementDeviceBandItemId": 27,
          "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
          "executionTime": 30,
          "txID": "sample string 31"
        }
      ],
      "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
      "executionTime": 12,
      "txID": "sample string 13"
    },
    {
      "id": 1,
      "clientId": 2,
      "effectiveDateStart": "2025-08-14T01:25:23.4038264+00:00",
      "effectiveDateEnd": "2025-08-14T01:25:23.4038264+00:00",
      "planName": "sample string 5",
      "planBillingCode": "sample string 6",
      "itemId": 7,
      "price": 8.0,
      "discountAmount": 9.0,
      "clientContractDetails": [
        {
          "id": 1,
          "clientContractId": 2,
          "healthCoachInboundCalls": 3.0,
          "healthCoachInboundCallsMax": 4.0,
          "additionalHealthCoachCallPrice": 5.0,
          "additionalHealthCoachCallDiscountAmount": 6.0,
          "additionalHealthCoachCallItemId": 7,
          "clinicalCalls": 8.0,
          "clinicalCallsMax": 9.0,
          "additionalDieticianCallPrice": 10.0,
          "additionalDieticianCallDiscountAmount": 11.0,
          "additionalDieticianCallItemId": 12,
          "additionalNurseCallPrice": 13.0,
          "additionalNurseCallDiscountAmount": 14.0,
          "additionalNurseCallItemId": 15,
          "reportingType": "sample string 16",
          "collectBiometricData": true,
          "rewardsProgram": true,
          "nutritionPlans": true,
          "resupplyGoal": 20.0,
          "resupplyLimit": 21.0,
          "replacementWelcomeKitPrice": 22.0,
          "replacementWelcomeKitItemId": 23,
          "replacementGlucometerPrice": 24.0,
          "replacementGlucometerItemId": 25,
          "replacementDeviceBandPrice": 26.0,
          "replacementDeviceBandItemId": 27,
          "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
          "executionTime": 30,
          "txID": "sample string 31"
        },
        {
          "id": 1,
          "clientContractId": 2,
          "healthCoachInboundCalls": 3.0,
          "healthCoachInboundCallsMax": 4.0,
          "additionalHealthCoachCallPrice": 5.0,
          "additionalHealthCoachCallDiscountAmount": 6.0,
          "additionalHealthCoachCallItemId": 7,
          "clinicalCalls": 8.0,
          "clinicalCallsMax": 9.0,
          "additionalDieticianCallPrice": 10.0,
          "additionalDieticianCallDiscountAmount": 11.0,
          "additionalDieticianCallItemId": 12,
          "additionalNurseCallPrice": 13.0,
          "additionalNurseCallDiscountAmount": 14.0,
          "additionalNurseCallItemId": 15,
          "reportingType": "sample string 16",
          "collectBiometricData": true,
          "rewardsProgram": true,
          "nutritionPlans": true,
          "resupplyGoal": 20.0,
          "resupplyLimit": 21.0,
          "replacementWelcomeKitPrice": 22.0,
          "replacementWelcomeKitItemId": 23,
          "replacementGlucometerPrice": 24.0,
          "replacementGlucometerItemId": 25,
          "replacementDeviceBandPrice": 26.0,
          "replacementDeviceBandItemId": 27,
          "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
          "executionTime": 30,
          "txID": "sample string 31"
        }
      ],
      "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
      "executionTime": 12,
      "txID": "sample string 13"
    }
  ],
  "modifiedDateTime": "2025-08-14T01:25:23.4038264+00:00",
  "executionTime": 19,
  "txID": "sample string 20"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.