GET api/Contracts/{id}
Gets a specific contract by id. <br/> Not implemented.<br/>
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Remarks
404 Not found is returned if the specified contract can not be found.
Example
None.
Response Information
Resource Description
ContractResponse
ContractResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The Id of the contract. |
integer |
Required |
| CustomerNumber |
Customer number for the contract |
integer |
Required |
| CustomerName |
Name of the customer for the contract |
string |
Required |
| PayingCustomerNumber |
Customer number for the paying customer |
integer |
None. |
| PayingCustomerName |
Name of the paying customer |
string |
None. |
| AdministratorName |
Name of the contact on the contract |
string |
Required |
| AdministratorEmail |
The email for the contact |
string |
Required |
| ContactName |
Name of the contact on the contract |
string |
None. |
| ContactEmail |
The email for the contact |
string |
None. |
| ChangedBy |
By whom the contract was changed. |
string |
Required Max length: 256 |
| ChangedDate |
The date the contract was changed. |
date |
None. |
| CreatedBy |
By whom the contract was created. |
string |
Required Max length: 256 |
| CreatedDate |
The date the contract was created. |
date |
Required |
| DueGraceDays |
The amount of due grace days. Integer. |
integer |
Required |
| Note |
Note related to the contract. |
string |
None. |
| IsActive |
Is set to true if the contract has been activated |
boolean |
None. |
| TerminateDate |
The date the contract will be terminated. |
date |
None. |
| ContractLines |
The article lines that belongs to the contract. |
Collection of ContractLineResponse |
None. |
Response Formats
application/json, text/json
{
"Id": 1,
"CustomerNumber": 2,
"CustomerName": "sample string 3",
"PayingCustomerNumber": 1,
"PayingCustomerName": "sample string 4",
"AdministratorName": "sample string 5",
"AdministratorEmail": "sample string 6",
"ContactName": "sample string 7",
"ContactEmail": "sample string 8",
"ChangedBy": "sample string 9",
"ChangedDate": "12/21/2025 1:03:16 PM",
"CreatedBy": "sample string 10",
"CreatedDate": "12/21/2025 1:03:16 PM",
"DueGraceDays": 12,
"Note": "sample string 13",
"IsActive": true,
"TerminateDate": "12/21/2025 1:03:16 PM",
"ContractLines": [
{
"ContractHeadId": 1,
"Id": 2,
"LineNumber": 3,
"ActivatedDate": "12/21/2025 1:03:16 PM",
"ActivatedBy": "sample string 4",
"ArticleNumber": 5,
"ArticleDescription": "sample string 6",
"Quantity": 7.0,
"Price": 8.0,
"Currency": "sample string 9",
"CreatedDate": "12/21/2025 1:03:16 PM",
"CreatedBy": "sample string 10",
"ChangedDate": "12/21/2025 1:03:16 PM",
"ChangedBy": "sample string 11",
"IsDeleted": true
},
{
"ContractHeadId": 1,
"Id": 2,
"LineNumber": 3,
"ActivatedDate": "12/21/2025 1:03:16 PM",
"ActivatedBy": "sample string 4",
"ArticleNumber": 5,
"ArticleDescription": "sample string 6",
"Quantity": 7.0,
"Price": 8.0,
"Currency": "sample string 9",
"CreatedDate": "12/21/2025 1:03:16 PM",
"CreatedBy": "sample string 10",
"ChangedDate": "12/21/2025 1:03:16 PM",
"ChangedBy": "sample string 11",
"IsDeleted": true
}
]
}
application/xml, text/xml
<ContractResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Contract">
<AdministratorEmail>sample string 6</AdministratorEmail>
<AdministratorName>sample string 5</AdministratorName>
<ChangedBy>sample string 9</ChangedBy>
<ChangedDate>2025-12-21T13:03:16.0644265+00:00</ChangedDate>
<ContactEmail>sample string 8</ContactEmail>
<ContactName>sample string 7</ContactName>
<ContractLines>
<ContractLineResponse>
<ActivatedBy>sample string 4</ActivatedBy>
<ActivatedDate>2025-12-21T13:03:16.0644265+00:00</ActivatedDate>
<ArticleDescription>sample string 6</ArticleDescription>
<ArticleNumber>5</ArticleNumber>
<ChangedBy>sample string 11</ChangedBy>
<ChangedDate>2025-12-21T13:03:16.0644265+00:00</ChangedDate>
<ContractHeadId>1</ContractHeadId>
<CreatedBy>sample string 10</CreatedBy>
<CreatedDate>2025-12-21T13:03:16.0644265+00:00</CreatedDate>
<Currency>sample string 9</Currency>
<Id>2</Id>
<IsDeleted>true</IsDeleted>
<LineNumber>3</LineNumber>
<Price>8</Price>
<Quantity>7</Quantity>
</ContractLineResponse>
<ContractLineResponse>
<ActivatedBy>sample string 4</ActivatedBy>
<ActivatedDate>2025-12-21T13:03:16.0644265+00:00</ActivatedDate>
<ArticleDescription>sample string 6</ArticleDescription>
<ArticleNumber>5</ArticleNumber>
<ChangedBy>sample string 11</ChangedBy>
<ChangedDate>2025-12-21T13:03:16.0644265+00:00</ChangedDate>
<ContractHeadId>1</ContractHeadId>
<CreatedBy>sample string 10</CreatedBy>
<CreatedDate>2025-12-21T13:03:16.0644265+00:00</CreatedDate>
<Currency>sample string 9</Currency>
<Id>2</Id>
<IsDeleted>true</IsDeleted>
<LineNumber>3</LineNumber>
<Price>8</Price>
<Quantity>7</Quantity>
</ContractLineResponse>
</ContractLines>
<CreatedBy>sample string 10</CreatedBy>
<CreatedDate>2025-12-21T13:03:16.0644265+00:00</CreatedDate>
<CustomerName>sample string 3</CustomerName>
<CustomerNumber>2</CustomerNumber>
<DueGraceDays>12</DueGraceDays>
<Id>1</Id>
<IsActive>true</IsActive>
<Note>sample string 13</Note>
<PayingCustomerName>sample string 4</PayingCustomerName>
<PayingCustomerNumber>1</PayingCustomerNumber>
<TerminateDate>2025-12-21T13:03:16.0644265+00:00</TerminateDate>
</ContractResponse>
