Skip to main content

Current Account Listing

  • Endpoint: /vendor/currentAccount
  • HTTP Method: GET
  • Request Content-Type: application/json
  • Response Content-Type: application/json
  • Authorization: Valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)

Description

This service is used to list all current account records defined in the system. Optionally, by providing the dealerCode parameter, accounts belonging to a specific dealer can be filtered.

Results are returned with pagination support.

Note: This endpoint is for listing only. Creating or updating records cannot be performed through this service.

Header Information

Header NameRequiredDescription
AuthorizationYesValid token in Bearer {AccessToken} format
Content-TypeYesapplication/json

Query Parameters

ParameterTypeRequiredDescription
dealerCodestringNoIf provided, only current accounts of the specified dealer will be listed.
pageintegerNoPage number to retrieve (default: 1).
pageSizeintegerNoNumber of records per page (default: 10, maximum: 100).

Example Request GET /vendor/currentAccounts?dealerCode=VEND001&page=1&pageSize=20

Successful Response (200 OK)

{  
"isSuccess": true,
"message": "Records listed successfully.",
"totalCount": 2,
"page": 1,
"pageSize": 20,
"data": [
{
"code": "CA-001",
"currencyCode": "USD",
"currentAccountType": "Customer",
"customerOrDealerCode": "CUST-123",
"customerOrDealerName": "ABC Ltd.",
"description": "International customer account",
"erpCode": "ERP-ACC-001",
"isVisibleOnPayment": true,
"accountName": "ABC Ltd. Foreign Trade",
"taxNumber": "00000000000",
"tcknNumber": null,
"title": "Main Customer Account"
},
{
"code": "CA-002",
"currencyCode": "TRY",
"currentAccountType": "Dealer",
"customerOrDealerCode": "VEND-456",
"customerOrDealerName": "XYZ Dealer",
"description": "Domestic dealer account",
"erpCode": "ERP-ACC-002",
"isVisibleOnPayment": false,
"accountName": "XYZ Trade",
"taxNumber": "00000000000",
"tcknNumber": null,
"title": "Dealer Account"
}
]
}

Notes & Best Practices

  • If dealerCode is not provided, all current accounts in the system will be listed.
  • Pagination can be controlled using page and pageSize parameters; recommended for large datasets for performance.
  • The totalCount value returns the total number of filtered records.
  • Accounts with isVisibleOnPayment = true can be displayed on payment screens.
  • Every response includes isSuccess and message fields.
  • If the token has expired, the request returns 401 Unauthorized; a new token must be obtained.