Get All Customers

Call returns all of your customers.

Headers

Property	Value
Request Type	POST
Content Type	application-json
URL	{{EnvironmentURL}}/api/services/app/Customers/GetAll

Please see Environments under Getting Started for test and production environment URLs.

Request Parameters

Property	Type	Description
Filter	string	The general filter to apply
NameFilter	string	The filter to apply to the name
DescriptionFilter	string	The filter to apply to the description
AccountNumberFilter	string	The filter to apply to the account number
CustomerReferenceFilter	string	The filter to apply to the customer reference
Sorting	string	Defines the sorting order
SkipCount	int	The amount of records to skip
MaxResultCount	int	The maximum amount of records to return

Sample Request

If you want to limit your result count use the "MaxResultCount" parameter like so:

{{QA}}/api/services/app/Customers/GetAll?&MaxResultCount=2

If you have a specific search criteria then use the "Filter" parameter like so:

{{QA}}/api/services/app/Customers/GetAll?&Filter=alpha

Response Parameters

Property	Type	Description
TotalCount	int	The amount of customers found matching the filters
Items	Customer	The customer details

Customer

Property	Type	Description
Name	string	The name of this customer
Description	string	The description of this customer
AccountNumber	string	The customer account number
CustomerReference	string	The customer reference
CustomerAddress	CustomerAddress	The saved address for this customer NB. See the address methods below to determine the structure
ContactPerson	ContactPerson	The contact person for this customer
IsDeleted	boolean	Indicates if this customer was deleted. It cannot be used if this is true
Id	int	The customer identifier

ContactPerson

Property	Type	Description
ContactEmail	string	The contact email
ContactNumber	string	The contact number
CustomerId	int	The customer ID
FullName	string	The full name
Surname	string	The surname
TitleId	int	The title identifier NB. See the contact person methods below to determine the title identifier

Sample Response

{
    "result": {
        "totalCount": 2,
        "items": [
            {
                "customer": {
                    "name": "ALPHA TEST 1",
                    "description": null,
                    "accountNumber": null,
                    "customerReference": "123",
                    "customerAddresses": [],
                    "contactPerson": {
                        "contactEmail": "mail@mail",
                        "contactNumber": "0720594864",
                        "customerId": 8106,
                        "fullName": "Abhi",
                        "surname": "Mathew",
                        "titleId": 2
                    },
                    "tenantId": 14041,
                    "organizationRegistrationNumber": "12312323134324324",
                    "isDeleted": false,
                    "deleterUserId": null,
                    "deletionTime": null,
                    "lastModificationTime": null,
                    "lastModifierUserId": null,
                    "creationTime": "2024-07-26T17:35:35.8560926",
                    "creatorUserId": 25943,
                    "id": 8106
                }
            },
            {
                "customer": {
                    "name": "ALPHA TEST 2",
                    "description": null,
                    "accountNumber": null,
                    "customerReference": "123",
                    "customerAddresses": [],
                    "contactPerson": {
                        "contactEmail": "mail@mail",
                        "contactNumber": "0720594864",
                        "customerId": 8107,
                        "fullName": "Abhi",
                        "surname": "Mathew",
                        "titleId": 2
                    },
                    "tenantId": 14041,
                    "organizationRegistrationNumber": "12312323134324324",
                    "isDeleted": false,
                    "deleterUserId": null,
                    "deletionTime": null,
                    "lastModificationTime": null,
                    "lastModifierUserId": null,
                    "creationTime": "2024-07-26T17:45:02.285055",
                    "creatorUserId": 25943,
                    "id": 8107
                }
            }
        ]
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}