SalesAgreementRows

Queryable, Introduced in version 22.7

GET https://localhost:8001/sv/001.1/api/v1/Sales/SalesAgreementRows

Represents an agreement row.

GUID

9EEE0EA1-560D-4530-809D-1B42FEAF6CB7

Required permission

Show agreement

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the row.
ParentRowId Int64? The business key identifier of the rows parent row.
ParentOrderId Int64 The business key identifier of the rows parent agreement.
Position Int64? The position of the row.
OrderRowType Int32 The order row type of the row.

  • Part: 1
  • Additional: 2
  • Sum: 3
  • FreeText: 4
PartId Int64? The business key identifier of the rows part.
AdditionalRowDescription String The additional row description of the row.
Quantity Decimal The quantity of the row.
FutureQuantity Decimal? The future quantity of the row.
PreviousQuantity Decimal? The previous quantity of the row.
ConversionFactor Decimal The conversion factor of the row.
UnitId Int64? The business key identifier of the rows unit.
Unit Units The unit of the row.

  • Expandable
Price Decimal? The price of the row.
PriceCurrencyId Int64? The business key identifier of the rows price currency.
PriceInCompanyCurrency Decimal? The rows price in the company currency.
PriceInCompanyCurrencyCurrencyId Int64? The business key identifier of the company currency.
FuturePriceAmount Decimal? The future price amount of the row.
PreviousPriceAmount Decimal? The previous price amount of the row.
Discount Decimal The discount of the row.
VatRateId Int64 The business key identifier of the rows VAT rate.
FutureValidFrom DateTimeOffset? The future valid from of the row.
PreviousValidThrough DateTimeOffset? The previous valid through of the row.
CustomerPartNumber String The customer part number of the row.

  • Max length is 20
PartRowType Int32 The part row type of the row.

  • NotPartRow: 0
  • RegularRow: 1
  • SubPartRow: 2
  • SetupPriceRow: 3
  • AlloyCostRow: 4
  • PaymentPlanRow: 5
  • PackagingRow: 6
SetupPrice Decimal? The setup price of the row.
SetupPriceCurrencyId Int64? The business key identifier of the rows setup price currency.
SetupPriceInCompanyCurrency Decimal? The setup price in company currency of the row.
SetupPriceInCompanyCurrencyCurrencyId Int64? The business key identifier of the company currency.
ShowFreeTextIn Int32 Specifies which documents the free text data of the row should be projected on.

  • None: 0
  • Quote: 1
  • Acknowledgement: 2
  • DeliveryNote: 4
  • Invoice: 8
  • ProFormaInvoice: 16

  • Bitmask
RevisionId Int64? The business key identifier of the revision of the rows part.
Revision Revisions The revision of the row's part.

  • Expandable
FreeTextHtml String The free text formatted as rich text HTML of the row.
FreeText String The free text as raw text of the row.
LifeCycleState Int32 The life cycle state of the row.

  • Transient: 1
  • Persistent: 10
  • History: 20
  • RemovableCandidate: 99
QuantityRatio Decimal? The quantity ratio of the row.
CodingId Int64? The business key identifier of the rows coding.
Coding Codings The coding of the row.

  • Expandable
DeliveryDate DateTimeOffset? The delivery date of the row.
CompensatedRowId Int64? The business key identifier of the row compensated for this row.
OneTimeCostType Int32 The one time cost type of the row.

  • No: 0
  • AddToExistingAgreementBasis: 1
  • CreateNewAgreementBasis: 2
PeriodStart DateTimeOffset? The period start of the row.
PeriodEnd DateTimeOffset? The period end of the row.
PlannedInvoiceDate DateTimeOffset? The planned invoice date of the row.
StandardPrice Decimal? The standard price of the row.
StandardPriceCurrencyId Int64? The business key identifier of the rows standard price currency.
FutureDiscount Decimal? The future discount of the row.
PreviousDiscount Decimal? The previous discount of the row.
IsAccrual Boolean Indicates if the row is accrual.
ValidFrom DateTimeOffset? The valid from date of the row.
ValidTo DateTimeOffset? The valid to date of the row.
FuturePriceInCompanyCurrencyAmount Decimal? The future price in company currency amount of the row.
PreviousPriceInCompanyCurrencyAmount Decimal? The previous price in company currency amount of the row.
EntityIdentityString String The entity identity string of the row.

  • Max length is 20
ExtraFieldBool Boolean An extra field of type bool.
 Introduced in version 23.8
ExtraFieldInteger Int32? An extra field of type integer.
 Introduced in version 23.8
ExtraFieldDecimal Decimal? An extra field of type decimal.
 Introduced in version 23.8
ExtraFieldDate DateTimeOffset? An extra field of type date.
 Introduced in version 23.8
ExtraFieldText String An extra field of type text.

  • Max length is 80
 Introduced in version 23.8

Example

{
  "Id": 0,
  "ParentRowId": null,
  "ParentOrderId": 0,
  "Position": null,
  "OrderRowType": 0,
  "PartId": null,
  "AdditionalRowDescription": null,
  "Quantity": 0.0,
  "FutureQuantity": null,
  "PreviousQuantity": null,
  "ConversionFactor": 0.0,
  "UnitId": null,
  "Unit": null,
  "Price": null,
  "PriceCurrencyId": null,
  "PriceInCompanyCurrency": null,
  "PriceInCompanyCurrencyCurrencyId": null,
  "FuturePriceAmount": null,
  "PreviousPriceAmount": null,
  "Discount": 0.0,
  "VatRateId": 0,
  "FutureValidFrom": null,
  "PreviousValidThrough": null,
  "CustomerPartNumber": null,
  "PartRowType": 0,
  "SetupPrice": null,
  "SetupPriceCurrencyId": null,
  "SetupPriceInCompanyCurrency": null,
  "SetupPriceInCompanyCurrencyCurrencyId": null,
  "ShowFreeTextIn": 0,
  "RevisionId": null,
  "Revision": null,
  "FreeTextHtml": null,
  "FreeText": null,
  "LifeCycleState": 0,
  "QuantityRatio": null,
  "CodingId": null,
  "Coding": null,
  "DeliveryDate": null,
  "CompensatedRowId": null,
  "OneTimeCostType": 0,
  "PeriodStart": null,
  "PeriodEnd": null,
  "PlannedInvoiceDate": null,
  "StandardPrice": null,
  "StandardPriceCurrencyId": null,
  "FutureDiscount": null,
  "PreviousDiscount": null,
  "IsAccrual": false,
  "ValidFrom": null,
  "ValidTo": null,
  "FuturePriceInCompanyCurrencyAmount": null,
  "PreviousPriceInCompanyCurrencyAmount": null,
  "EntityIdentityString": null,
  "ExtraFieldBool": false,
  "ExtraFieldInteger": null,
  "ExtraFieldDecimal": null,
  "ExtraFieldDate": null,
  "ExtraFieldText": null
}