POST SalesOrder/Save?useSystemDocumentNumber={useSystemDocumentNumber}
Saves the specified Sales Order.
Request Information
URI Parameters
Name | Type | Additional information | Description |
---|---|---|---|
useSystemDocumentNumber | bool |
Default value is True |
Use system Document Number or Document Number provided. |
Body Parameters
The Sales Order.
Sales OrderName | Type | Additional information | Description |
---|---|---|---|
ID | integer |
None. |
|
Date | date |
Required |
|
Inclusive | bool |
None. |
|
DiscountPercentage | decimal |
None. |
|
TaxReference | string |
String length: inclusive between 0 and 30 |
|
DocumentNumber | string |
String length: inclusive between 0 and 100 |
|
Reference | string |
String length: inclusive between 0 and 100 |
|
Message | string |
String length: inclusive between 0 and 8000 |
|
Discount | decimal |
None. |
|
Exclusive | decimal |
None. |
|
Tax | decimal |
None. |
|
Rounding | decimal |
None. |
|
Total | decimal |
None. |
|
AmountDue | decimal |
Data type: Currency |
|
PostalAddress01 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress02 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress03 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress04 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress05 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress01 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress02 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress03 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress04 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress05 | string |
String length: inclusive between 0 and 100 |
|
TaxPeriodId | nullable integer |
Read Only / System Generated |
|
Editable | bool |
Read Only / System Generated |
|
HasAttachments | bool |
Read Only / System Generated |
|
HasNotes | nullable bool |
Read Only / System Generated |
|
HasAnticipatedDate | nullable bool |
Read Only / System Generated |
|
HasSpecialCountryTax | bool |
Read Only / System Generated |
|
AnticipatedDate | nullable date |
Read Only / System Generated |
|
ExternalReference | string |
String length: inclusive between 0 and 100 |
|
UID | globally unique identifier |
Read Only / System Generated |
|
CustomerId | integer |
Required |
|
CustomerName | string |
None. |
|
Customer | Customer |
None. |
|
SalesRepresentativeId | nullable integer |
None. |
|
SalesRepresentative | Sales Representative |
None. |
|
StatusId | nullable integer |
None. |
|
Modified | nullable date |
Read Only / System Generated |
|
Created | date |
Read Only / System Generated |
|
Customer_CurrencyId | nullable integer |
None. |
|
Customer_ExchangeRate | nullable decimal |
None. |
|
DeliveryDate | date |
Required |
The date of when the sales order will be delivered |
AllowOnlineAccept | nullable bool |
Read Only / System Generated |
Customer Zone Payments for Sales Orders are allowed |
Status | string |
Read Only / System Generated |
|
UseForeignCurrency | bool |
None. |
Specify if foreign currency will be used for sales orders |
FromDocument | string |
None. |
|
FromDocumentId | integer |
None. |
|
FromDocumentTypeId | nullable integer |
None. |
|
Lines | Collection of Commercial Document Line |
None. |
Request Formats
application/json, text/json
{ "DeliveryDate": "2024-04-25", "AllowOnlineAccept": true, "Status": "sample string 1", "UseForeignCurrency": true, "FromDocument": "sample string 3", "FromDocumentId": 1, "FromDocumentTypeId": 1, "CustomerId": 4, "CustomerName": "sample string 5", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2024-04-25", "Created": "2024-04-25" }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2024-04-25", "Modified": "2024-04-25" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "CommunicationMethod": 1, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "EnableCustomerZone": true, "CustomerZoneGuid": "1c1dae15-5f0e-4436-b8a1-ed83cd4da1c5", "CashSale": true, "TextField1": "sample string 25", "TextField2": "sample string 26", "TextField3": "sample string 27", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2024-04-25", "DateField2": "2024-04-25", "DateField3": "2024-04-25", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2024-04-25", "Created": "2024-04-25", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2024-04-25", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2024-04-25", "Modified": "2024-04-25", "TaxTypeDefaultUID": "2aad4426-d7a7-4b1c-883c-978999c04a82", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2024-04-25", "Modified": "2024-04-25" }, "StatusId": 1, "Modified": "2024-04-25", "Created": "2024-04-25", "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "ID": 7, "Date": "2024-04-25", "Inclusive": true, "DiscountPercentage": 9.1, "TaxReference": "sample string 10", "DocumentNumber": "sample string 11", "Reference": "sample string 12", "Message": "sample string 13", "Discount": 14.0, "Exclusive": 15.0, "Tax": 16.0, "Rounding": 17.0, "Total": 18.0, "AmountDue": 19.0, "PostalAddress01": "sample string 20", "PostalAddress02": "sample string 21", "PostalAddress03": "sample string 22", "PostalAddress04": "sample string 23", "PostalAddress05": "sample string 24", "DeliveryAddress01": "sample string 25", "DeliveryAddress02": "sample string 26", "DeliveryAddress03": "sample string 27", "DeliveryAddress04": "sample string 28", "DeliveryAddress05": "sample string 29", "Printed": true, "TaxPeriodId": 1, "Editable": true, "HasAttachments": true, "HasNotes": true, "HasAnticipatedDate": true, "HasSpecialCountryTax": true, "AnticipatedDate": "2024-04-25", "ExternalReference": "sample string 34", "UID": "4f59086a-0c38-4259-a116-16f4471cd83c", "Lines": [ { "SelectionId": 1, "TaxTypeId": 1, "ID": 1, "Description": "sample string 2", "LineType": 0, "Quantity": 1.0, "UnitPriceExclusive": 3.0, "Unit": "sample string 4", "UnitPriceInclusive": 5.0, "TaxPercentage": 6.1, "DiscountPercentage": 7.1, "Exclusive": 8.0, "Discount": 9.0, "Tax": 10.0, "Total": 11.0, "Comments": "sample string 12", "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "$TrackingCode": "sample string 13", "CurrencyId": 1, "UnitCost": 1.0, "UID": "f2a83d22-05c8-4ac5-8ac1-59e27c8db1f0" }, { "SelectionId": 1, "TaxTypeId": 1, "ID": 1, "Description": "sample string 2", "LineType": 0, "Quantity": 1.0, "UnitPriceExclusive": 3.0, "Unit": "sample string 4", "UnitPriceInclusive": 5.0, "TaxPercentage": 6.1, "DiscountPercentage": 7.1, "Exclusive": 8.0, "Discount": 9.0, "Tax": 10.0, "Total": 11.0, "Comments": "sample string 12", "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "$TrackingCode": "sample string 13", "CurrencyId": 1, "UnitCost": 1.0, "UID": "f2a83d22-05c8-4ac5-8ac1-59e27c8db1f0" } ] }
Response Information
Resource Description
Sales OrderName | Type | Additional information | Description |
---|---|---|---|
ID | integer |
None. |
|
Date | date |
Required |
|
Inclusive | bool |
None. |
|
DiscountPercentage | decimal |
None. |
|
TaxReference | string |
String length: inclusive between 0 and 30 |
|
DocumentNumber | string |
String length: inclusive between 0 and 100 |
|
Reference | string |
String length: inclusive between 0 and 100 |
|
Message | string |
String length: inclusive between 0 and 8000 |
|
Discount | decimal |
None. |
|
Exclusive | decimal |
None. |
|
Tax | decimal |
None. |
|
Rounding | decimal |
None. |
|
Total | decimal |
None. |
|
AmountDue | decimal |
Data type: Currency |
|
PostalAddress01 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress02 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress03 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress04 | string |
String length: inclusive between 0 and 100 |
|
PostalAddress05 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress01 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress02 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress03 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress04 | string |
String length: inclusive between 0 and 100 |
|
DeliveryAddress05 | string |
String length: inclusive between 0 and 100 |
|
TaxPeriodId | nullable integer |
Read Only / System Generated |
|
Editable | bool |
Read Only / System Generated |
|
HasAttachments | bool |
Read Only / System Generated |
|
HasNotes | nullable bool |
Read Only / System Generated |
|
HasAnticipatedDate | nullable bool |
Read Only / System Generated |
|
HasSpecialCountryTax | bool |
Read Only / System Generated |
|
AnticipatedDate | nullable date |
Read Only / System Generated |
|
ExternalReference | string |
String length: inclusive between 0 and 100 |
|
UID | globally unique identifier |
Read Only / System Generated |
|
CustomerId | integer |
Required |
|
CustomerName | string |
None. |
|
Customer | Customer |
None. |
|
SalesRepresentativeId | nullable integer |
None. |
|
SalesRepresentative | Sales Representative |
None. |
|
StatusId | nullable integer |
None. |
|
Modified | nullable date |
Read Only / System Generated |
|
Created | date |
Read Only / System Generated |
|
Customer_CurrencyId | nullable integer |
None. |
|
Customer_ExchangeRate | nullable decimal |
None. |
|
DeliveryDate | date |
Required |
The date of when the sales order will be delivered |
AllowOnlineAccept | nullable bool |
Read Only / System Generated |
Customer Zone Payments for Sales Orders are allowed |
Status | string |
Read Only / System Generated |
|
UseForeignCurrency | bool |
None. |
Specify if foreign currency will be used for sales orders |
FromDocument | string |
None. |
|
FromDocumentId | integer |
None. |
|
FromDocumentTypeId | nullable integer |
None. |
|
Lines | Collection of Commercial Document Line |
None. |
Response Formats
application/json, text/json
{ "DeliveryDate": "2024-04-25", "AllowOnlineAccept": true, "Status": "sample string 1", "UseForeignCurrency": true, "FromDocument": "sample string 3", "FromDocumentId": 1, "FromDocumentTypeId": 1, "CustomerId": 4, "CustomerName": "sample string 5", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2024-04-25", "Created": "2024-04-25" }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2024-04-25", "Modified": "2024-04-25" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "CommunicationMethod": 1, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "EnableCustomerZone": true, "CustomerZoneGuid": "834e3bd5-089e-47fe-9a67-e764bbd60357", "CashSale": true, "TextField1": "sample string 25", "TextField2": "sample string 26", "TextField3": "sample string 27", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2024-04-25", "DateField2": "2024-04-25", "DateField3": "2024-04-25", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2024-04-25", "Created": "2024-04-25", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2024-04-25", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2024-04-25", "Modified": "2024-04-25", "TaxTypeDefaultUID": "0936678f-0c81-4285-98a5-b8889d2907a6", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2024-04-25", "Modified": "2024-04-25" }, "StatusId": 1, "Modified": "2024-04-25", "Created": "2024-04-25", "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "ID": 7, "Date": "2024-04-25", "Inclusive": true, "DiscountPercentage": 9.1, "TaxReference": "sample string 10", "DocumentNumber": "sample string 11", "Reference": "sample string 12", "Message": "sample string 13", "Discount": 14.0, "Exclusive": 15.0, "Tax": 16.0, "Rounding": 17.0, "Total": 18.0, "AmountDue": 19.0, "PostalAddress01": "sample string 20", "PostalAddress02": "sample string 21", "PostalAddress03": "sample string 22", "PostalAddress04": "sample string 23", "PostalAddress05": "sample string 24", "DeliveryAddress01": "sample string 25", "DeliveryAddress02": "sample string 26", "DeliveryAddress03": "sample string 27", "DeliveryAddress04": "sample string 28", "DeliveryAddress05": "sample string 29", "Printed": true, "TaxPeriodId": 1, "Editable": true, "HasAttachments": true, "HasNotes": true, "HasAnticipatedDate": true, "HasSpecialCountryTax": true, "AnticipatedDate": "2024-04-25", "ExternalReference": "sample string 34", "UID": "451c49e7-9cd5-4f8d-9f1d-bb22aa700749", "Lines": [ { "SelectionId": 1, "TaxTypeId": 1, "ID": 1, "Description": "sample string 2", "LineType": 0, "Quantity": 1.0, "UnitPriceExclusive": 3.0, "Unit": "sample string 4", "UnitPriceInclusive": 5.0, "TaxPercentage": 6.1, "DiscountPercentage": 7.1, "Exclusive": 8.0, "Discount": 9.0, "Tax": 10.0, "Total": 11.0, "Comments": "sample string 12", "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "$TrackingCode": "sample string 13", "CurrencyId": 1, "UnitCost": 1.0, "UID": "54e644ae-27c6-4939-b187-1f1ddb2884c4" }, { "SelectionId": 1, "TaxTypeId": 1, "ID": 1, "Description": "sample string 2", "LineType": 0, "Quantity": 1.0, "UnitPriceExclusive": 3.0, "Unit": "sample string 4", "UnitPriceInclusive": 5.0, "TaxPercentage": 6.1, "DiscountPercentage": 7.1, "Exclusive": 8.0, "Discount": 9.0, "Tax": 10.0, "Total": 11.0, "Comments": "sample string 12", "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "$TrackingCode": "sample string 13", "CurrencyId": 1, "UnitCost": 1.0, "UID": "54e644ae-27c6-4939-b187-1f1ddb2884c4" } ] }