Skip to main content

Querying Dealer and Customer Information

Description​

Used to query dealer, sub-dealer, sub-customer, and customer records in your ERP.

Querying a Single Record​

URL:/erp/agent/codeOrErpCode Method: GET

  • Instead of codeOrErpCode, you enter the member’s member code or ERP code.

Header: Do not forget the AccessToken! (See: 2.1 Creating an AccessToken)

    <Tabs>
        <TabItem value="1" label="Sample Response Dealer & Sub-dealer (single)" default>
        ```json
            {
            "id": "d76272b4-7526-416b-afa7-98c5743fbb88",  
            "isActive": true,  
            "name": "Main dealer",  
            "code": "NT44276512",  
            "erpCode": "",  
            "taxNumber": "00000000000",  
            "taxOffice": null,  
            "email": null,  
            "phone": "5000000000",  
            "cityName": null,  
            "districtName": null,  
            "address": null,  
            "parentTenantId": "2e64d939-d56f-4c78-a76f-84d0d445067b",  
            "parentTenantCode": "Test",  
            "parentTenantName": "Test",  
            "isIndividual": true,  
            "paymentExCurrencyType": null,  
            "users": [  
                {  
                    "id": "0dfc31f9-8614-40ef-b055-e72da84f002a",  
                    "name": "User 2",  
                    "surname": ".",  
                    "email": "[email protected]",  
                    "gsm": "5000000000",  
                    "canUseMobile": true,  
                    "description": "",  
                    "roles": [  
                        "Dealer Admin"  
                    ],  
                    "paymentExCurrencyType": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
                    "code": ""  
                },  
                {  
                    "id": "db0b3d24-a678-474c-9134-e73542265a9f",  
                    "name": "Main dealer user",  
                    "surname": ".",  
                    "email": "[email protected]",  
                    "gsm": "5000000000",  
                    "canUseMobile": true,  
                    "description": ".",  
                    "roles": [  
                        "Homepage Role"  
                    ],  
                    "paymentExCurrencyType": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
                    "code": "AYS123456Test"  
                }  
            ]  
        }
        ```
        </TabItem>
        <TabItem value="2" label="Sample Response Customer & Sub-customer (single)">
         ```json
        {  
        "id": "e8362a52-013a-44f9-8479-704eea249095",  
        "isActive": true,  
        "name": "John",  
        "code": "741147",  
        "erpCode": "erpCode",  
        "taxNumber": 00000000000,  
        "taxOffice": "test",  
        "email": "[email protected]",  
        "phone": "5000000000",  
        "cityName": "Adıyaman",  
        "districtName": "Merkez",  
        "address": "test test test",  
        "parentTenantId": "00000000-0000-0000-0000-000000000000",  
        "parentTenantCode": null,  
        "parentTenantName": "Test",  
        "isIndividual": true,  
        "paymentExCurrencyType": "8e6cc739-83e0-4af5-accf-a55476e758c6",  
        "users": null  
        }
        ```
        </TabItem>
        <TabItem value="3" label="Sample cURL">
        ```bash
        curl --location 'https://prodtest_gw.finrota.com/erp/agent/741147' \  
        --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzY29wZSI6WyJjYXR2MS5hcGkiLCJ2ZW5kb3J2MS5hcGkiLCJlcnB2MS5hcGkiXSwiYWN0b3J0Ijoic2VydmljZSIsInJvbGUiOiJzZXJ2aWNlIiwiVW5pcXVlIjoiODI3MGVkYjAtYmMzOC00MmNlLTgzMGUtMWM4YTBkOGM4YmZmIiwiVGVuYW50SWQiOiIyZTY0ZDkzOS1kNTZmLTRjNzgtYTc2Zi04NGQwZDQ0NTA2N2IiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL2V4cGlyYXRpb24iOiI2Mzg5Mzk1NTYyNTc1MTM0NzkiLCJuYmYiOjE3NTgxODYwMjUsImV4cCI6MTc1ODM1ODgyNSwiaWF0IjoxNzU4MTg2MDI1LCJpc3MiOiJzc28uYXBpIiwiYXVkIjoiZWNvenVtLnNzbyJ9.U6DsAzdcA5YPRBqcP16FVDaw2cSN6SShFpiitJcCsyQ'
        ```
        </TabItem>
      </Tabs>

Querying Multiple Records (Listing)​

URL

  • For Dealer/Sub-dealer: /erp/agent?type=dealer\&page=1\&pageSize=10\&name=John+Doe
  • Customer/Sub-customer: erp/agent?type=customer\&page=1\&pageSize=10\&name=John+Doe

Method: GET Header: Do not forget the AccessToken! (See: 2.1 Creating an AccessToken) Filters: You can filter by criteria such as name, code, ERP code, email, phone, TCKN, VKN, username, and user code. If you do not provide filters, results are returned according to pagination.

ParameterDescription
nameCompany name
codeMember code
erpCodeMember ERP code
emailE-mail
phonePhone
tcknTurkish ID Number
vknTax Identification Number

Pagination​

You can organize results using page (which page) and pageSize (how many records per page).

ParameterTypeDefaultDescription
pageint1Page to retrieve
pageSizeint10Records per page

Note:

  • If the Dealer, Sub-dealer, Customer, or Sub-customer is an individual, you will see the TCKN value in the taxNumber field.
  • Address information of Dealer, Sub-dealer, Customer, or Sub-customer members must be complete. If values are missing, you will receive an error.

Sample Response (list)

{  
"data": [  
{  
"id": "e8362a52-013a-44f9-8479-704eea249095",  
"isActive": true,  
"name": "John",  
"code": "741147",  
"erpCode": "erpCode",  
"taxNumber": "00000000000",  
"taxOffice": "test",  
"phone": null,  
"email": "[email protected]",  
"countryCode": null,  
"cityName": "Adıyaman",  
"districtName": "Merkez",  
"address": "test test test",  
"parentTenantId": "2e64d939-d56f-4c78-a76f-84d0d445067b",  
"parentTenantName": "Test",  
"parentTenantCode": "Test",  
"isIndividual": true,  
"paymentExCurrencyType": "8e6cc739-83e0-4af5-accf-a55476e758c6"  
}  
],  
"currentPage": 1,  
"rowCount": 1,  
"pageCount": 1  
}