Retrieves customers based on query parameters.

GET 
/Customers

Retrieves customers based on query parameters.

Request

Query Parameters

tin string

Tax Identification Number

api-version string

Header Parameters

X-Request-ID stringrequired

Responses

200

List of customers

application/json

Schema

Schema

• Array [
id int32required
code stringnullablerequired
fullName stringnullablerequired
status CustomerStatus (string)required

Possible values: [Active, Inactive, Pending, Closed, Deceased, Under_Liquidation, Block]

tin stringnullablerequired
category object nullable

oneOf

CustomerCategory

string

Possible values: [Individual, LegalEntity, Other]

• ]

Example (from schema)

[
  {
    "id": 0,
    "code": "string",
    "fullName": "string",
    "status": "Active",
    "tin": "string",
    "category": "Individual"
  }
]

404

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

application/json

Schema

Schema

type stringnullablerequired
title stringnullablerequired
status int32nullablerequired
detail stringnullablerequired
instance stringnullablerequired

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

Loading...