PUT api/agreements/articleline

Updates an article line on agreement.

Request Information

URI Parameters

None.

Body Parameters

AgreementArticleLinePutRequest
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

Add line if it doesn't exist

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: 
<AgreementArticleLinePutRequest 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.3769865+01:00</ValidFrom>
  <ValidTo>2026-01-21T22:51:04.3769865+01:00</ValidTo>
  <AgreementNumber>1</AgreementNumber>
</AgreementArticleLinePutRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgreementArticleLinePutResponse
NameDescriptionTypeAdditional information
Errors

Collection of PutAgreementArticleLineError

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: 
<AgreementArticleLinePutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Agreement">
  <Errors>
    <PutAgreementArticleLineError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PutAgreementArticleLineError>
    <PutAgreementArticleLineError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PutAgreementArticleLineError>
  </Errors>
  <Success>true</Success>
</AgreementArticleLinePutResponse>