GET api/Agreements/{agreementNumber}
Gets an agreement with specified number, including agreement lines.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| agreementNumber |
Agreement number to fetch |
integer |
Required |
Body Parameters
None.
Remarks
404 Not found is returned if the specified article cannot be found.
Example
None.
Response Information
Resource Description
AgreementResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PriceListName | string |
Required Max length: 50 |
|
| ZoneName | string |
Max length: 96 |
|
| AgreementArticleLines | Collection of AgreementArticleLineResponse |
None. |
|
| ArticleGroupLines | Collection of ArticleGroupLineResponse |
None. |
|
| Number |
Agreement number |
integer |
Required |
| Name |
Name of the agreement |
string |
Required Max length: 40 |
| BranchId |
Id of the branch |
integer |
Required |
| ValidFrom |
Date when agreement is valid from |
date |
Required |
| ValidTo |
Date when agreement is not valid anymore |
date |
Required |
| GeneralAgreementNo |
Agreementnumber for the main agreement |
integer |
None. |
| PriceListId |
Id of the price list |
globally unique identifier |
Required |
| FixedArticlePrices |
If true: Articleprice can't be changed on an order |
boolean |
Required |
| FixedArticlePricesUntil |
Date for how long the article prices may not be changed |
date |
None. |
| ZoneId |
Id of the zone |
integer |
None. |
| Document | string |
Max length: 4000 |
Response Formats
application/json, text/json
Sample:
{
"PriceListName": "sample string 1",
"ZoneName": "sample string 2",
"AgreementArticleLines": [
{
"ArticleNo": 1,
"Price": 1.0,
"DiscountFactor": 1.0,
"ValidFrom": "12/21/2025 1:06:18 PM",
"ValidTo": "12/21/2025 1:06:18 PM",
"CalculatedPrice": true,
"Blocked": true
},
{
"ArticleNo": 1,
"Price": 1.0,
"DiscountFactor": 1.0,
"ValidFrom": "12/21/2025 1:06:18 PM",
"ValidTo": "12/21/2025 1:06:18 PM",
"CalculatedPrice": true,
"Blocked": true
}
],
"ArticleGroupLines": [
{
"Id": "fae499df-2cac-465b-949b-3453cf7b85af",
"MainGroupName": "sample string 2",
"SubGroupName": "sample string 3",
"SpeedRatingId": 1,
"SpeedRatingKey": "sample string 4",
"AspectRatio": 1.0,
"Pattern": "sample string 5",
"RimDiameter": 1.0,
"Design": "sample string 6",
"CalculatedPrice": true,
"MainGroupId": 8,
"SubGroupId": 9,
"DiscountFactor": 10.0
},
{
"Id": "fae499df-2cac-465b-949b-3453cf7b85af",
"MainGroupName": "sample string 2",
"SubGroupName": "sample string 3",
"SpeedRatingId": 1,
"SpeedRatingKey": "sample string 4",
"AspectRatio": 1.0,
"Pattern": "sample string 5",
"RimDiameter": 1.0,
"Design": "sample string 6",
"CalculatedPrice": true,
"MainGroupId": 8,
"SubGroupId": 9,
"DiscountFactor": 10.0
}
],
"Number": 3,
"Name": "sample string 4",
"BranchId": 1,
"ValidFrom": "12/21/2025 1:06:18 PM",
"ValidTo": "12/21/2025 1:06:18 PM",
"GeneralAgreementNo": 1,
"PriceListId": "b7fa3404-71f4-4c93-81e8-866dc632e7bb",
"FixedArticlePrices": true,
"FixedArticlePricesUntil": "12/21/2025 1:06:18 PM",
"ZoneId": 1,
"Document": "sample string 9"
}
application/xml, text/xml
Sample:
<AgreementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
<BranchId>1</BranchId>
<Document>sample string 9</Document>
<FixedArticlePrices>true</FixedArticlePrices>
<FixedArticlePricesUntil>2025-12-21T13:06:18.1212108+00:00</FixedArticlePricesUntil>
<GeneralAgreementNo>1</GeneralAgreementNo>
<Name>sample string 4</Name>
<Number>3</Number>
<PriceListId>b7fa3404-71f4-4c93-81e8-866dc632e7bb</PriceListId>
<ValidFrom>2025-12-21T13:06:18.1212108+00:00</ValidFrom>
<ValidTo>2025-12-21T13:06:18.1212108+00:00</ValidTo>
<ZoneId>1</ZoneId>
<AgreementArticleLines>
<AgreementArticleLineResponse>
<ArticleNo>1</ArticleNo>
<Blocked>true</Blocked>
<CalculatedPrice>true</CalculatedPrice>
<DiscountFactor>1</DiscountFactor>
<Price>1</Price>
<ValidFrom>2025-12-21T13:06:18.1212108+00:00</ValidFrom>
<ValidTo>2025-12-21T13:06:18.1212108+00:00</ValidTo>
</AgreementArticleLineResponse>
<AgreementArticleLineResponse>
<ArticleNo>1</ArticleNo>
<Blocked>true</Blocked>
<CalculatedPrice>true</CalculatedPrice>
<DiscountFactor>1</DiscountFactor>
<Price>1</Price>
<ValidFrom>2025-12-21T13:06:18.1212108+00:00</ValidFrom>
<ValidTo>2025-12-21T13:06:18.1212108+00:00</ValidTo>
</AgreementArticleLineResponse>
</AgreementArticleLines>
<ArticleGroupLines>
<ArticleGroupLineResponse>
<AspectRatio i:nil="true" />
<CalculatedPrice>false</CalculatedPrice>
<Design i:nil="true" />
<DiscountFactor>10</DiscountFactor>
<MainGroupId>8</MainGroupId>
<Pattern i:nil="true" />
<RimDiameter i:nil="true" />
<SpeedRatingId i:nil="true" />
<SubGroupId>9</SubGroupId>
<AspectRatio>1</AspectRatio>
<CalculatedPrice>true</CalculatedPrice>
<Design>sample string 6</Design>
<Id>fae499df-2cac-465b-949b-3453cf7b85af</Id>
<MainGroupName>sample string 2</MainGroupName>
<Pattern>sample string 5</Pattern>
<RimDiameter>1</RimDiameter>
<SpeedRatingId>1</SpeedRatingId>
<SpeedRatingKey>sample string 4</SpeedRatingKey>
<SubGroupName>sample string 3</SubGroupName>
</ArticleGroupLineResponse>
<ArticleGroupLineResponse>
<AspectRatio i:nil="true" />
<CalculatedPrice>false</CalculatedPrice>
<Design i:nil="true" />
<DiscountFactor>10</DiscountFactor>
<MainGroupId>8</MainGroupId>
<Pattern i:nil="true" />
<RimDiameter i:nil="true" />
<SpeedRatingId i:nil="true" />
<SubGroupId>9</SubGroupId>
<AspectRatio>1</AspectRatio>
<CalculatedPrice>true</CalculatedPrice>
<Design>sample string 6</Design>
<Id>fae499df-2cac-465b-949b-3453cf7b85af</Id>
<MainGroupName>sample string 2</MainGroupName>
<Pattern>sample string 5</Pattern>
<RimDiameter>1</RimDiameter>
<SpeedRatingId>1</SpeedRatingId>
<SpeedRatingKey>sample string 4</SpeedRatingKey>
<SubGroupName>sample string 3</SubGroupName>
</ArticleGroupLineResponse>
</ArticleGroupLines>
<PriceListName>sample string 1</PriceListName>
<ZoneName>sample string 2</ZoneName>
</AgreementResponse>
