POST api/agreements/articleline

Add an article line to agreement.

Request Information

URI Parameters

None.

Body Parameters

AgreementArticleLinePostRequest
NameDescriptionTypeAdditional information
AgreementNumber

integer

None.
ArticleNo

integer

Required
Price

decimal number

None.
DiscountFactor

decimal number

None.
ValidFrom

date

None.
ValidTo

date

None.
CalculatedPrice

boolean

Required
Blocked

boolean

Required

Remarks

If article already exists on agreement the existing line will be updated

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "AgreementNumber": 1,
  "ArticleNo": 2,
  "Price": 1.0,
  "DiscountFactor": 1.0,
  "ValidFrom": "2026-01-21 22:51:04",
  "ValidTo": "2026-01-21 22:51:04",
  "CalculatedPrice": true,
  "Blocked": true
}

application/xml, text/xml

Sample: 
<AgreementArticleLinePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <ArticleNo>2</ArticleNo>
  <Blocked>true</Blocked>
  <CalculatedPrice>true</CalculatedPrice>
  <DiscountFactor>1</DiscountFactor>
  <Price>1</Price>
  <ValidFrom>2026-01-21T22:51:04.9250228+01:00</ValidFrom>
  <ValidTo>2026-01-21T22:51:04.9250228+01:00</ValidTo>
  <AgreementNumber>1</AgreementNumber>
</AgreementArticleLinePostRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgreementArticleLinePostResponse
NameDescriptionTypeAdditional information
Errors

Collection of PostAgreementArticleLineError

None.
Success

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample: 
<AgreementArticleLinePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <Errors>
    <PostAgreementArticleLineError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostAgreementArticleLineError>
    <PostAgreementArticleLineError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostAgreementArticleLineError>
  </Errors>
  <Success>true</Success>
</AgreementArticleLinePostResponse>