POST Quote/Save?useSystemDocumentNumber={useSystemDocumentNumber}
Saves the specified Quote.
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 Quote.
QuoteName | 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 |
|
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. |
|
ExpiryDate | date |
Required |
|
AllowOnlineAccept | nullable bool |
None. |
|
Status | string |
None. |
|
UseForeignCurrency | bool |
None. |
|
Lines | Collection of Commercial Document Line |
None. |
Request Formats
application/json, text/json
{ "ExpiryDate": "2022-06-27", "AllowOnlineAccept": true, "Status": "sample string 1", "UseForeignCurrency": true, "CustomerId": 3, "CustomerName": "sample string 4", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2022-06-27", "Created": "2022-06-27" }, "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": "2022-06-27", "Modified": "2022-06-27" }, "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": "b5e2a39f-501b-4d6f-8921-743521391ec7", "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": "2022-06-27", "DateField2": "2022-06-27", "DateField3": "2022-06-27", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2022-06-27", "Created": "2022-06-27", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2022-06-27", "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": "2022-06-27", "Modified": "2022-06-27", "TaxTypeDefaultUID": "874e02d4-bfbf-4c4f-b2f5-15a861067cb7", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "HasSpecialCountryTax": true, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "ID": 39 }, "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": "2022-06-27", "Modified": "2022-06-27" }, "StatusId": 1, "Modified": "2022-06-27", "Created": "2022-06-27", "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "ID": 6, "Date": "2022-06-27", "Inclusive": true, "DiscountPercentage": 8.1, "TaxReference": "sample string 9", "DocumentNumber": "sample string 10", "Reference": "sample string 11", "Message": "sample string 12", "Discount": 13.0, "Exclusive": 14.0, "Tax": 15.0, "Rounding": 16.0, "Total": 17.0, "AmountDue": 18.0, "PostalAddress01": "sample string 19", "PostalAddress02": "sample string 20", "PostalAddress03": "sample string 21", "PostalAddress04": "sample string 22", "PostalAddress05": "sample string 23", "DeliveryAddress01": "sample string 24", "DeliveryAddress02": "sample string 25", "DeliveryAddress03": "sample string 26", "DeliveryAddress04": "sample string 27", "DeliveryAddress05": "sample string 28", "Printed": true, "TaxPeriodId": 1, "Editable": true, "HasAttachments": true, "HasNotes": true, "HasAnticipatedDate": true, "AnticipatedDate": "2022-06-27", "ExternalReference": "sample string 32", "UID": "9b7ce9d2-7e2c-4bde-988f-29ed318c398f", "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": "ed2c251c-dc56-4194-8139-7742a5ff55c9" }, { "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": "ed2c251c-dc56-4194-8139-7742a5ff55c9" } ] }
Response Information
Resource Description
QuoteName | 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 |
|
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. |
|
ExpiryDate | date |
Required |
|
AllowOnlineAccept | nullable bool |
None. |
|
Status | string |
None. |
|
UseForeignCurrency | bool |
None. |
|
Lines | Collection of Commercial Document Line |
None. |
Response Formats
application/json, text/json
{ "ExpiryDate": "2022-06-27", "AllowOnlineAccept": true, "Status": "sample string 1", "UseForeignCurrency": true, "CustomerId": 3, "CustomerName": "sample string 4", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2022-06-27", "Created": "2022-06-27" }, "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": "2022-06-27", "Modified": "2022-06-27" }, "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": "c7e7c5be-a9fe-489b-b2a1-c6463af5e96d", "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": "2022-06-27", "DateField2": "2022-06-27", "DateField3": "2022-06-27", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2022-06-27", "Created": "2022-06-27", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2022-06-27", "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": "2022-06-27", "Modified": "2022-06-27", "TaxTypeDefaultUID": "50a3c8be-7bbe-494e-83b1-0b1a04c3ab63", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "HasSpecialCountryTax": true, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "ID": 39 }, "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": "2022-06-27", "Modified": "2022-06-27" }, "StatusId": 1, "Modified": "2022-06-27", "Created": "2022-06-27", "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "ID": 6, "Date": "2022-06-27", "Inclusive": true, "DiscountPercentage": 8.1, "TaxReference": "sample string 9", "DocumentNumber": "sample string 10", "Reference": "sample string 11", "Message": "sample string 12", "Discount": 13.0, "Exclusive": 14.0, "Tax": 15.0, "Rounding": 16.0, "Total": 17.0, "AmountDue": 18.0, "PostalAddress01": "sample string 19", "PostalAddress02": "sample string 20", "PostalAddress03": "sample string 21", "PostalAddress04": "sample string 22", "PostalAddress05": "sample string 23", "DeliveryAddress01": "sample string 24", "DeliveryAddress02": "sample string 25", "DeliveryAddress03": "sample string 26", "DeliveryAddress04": "sample string 27", "DeliveryAddress05": "sample string 28", "Printed": true, "TaxPeriodId": 1, "Editable": true, "HasAttachments": true, "HasNotes": true, "HasAnticipatedDate": true, "AnticipatedDate": "2022-06-27", "ExternalReference": "sample string 32", "UID": "dc5bfff4-3750-469f-a35c-84c344eb1eca", "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": "b7d3c9bd-7b71-4416-8ba3-be4212031843" }, { "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": "b7d3c9bd-7b71-4416-8ba3-be4212031843" } ] }