API Docs / Schemas / AvailableClientsResponseDto

AvailableClientsResponseDto

Paginated list of clients available for import from a third-party accounting platform.
Includes pagination metadata to support browsing large customer lists.

Properties

Name Type Description
clientsarray of AvailableClientDto

List of clients/customers available for import on the current page

List of clients/customers available for import on the current page

totalCountinteger

Total number of clients available for import across all pages

Total number of clients available for import across all pages

pageNumberinteger

Current page number (1-based)

Current page number (1-based)

pageSizeinteger

Number of clients per page

Number of clients per page

hasMoreboolean

Whether there are more pages of clients to retrieve

Whether there are more pages of clients to retrieve

JSON Example

{
  "clients": [
    {
      "externalId": "...",
      "name": "...",
      "code": "...",
      "email": "...",
      "phone": "..."
    }
  ],
  "totalCount": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "hasMore": false
}

Used By Operations