SalesAgreements

Queryable, Introduced in version 22.7

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

Represents an agreement.

GUID

77CAE1A2-BBC1-405D-9C38-9F8F90950BB8

Required permission

Show agreement

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the agreement.
OrderNumber String The human readable identifier of the agreement.

  • Max length is 15
  • Not nullable
  • Unique
OrderTypeId Int64 The business key identifier of the agreements type.
PeriodStart DateTimeOffset The start period of the agreement.
PeriodEnd DateTimeOffset? The end period of the agreement.
AgreementDate DateTimeOffset? The date of the agreement.
LastNoticeDate DateTimeOffset? The last notice date of the agreement.
TerminationDate DateTimeOffset? The termination date of the agreement.
ExtensionPeriod Int32? The extension period in months of the agreement.
CustomerAgreementNumber String The customers number of the agreement.

  • Max length is 30
Status Int32 The status of the agreement.

  • Negotiation: 1
  • SignedValid: 2
  • Active: 3
  • Terminated: 4
  • Closed: 6
  • Historic: 9
ResponsibleId Int64? The business key identifier of the person responsible of the agreement.
BusinessContactId Int64 The business key identifier of the agreements customer.
BusinessContactReferenceId Int64? The business key identifier of the agreements customer reference.
BusinessContactReferenceName String The customers reference name of the agreement.

  • Max length is 80
OurReferenceId Int64? The business key identifier of our reference on the agreement.
OurReferenceName String Our reference name of the agreement.

  • Max length is 80
Description String The translated description of the agreement.
UseForwardRate Boolean Indicates if the agreement use forward rate.
ExchangeRate Decimal The exchange rate of the agreement.
InternalCommentId Int64? The business key identifier of the agreements internal comment.
InternalComment Comments The internal comment of the agreement.

  • Expandable
ExternalCommentId Int64? The business key identifier of the agreements external comment.
ExternalComment Comments The external comment of the agreement.

  • Expandable
CurrencyId Int64 The business key identifier of the agreements currency.
TermLocation String The term location of the agreement.

  • Max length is 80
InvoicingMethod Int32 The invoicing method of the agreement.

  • InAdvance: 1
  • InArrears: 2
VatGroupId Int64 The business key identifier of the agreements VAT group.
IsAccrual Boolean Indicates if the agreement is accrual.
DefaultOrderPrintoutVia Int32 The default printout method of the agreement.

  • Printer: 0
  • Email: 1
  • Edi: 2
  • None: 9
MailingAddressId Int64? The business key identifier of the agreements mailing address.
MailingAddress Addresses The mailing address of the agreement.

  • Expandable
DeliveryAddressId Int64? The business key identifier of the agreements delivery address.
DeliveryAddress Addresses The delivery address of the agreement.

  • Expandable
CustomerAccountGroupId Int64? The business key identifier of the agreements customers account group.
InvoiceBusinessContactId Int64 The business key identifier of the agreements invoice customer.
ProjectId Int64? The business key identifier of the agreements project.
AftermarketProductRecordId Int64? The business key identifier of the agreements aftermarket product record.
SellerId Int64? The business key identifier of the agreements seller.
Priority Int32 The priority of the agreement.
AccrualAccountId Int64? The business key identifier of the agreements accrual account.
InvoiceCurrentMonth Boolean Indicates if the agreement should be invoiced the current month.
InvoicingInterval Int32 The invoicing interval of the agreement.

  • Monthly: 1
  • EveryOtherMonth: 2
  • Quarterly: 3
  • FourMonthly: 4
  • SemiAnnually: 5
  • Annually: 6
ComprehensiveInvoiceChoice Int32 The comprehensive invoice choice of the agreement.

  • No: 1
  • PerCustomer: 2
ReleaseAgreementBasisAutomatically Boolean Indicates if agreement basis should be released automatically.
PaymentTermId Int64? The business key identifier of the agreements payment term.
PaymentTermDescription String The payment term description of the agreement.

  • Max length is 35
DestinationForDeliveryTerm String The destination for delivery term of the agreement.

  • Max length is 80
GracePeriodInDays Int32? The grace period in days of the agreement.
DeliveryMethodId Int64? The business key identifier of the agreements delivery method.
DeliveryMethodDescription String The delivery method description of the agreement.

  • Max length is 35
DeliveryTermId Int64? The business key identifier of the delivery term of the agreement.
DeliveryTermDescription String The delivery term description of the agreement.

  • Max length is 35
PriceDefinition Int32 The price definition of the agreement.

  • No: 0
  • Day: 1
  • Week: 2
  • Month: 3
  • TwoMonths: 4
  • Quarter: 5
  • FourMonths: 6
  • SixMonths: 7
  • Annual: 8
UpdateStatusAutomatically Boolean Indicates if agreement status should be updated automatically.
Version Int32 The version of the agreement.
NoticePeriod Int32 The notice period of the agreement.
PlannedInvoiceDateOffset Int32 The planned invoice date offset in days of the agreement.
NumberOfYearsToCreateBasisFor Int32 The number of years to create agreement basis for in advance.
CreateAgreementBasis Boolean Indicates if agreement basis should be created.
Rows SalesAgreementRows[] The rows of the agreement.

  • Expandable
LifeCycleState Int32 The life cycle state of the agreement.

  • Transient: 1
  • Persistent: 10
  • History: 20
  • RemovableCandidate: 99

Example

{
  "Id": 0,
  "OrderNumber": null,
  "OrderTypeId": 0,
  "PeriodStart": "0001-01-01T00:00:00+00:00",
  "PeriodEnd": null,
  "AgreementDate": null,
  "LastNoticeDate": null,
  "TerminationDate": null,
  "ExtensionPeriod": null,
  "CustomerAgreementNumber": null,
  "Status": 0,
  "ResponsibleId": null,
  "BusinessContactId": 0,
  "BusinessContactReferenceId": null,
  "BusinessContactReferenceName": null,
  "OurReferenceId": null,
  "OurReferenceName": null,
  "Description": null,
  "UseForwardRate": false,
  "ExchangeRate": 0.0,
  "InternalCommentId": null,
  "InternalComment": null,
  "ExternalCommentId": null,
  "ExternalComment": null,
  "CurrencyId": 0,
  "TermLocation": null,
  "InvoicingMethod": 0,
  "VatGroupId": 0,
  "IsAccrual": false,
  "DefaultOrderPrintoutVia": 0,
  "MailingAddressId": null,
  "MailingAddress": null,
  "DeliveryAddressId": null,
  "DeliveryAddress": null,
  "CustomerAccountGroupId": null,
  "InvoiceBusinessContactId": 0,
  "ProjectId": null,
  "AftermarketProductRecordId": null,
  "SellerId": null,
  "Priority": 0,
  "AccrualAccountId": null,
  "InvoiceCurrentMonth": false,
  "InvoicingInterval": 0,
  "ComprehensiveInvoiceChoice": 0,
  "ReleaseAgreementBasisAutomatically": false,
  "PaymentTermId": null,
  "PaymentTermDescription": null,
  "DestinationForDeliveryTerm": null,
  "GracePeriodInDays": null,
  "DeliveryMethodId": null,
  "DeliveryMethodDescription": null,
  "DeliveryTermId": null,
  "DeliveryTermDescription": null,
  "PriceDefinition": 0,
  "UpdateStatusAutomatically": false,
  "Version": 0,
  "NoticePeriod": 0,
  "PlannedInvoiceDateOffset": 0,
  "NumberOfYearsToCreateBasisFor": 0,
  "CreateAgreementBasis": false,
  "Rows": null,
  "LifeCycleState": 0
}