GET api/Agreements/{agreementNumber}

Gets an agreement with specified number, including agreement lines.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
PriceListName

string

Required

Max length: 50
ZoneName

string

Max length: 96
AgreementArticleLines

Collection of AgreementArticleLineResponse

None.
ArticleGroupLines

Collection of ArticleGroupLineResponse

None.
Number

integer

Required
Name

string

Required

Max length: 40
BranchId

integer

Required
ValidFrom

date

Required
ValidTo

date

Required
GeneralAgreementNo

integer

None.
PriceListId

globally unique identifier

Required
FixedArticlePrices

boolean

Required
FixedArticlePricesUntil

date

None.
ZoneId

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": "2026-01-21 22:52:01",
      "ValidTo": "2026-01-21 22:52:01",
      "CalculatedPrice": true,
      "Blocked": true
    },
    {
      "ArticleNo": 1,
      "Price": 1.0,
      "DiscountFactor": 1.0,
      "ValidFrom": "2026-01-21 22:52:01",
      "ValidTo": "2026-01-21 22:52:01",
      "CalculatedPrice": true,
      "Blocked": true
    }
  ],
  "ArticleGroupLines": [
    {
      "Id": "0b2ef05f-2677-4fd3-94f1-a81440880f3b",
      "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": "0b2ef05f-2677-4fd3-94f1-a81440880f3b",
      "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": "2026-01-21 22:52:01",
  "ValidTo": "2026-01-21 22:52:01",
  "GeneralAgreementNo": 1,
  "PriceListId": "9493ee98-42a1-4dde-b813-94bf47b9819b",
  "FixedArticlePrices": true,
  "FixedArticlePricesUntil": "2026-01-21 22:52:01",
  "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>2026-01-21T22:52:01.5300799+01:00</FixedArticlePricesUntil>
  <GeneralAgreementNo>1</GeneralAgreementNo>
  <Name>sample string 4</Name>
  <Number>3</Number>
  <PriceListId>9493ee98-42a1-4dde-b813-94bf47b9819b</PriceListId>
  <ValidFrom>2026-01-21T22:52:01.5300799+01:00</ValidFrom>
  <ValidTo>2026-01-21T22:52:01.5300799+01:00</ValidTo>
  <ZoneId>1</ZoneId>
  <AgreementArticleLines>
    <AgreementArticleLineResponse>
      <ArticleNo>1</ArticleNo>
      <Blocked>true</Blocked>
      <CalculatedPrice>true</CalculatedPrice>
      <DiscountFactor>1</DiscountFactor>
      <Price>1</Price>
      <ValidFrom>2026-01-21T22:52:01.5300799+01:00</ValidFrom>
      <ValidTo>2026-01-21T22:52:01.5300799+01:00</ValidTo>
    </AgreementArticleLineResponse>
    <AgreementArticleLineResponse>
      <ArticleNo>1</ArticleNo>
      <Blocked>true</Blocked>
      <CalculatedPrice>true</CalculatedPrice>
      <DiscountFactor>1</DiscountFactor>
      <Price>1</Price>
      <ValidFrom>2026-01-21T22:52:01.5300799+01:00</ValidFrom>
      <ValidTo>2026-01-21T22:52:01.5300799+01: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>0b2ef05f-2677-4fd3-94f1-a81440880f3b</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>0b2ef05f-2677-4fd3-94f1-a81440880f3b</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>