POST v1/ServiceContract
Create a new ServiceContract.
Request Information
URI Parameters
None.
Body Parameters
The ServiceContract.
ServiceContractChanges| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationContactInfoId | integer |
None. |
|
| DeliveryAddressContactInfoId | integer |
None. |
|
| OrderId | integer |
None. |
|
| WallCabinetPinCode | string |
Max length: 50 |
|
| StatusId | integer |
None. |
|
| CustomerReference | string |
Max length: 50 |
|
| ShopId | integer |
Required |
|
| ServiceComment | string |
Max length: 2147483647 |
|
| EndOfWarrantyDate | date |
None. |
|
| ActiveStatusId | integer |
None. |
|
| EndDate | date |
None. |
|
| NewContractStartDate | date |
None. |
|
| SerialNumber | string |
Max length: 50 |
|
| StockItemId | integer |
None. |
|
| AutoGenerateOrder | boolean |
Required |
|
| NextOrderDate | date |
None. |
|
| NextMaintenanceDate | date |
None. |
|
| OrderDiscountPercentage | integer |
Required |
|
| InternalReference | string |
Max length: 2147483647 |
|
| CurrentExpiryDateBattery | date |
None. |
|
| CurrentExpiryDateElectrode | date |
None. |
|
| CurrentExpiryDatePaediatricElectrode | date |
None. |
|
| ProductionYear | integer |
None. |
|
| AutoGenerateServiceAppointment | boolean |
Required |
|
| Rows | Collection of ServiceContractRow |
None. |
|
| Id | integer |
Must be 0 (for insert operations) |
|
| Code | string |
None. |
|
| TypeId | integer |
None. |
|
| CustomerId | integer |
Required |
|
| StartDate | date |
Required |
|
| ServiceProductId | integer |
Required |
|
| Location | ContactInfo |
None. |
|
| DeliveryAddress | ContactInfo |
None. |
Request Formats
application/json, text/json
Sample:
{
"LocationContactInfoId": 1,
"DeliveryAddressContactInfoId": 1,
"OrderId": 1,
"WallCabinetPinCode": "sample string 1",
"StatusId": 1,
"CustomerReference": "sample string 2",
"ShopId": 3,
"ServiceComment": "sample string 4",
"EndOfWarrantyDate": "2026-01-11T16:13:18.5425838+01:00",
"ActiveStatusId": 5,
"EndDate": "2026-01-11T16:13:18.5425838+01:00",
"NewContractStartDate": "2026-01-11T16:13:18.5425838+01:00",
"SerialNumber": "sample string 6",
"StockItemId": 1,
"AutoGenerateOrder": true,
"NextOrderDate": "2026-01-11T16:13:18.5425838+01:00",
"NextMaintenanceDate": "2026-01-11T16:13:18.5425838+01:00",
"OrderDiscountPercentage": 1,
"InternalReference": "sample string 8",
"CurrentExpiryDateBattery": "2026-01-11T16:13:18.5425838+01:00",
"CurrentExpiryDateElectrode": "2026-01-11T16:13:18.5425838+01:00",
"CurrentExpiryDatePaediatricElectrode": "2026-01-11T16:13:18.5425838+01:00",
"ProductionYear": 1,
"AutoGenerateServiceAppointment": true,
"Rows": null,
"Id": 9,
"Code": "sample string 10",
"TypeId": 1,
"CustomerId": 11,
"StartDate": "2026-01-11T16:13:18.5425838+01:00",
"ServiceProductId": 12,
"Location": {
"VatNumber": "sample string 1",
"FullName": "sample string 2",
"DateOfBirth": "2026-01-11T16:13:18.5425838+01:00",
"Gender": "sample string 3",
"PersonTitle": "sample string 4",
"MiddleName": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"LastNamePrefix": "sample string 8",
"Id": 9,
"CompanyName": "sample string 10",
"Address": "sample string 11",
"Address2": "sample string 12",
"StreetAddress": "sample string 13",
"StreetAddressNumber": "sample string 14",
"StreetAddressExtension": "sample string 15",
"PostalCode": "sample string 16",
"City": "sample string 17",
"CountryId": 1,
"CountryCode": "sample string 18",
"CountryName": null,
"EMail": "sample string 19",
"Phone": "sample string 20",
"Phone2": "sample string 21",
"StateProvince": "sample string 22",
"StateProvinceCode": "sample string 23"
},
"DeliveryAddress": {
"VatNumber": "sample string 1",
"FullName": "sample string 2",
"DateOfBirth": "2026-01-11T16:13:18.5425838+01:00",
"Gender": "sample string 3",
"PersonTitle": "sample string 4",
"MiddleName": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"LastNamePrefix": "sample string 8",
"Id": 9,
"CompanyName": "sample string 10",
"Address": "sample string 11",
"Address2": "sample string 12",
"StreetAddress": "sample string 13",
"StreetAddressNumber": "sample string 14",
"StreetAddressExtension": "sample string 15",
"PostalCode": "sample string 16",
"City": "sample string 17",
"CountryId": 1,
"CountryCode": "sample string 18",
"CountryName": null,
"EMail": "sample string 19",
"Phone": "sample string 20",
"Phone2": "sample string 21",
"StateProvince": "sample string 22",
"StateProvinceCode": "sample string 23"
}
}
Response Information
Resource Description
The ServiceContract object.
ServiceContract| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationContactInfoId | integer |
None. |
|
| DeliveryAddressContactInfoId | integer |
None. |
|
| OrderId | integer |
None. |
|
| OrderCode | string |
None. |
|
| WallCabinetPinCode | string |
Max length: 50 |
|
| StatusId | integer |
None. |
|
| StatusName | string |
None. |
|
| CustomerReference | string |
Max length: 50 |
|
| ShopId | integer |
Required |
|
| ShopName | string |
None. |
|
| Comment | string |
Max length: 2147483647 |
|
| ServiceComment | string |
Max length: 2147483647 |
|
| EndOfWarrantyDate | date |
None. |
|
| ActiveStatusId | integer |
None. |
|
| ActiveStatusName | string |
None. |
|
| EndDate | date |
None. |
|
| NewContractStartDate | date |
None. |
|
| SerialNumber | string |
Max length: 50 |
|
| StockItemId | integer |
None. |
|
| AutoGenerateOrder | boolean |
Required |
|
| NextOrderDate | date |
None. |
|
| NextMaintenanceDate | date |
None. |
|
| DeletedTimestamp | date |
None. |
|
| CreateTimestamp | date |
Required |
|
| ChangeTimestamp | date |
None. |
|
| OrderDiscountPercentage | integer |
Required |
|
| InternalReference | string |
Max length: 2147483647 |
|
| Type | ServiceContractType |
None. |
|
| Files | Collection of FileBase |
None. |
|
| Appointments | Collection of ServiceAppointmentBase |
None. |
|
| CurrentExpiryDateBattery | date |
None. |
|
| CurrentExpiryDateElectrode | date |
None. |
|
| CurrentExpiryDatePaediatricElectrode | date |
None. |
|
| ProductionYear | integer |
None. |
|
| AutoGenerateServiceAppointment | boolean |
Required |
|
| Rows | Collection of ServiceContractRow |
None. |
|
| Id | integer |
Must be 0 (for insert operations) |
|
| Code | string |
None. |
|
| TypeId | integer |
None. |
|
| TypeName | string |
None. |
|
| CustomerId | integer |
Required |
|
| CustomerCode | string |
None. |
|
| CustomerEmail | string |
None. |
|
| StartDate | date |
Required |
|
| BrandName | string |
None. |
|
| ServiceProductId | integer |
Required |
|
| ServiceProductName | string |
None. |
|
| Location | ContactInfo |
None. |
|
| DeliveryAddress | ContactInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"LocationContactInfoId": 1,
"DeliveryAddressContactInfoId": 1,
"OrderId": 1,
"OrderCode": "sample string 1",
"WallCabinetPinCode": "sample string 2",
"StatusId": 1,
"StatusName": "sample string 3",
"CustomerReference": "sample string 4",
"ShopId": 5,
"ShopName": "sample string 6",
"Comment": "sample string 7",
"ServiceComment": "sample string 8",
"EndOfWarrantyDate": "2026-01-11T16:13:18.5581996+01:00",
"ActiveStatusId": 9,
"ActiveStatusName": "sample string 10",
"EndDate": "2026-01-11T16:13:18.5581996+01:00",
"NewContractStartDate": "2026-01-11T16:13:18.5581996+01:00",
"SerialNumber": "sample string 11",
"StockItemId": 1,
"AutoGenerateOrder": true,
"NextOrderDate": "2026-01-11T16:13:18.5581996+01:00",
"NextMaintenanceDate": "2026-01-11T16:13:18.5581996+01:00",
"DeletedTimestamp": "2026-01-11T16:13:18.5581996+01:00",
"CreateTimestamp": "2026-01-11T16:13:18.5581996+01:00",
"ChangeTimestamp": "2026-01-11T16:13:18.5581996+01:00",
"OrderDiscountPercentage": 1,
"InternalReference": "sample string 14",
"Type": null,
"Files": [
{
"Id": 1,
"Filename": "sample string 2"
},
{
"Id": 1,
"Filename": "sample string 2"
}
],
"Appointments": null,
"CurrentExpiryDateBattery": "2026-01-11T16:13:18.5581996+01:00",
"CurrentExpiryDateElectrode": "2026-01-11T16:13:18.5581996+01:00",
"CurrentExpiryDatePaediatricElectrode": "2026-01-11T16:13:18.5581996+01:00",
"ProductionYear": 1,
"AutoGenerateServiceAppointment": true,
"Rows": null,
"Id": 15,
"Code": "sample string 16",
"TypeId": 1,
"TypeName": "sample string 17",
"CustomerId": 18,
"CustomerCode": "sample string 19",
"CustomerEmail": "sample string 20",
"StartDate": "2026-01-11T16:13:18.5581996+01:00",
"BrandName": "sample string 21",
"ServiceProductId": 22,
"ServiceProductName": "sample string 23",
"Location": {
"VatNumber": "sample string 1",
"FullName": "sample string 2",
"DateOfBirth": "2026-01-11T16:13:18.5581996+01:00",
"Gender": "sample string 3",
"PersonTitle": "sample string 4",
"MiddleName": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"LastNamePrefix": "sample string 8",
"Id": 9,
"CompanyName": "sample string 10",
"Address": "sample string 11",
"Address2": "sample string 12",
"StreetAddress": "sample string 13",
"StreetAddressNumber": "sample string 14",
"StreetAddressExtension": "sample string 15",
"PostalCode": "sample string 16",
"City": "sample string 17",
"CountryId": 1,
"CountryCode": "sample string 18",
"CountryName": null,
"EMail": "sample string 19",
"Phone": "sample string 20",
"Phone2": "sample string 21",
"StateProvince": "sample string 22",
"StateProvinceCode": "sample string 23"
},
"DeliveryAddress": {
"VatNumber": "sample string 1",
"FullName": "sample string 2",
"DateOfBirth": "2026-01-11T16:13:18.5581996+01:00",
"Gender": "sample string 3",
"PersonTitle": "sample string 4",
"MiddleName": "sample string 5",
"FirstName": "sample string 6",
"LastName": "sample string 7",
"LastNamePrefix": "sample string 8",
"Id": 9,
"CompanyName": "sample string 10",
"Address": "sample string 11",
"Address2": "sample string 12",
"StreetAddress": "sample string 13",
"StreetAddressNumber": "sample string 14",
"StreetAddressExtension": "sample string 15",
"PostalCode": "sample string 16",
"City": "sample string 17",
"CountryId": 1,
"CountryCode": "sample string 18",
"CountryName": null,
"EMail": "sample string 19",
"Phone": "sample string 20",
"Phone2": "sample string 21",
"StateProvince": "sample string 22",
"StateProvinceCode": "sample string 23"
}
}