GET Customer/Get?includeSalesRepDetails={includeSalesRepDetails}

Gets a list of Customers. Excludes records where Personal Information was cleared.
Request Information

This method supports OData queries.
URI Parameters

Name	Type	Additional information	Description
includeSalesRepDetails	bool	Default value is False	Optional. If set to true the Customer Sales Representative is included.
Body Parameters

None.
Response Information

Resource Description

This collection is wrapped in a paging response object.
Paging response of Customer
Name	Type	Additional information
TotalResults	integer	None.
ReturnedResults	integer	None.
Results	Collection of Customer	None.
Response Formats

application/json, text/json

Sample:
{
  "TotalResults": 1,
  "ReturnedResults": 2,
  "Results": [
    {
      "Name": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2024-11-15",
        "Created": "2024-11-15"
      },
      "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-11-15",
        "Modified": "2024-11-15"
      },
      "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": "79bc69b4-6689-4726-a2c0-fa278e516e13",
      "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-11-15",
      "DateField2": "2024-11-15",
      "DateField3": "2024-11-15",
      "DefaultPriceListId": 1,
      "DefaultPriceList": {
        "ID": 1,
        "Description": "sample string 2",
        "IsDefault": true
      },
      "DefaultPriceListName": "sample string 2",
      "AcceptsElectronicInvoices": true,
      "Modified": "2024-11-15",
      "Created": "2024-11-15",
      "BusinessRegistrationNumber": "sample string 34",
      "TaxStatusVerified": "2024-11-15",
      "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-11-15",
        "Modified": "2024-11-15",
        "TaxTypeDefaultUID": "d951e166-3151-4b27-a24b-298527a5f73d",
        "CompanyId": 9
      },
      "DueDateMethodId": 1,
      "DueDateMethodValue": 1,
      "CityId": 1,
      "AccountingAgreement": true,
      "HasSpecialCountryTaxActivity": true,
      "OutstandingInvoices": true,
      "OverdueInvoices": true,
      "OnHold": true,
      "ExcludeFromDebtorsManager": true,
      "SubjectToDRCVat": true,
      "ID": 40
    },
    {
      "Name": "sample string 1",
      "Category": {
        "Description": "sample string 1",
        "ID": 2,
        "Modified": "2024-11-15",
        "Created": "2024-11-15"
      },
      "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-11-15",
        "Modified": "2024-11-15"
      },
      "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": "79bc69b4-6689-4726-a2c0-fa278e516e13",
      "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-11-15",
      "DateField2": "2024-11-15",
      "DateField3": "2024-11-15",
      "DefaultPriceListId": 1,
      "DefaultPriceList": {
        "ID": 1,
        "Description": "sample string 2",
        "IsDefault": true
      },
      "DefaultPriceListName": "sample string 2",
      "AcceptsElectronicInvoices": true,
      "Modified": "2024-11-15",
      "Created": "2024-11-15",
      "BusinessRegistrationNumber": "sample string 34",
      "TaxStatusVerified": "2024-11-15",
      "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-11-15",
        "Modified": "2024-11-15",
        "TaxTypeDefaultUID": "d951e166-3151-4b27-a24b-298527a5f73d",
        "CompanyId": 9
      },
      "DueDateMethodId": 1,
      "DueDateMethodValue": 1,
      "CityId": 1,
      "AccountingAgreement": true,
      "HasSpecialCountryTaxActivity": true,
      "OutstandingInvoices": true,
      "OverdueInvoices": true,
      "OnHold": true,
      "ExcludeFromDebtorsManager": true,
      "SubjectToDRCVat": true,
      "ID": 40
    }
  ]
}