GET SalesOrder/Get?includeDetail={includeDetail}&includeCustomerDetails={includeCustomerDetails}

Gets a list of sales orders.

Request Information

This method supports OData queries.

URI Parameters

NameTypeAdditional informationDescription
includeDetail bool

Default value is False

Optional. If set to true, include the lines.

includeCustomerDetails bool

Default value is False

Optional. If set to true the Customer is included.

Body Parameters

None.

Response Information

Resource Description

This collection is wrapped in a paging response object.

Paging response of Sales Order
NameTypeAdditional informationDescription
TotalResults integer

None.

ReturnedResults integer

None.

Results Collection of Sales Order

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "DeliveryDate": "2021-10-19",
      "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": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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": "2021-10-19",
          "Modified": "2021-10-19"
        },
        "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": "16c1f6a0-26fe-421e-8958-d7900bfe4798",
        "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": "2021-10-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-19",
        "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": "2021-10-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "e0cb91af-40fe-4d87-856a-a028b0351dc6",
          "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": "2021-10-19",
        "Modified": "2021-10-19"
      },
      "StatusId": 1,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "Customer_CurrencyId": 1,
      "Customer_ExchangeRate": 1.0,
      "ID": 6,
      "Date": "2021-10-19",
      "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": "2021-10-19",
      "ExternalReference": "sample string 32",
      "UID": "db2da01c-a8bf-4013-bbe9-746b6fb80203",
      "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": "1e502f4c-ee13-42de-88ea-3e19ce475b6c"
        },
        {
          "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": "1e502f4c-ee13-42de-88ea-3e19ce475b6c"
        }
      ]
    },
    {
      "DeliveryDate": "2021-10-19",
      "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": "2021-10-19",
          "Created": "2021-10-19"
        },
        "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": "2021-10-19",
          "Modified": "2021-10-19"
        },
        "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": "16c1f6a0-26fe-421e-8958-d7900bfe4798",
        "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": "2021-10-19",
        "DateField2": "2021-10-19",
        "DateField3": "2021-10-19",
        "DefaultPriceListId": 1,
        "DefaultPriceList": {
          "ID": 1,
          "Description": "sample string 2",
          "IsDefault": true
        },
        "DefaultPriceListName": "sample string 2",
        "AcceptsElectronicInvoices": true,
        "Modified": "2021-10-19",
        "Created": "2021-10-19",
        "BusinessRegistrationNumber": "sample string 34",
        "TaxStatusVerified": "2021-10-19",
        "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": "2021-10-19",
          "Modified": "2021-10-19",
          "TaxTypeDefaultUID": "e0cb91af-40fe-4d87-856a-a028b0351dc6",
          "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": "2021-10-19",
        "Modified": "2021-10-19"
      },
      "StatusId": 1,
      "Modified": "2021-10-19",
      "Created": "2021-10-19",
      "Customer_CurrencyId": 1,
      "Customer_ExchangeRate": 1.0,
      "ID": 6,
      "Date": "2021-10-19",
      "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": "2021-10-19",
      "ExternalReference": "sample string 32",
      "UID": "db2da01c-a8bf-4013-bbe9-746b6fb80203",
      "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": "1e502f4c-ee13-42de-88ea-3e19ce475b6c"
        },
        {
          "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": "1e502f4c-ee13-42de-88ea-3e19ce475b6c"
        }
      ]
    }
  ]
}