ekuaibao

https://docs.ekuaibao.com/
Admin
ekuaibao is an enterprise software platform that provides comprehensive Open APIs for managing...
Tokens:504,444
Snippets:1,315
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Application Items List

Source: https://docs.ekuaibao.com/docs/open-api/flows/get-requisition-all

Use this endpoint to retrieve a list of application items. Ensure you have a valid accessToken and provide the staffId, start, count, and state parameters. The state parameter accepts values like FORCE_CLOSED, MANUAL_CLOSED, PROCESS, or ALL.

```bash
curl --location --request POST 'https://app.ekuaibao.com/api/openapi/v1/requisition/getData?accessToken=ID_3zDKigh3izw:bwa3wajigF0WH0&start=0&count=100&staffId=bwa3wajigF0WH0:ID_3lokDfb1p5w&state=PROCESS'
```

--------------------------------

### Get Application List API Request

Source: https://docs.ekuaibao.com/docs/open-api/flows/get-forms-details-byStaff

Example of how to call the Get Application List API using cURL. Ensure you replace placeholder values with your actual accessToken and other parameters.

```bash
curl --location --request GET 'https://app.ekuaibao.com/api/openapi/v1.1/docs/getApplyList?type=requisition&start=0&count=10&state=paid&uid=EZA3rQTD1y23vw:eTM3rQTD1y20vw&accessToken=ID_3z35Otu8qpg:EZA3rQTD1y23vw'
```

--------------------------------

### Successful Response Example

Source: https://docs.ekuaibao.com/docs/open-api/corporation/corporation-info

This is an example of a successful response from the API, returning the corporation's ID and name.

```json
{
	"value": {
		"id": "JOYbpjPP-E2Q00", // 企业id
		"name": "恒达"          // 企业名称
	}
}
```

--------------------------------

### Configure Amortization Component

Source: https://docs.ekuaibao.com/docs/open-api/flows/unify-calculation-and-save

Examples for setting up monthly and daily amortization data within a document.

```json
"amortizes":[  
    {  
        "amortizeForm": {  
            "amortizeDays": 31,  
            "amortizeMonth": 1714492800000,  
            "amortizeMoney": {  
                "standard": "33.33",  
                "standardStrCode": "CNY",  
                "standardNumCode": "156",  
                "standardSymbol": "¥",  
                "standardUnit": "元",  
                "standardScale": 2  
            },  
            "amortizePercent": 33.33,  
            "u_文本": "111",  
        },  
        "specificationId": "ID01zKFMjujB8z_amortize:f1afca93e2fd6be21092b0084ca63b331c565df1"  
    }  
]  
```

```json
{
  "amortizeForm": {
    "amortizeDays": 2,
    "amortizeDateRange": {
      "start": 1717058891815,
      "end": 1717084800000
    },
    "amortizeMoney": {
      "standard": "8.38",
      "standardStrCode": "CNY",
      "standardNumCode": "156",
      "standardSymbol": "¥",
      "standardUnit": "元",
      "standardScale": 2
    },
    "amortizePercent": 4.19,
    "amortizeId": "ID_ef3430akOKQ"
  },
  "specificationId": "ID01zKFMjujB8z_amortize:f1afca93e2fd6be21092b0084ca63b331c565df1"
}
```

--------------------------------

### Get Department List (Including Disabled)

Source: https://docs.ekuaibao.com/updateLog/update-log

Updated failure response examples for getting department lists.

```json
{
  "code": "ERROR_CODE",
  "message": "Error description"
}
```

--------------------------------

### Role Configuration Example

Source: https://docs.ekuaibao.com/docs/open-api/corporation/get-roles

Defines role configuration with path types, paths, and staff details. Use 'name' or 'id' for pathType.

```json
{
    "contents": [             //角色配置情况，每一个元素对应「角色管理」界面右侧列表的一行  
        {  
            "pathType": "name",  
            "path": [          //如果是普通角色，返回空数组。这个节点通过全路径信息来表示一个部门（部门角色）或自定义档案值（档案角色）  
                "测试接口专用",  
                "部门1",  
                "部门1-1"  
            ],  
            "staffs": [        //员工集合，根据“staffBy”显示员工对应的信息  
                "ddd@163.com",  
                ""             //员工没有对应信息时返回空串  
            ],  
            "staffsType": "email" //查询员工信息显示类型  
        },  
        {  
            "pathType": "id",  
            "path": [  
                "bwa3wajigF0WH0",  
                "bwa3wajigF0WH0:ID_3wUvB7G2d3w"  
            ],  
            "staffs": [  
                "youxiang@123.com"  
            ],  
            "staffsType": "email" //查询员工信息显示类型  
        }  
    ]  
}

```

--------------------------------

### POST /budget/create

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

Creates a new budget package and configures budget preparation responsibilities for specific nodes.

```APIDOC
## POST /budget/create

### Description
Creates a new budget package. Requires the 'Budget Preparation' feature to be enabled to configure 'editInChargers'.

### Request Body
- **editInChargers** (array) - Optional - List of budget preparation leads for specific nodes.
  - **nodeId** (string) - Required - Budget node ID.
  - **staffIds** (array) - Optional - List of staff IDs responsible for the node.
  - **roleDefIds** (array) - Optional - List of role definition IDs responsible for the node.

### Response
#### Success Response (200)
- **id** (string) - The ID of the newly created budget package.

#### Response Example
{
    "id": "ID_3D$8ov23ECg"
}

### Error Handling
- **400**: Budget name is duplicated.
- **400**: Employee or department code is not unique.
- **400**: Dimension information error for a specific node ID.
- **400**: Missing or incorrect 'budgetInfo' parameters.
```

--------------------------------

### GET /api/openapi/v1/staffs/authorized

Source: https://docs.ekuaibao.com/docs/open-api/corporation/get-all-auth-staffs

Retrieves a paginated list of activated employees. You can specify the starting point and the number of records to fetch.

```APIDOC
## GET /api/openapi/v1/staffs/authorized

### Description
Retrieves a list of activated employees with support for pagination.

### Method
GET

### Endpoint
/api/openapi/v1/staffs/authorized

### Query Parameters
- **accessToken** (String) - Required - Authentication token obtained via 'Get Authorization'.
- **start** (Number) - Required - The starting index for pagination. Starts from 0.
- **count** (Number) - Required - The number of records to query. Maximum is 100.

### Request Example
```json
{
  "accessToken": "YOUR_ACCESS_TOKEN",
  "start": 0,
  "count": 100
}
```

### Success Response (200)
- **count** (Number) - Total number of activated employees.
- **items** (Array) - An array of activated employee objects.
  - **id** (String) - Employee ID.
  - **name** (String) - Employee name.
  - **nickName** (String) - Employee alias.
  - **code** (String) - Employee code (e.g., employee ID number).
  - **departments** (Array) - List of department IDs the employee belongs to.
  - **defaultDepartment** (String) - The employee's default department ID.
  - **cellphone** (String) - Employee's phone number.
  - **active** (Boolean) - True if the employee is active, false if resigned.
  - **userId** (String) - Third-party platform user ID.
  - **email** (String) - Login email address (converted to lowercase).
  - **showEmail** (String) - Employee's displayed email address.
  - **external** (Boolean) - True if the employee is external.
  - **authState** (Boolean) - True if the account is active and usable.
  - **globalRoaming** (String) - International dialing code.
  - **note** (String) - Remarks or notes.
  - **staffCustomForm** (Object) - Custom fields for the employee.
  - **updateTime** (String) - The time when the employee information was last updated.
  - **createTime** (String) - The time when the employee information was created.

### Response Example
```json
{
  "count": 14,
  "items": [
    {
      "id": "PCx3rwm3aA00qM:ID_3rAZNCY2V$g",
      "name": "李四",
      "nickName": "老四",
      "code": "",
      "departments": [
        "PCx3rwm3aA00qM:ID_3rw$2RXc5lM"
      ],
      "defaultDepartment": "PCx3rwm3aA00qM:ID_3rw$2RXc5lM",
      "cellphone": "",
      "active": true,
      "userId": "ID_3rAZNCY2U$g",
      "email": "cmzhouxiaofeng@xxx.com.cn",
      "showEmail": "Cmzhouxiaofeng@xxx.com.cn",
      "external": false,
      "authState": true,
      "globalRoaming": "+86",
      "note": "notea",
      "staffCustomForm": {
        "base": "[\"{\\\"key\\\":\\\"7370\\\",\\\"label\\\":\\\"山西省/长治/上党区\\\"}\"]",
        "u_数字字段": "1"
      },
      "updateTime": "2022-09-05 10:43:56",
      "createTime": "2022-09-05 10:43:56"
    }
  ]
}
```

### Error Handling
- **200 OK (with empty items)**: Indicates `count` is greater than 0 but no employee data was returned. Verify `start` is less than the total employee count.
- **403 Forbidden**: Indicates unauthorized access. Ensure `accessToken` is valid and not expired. Confirm the base URL is correct for your environment.
```

--------------------------------

### GET /api/openapi/v2/datalink/getPlatform

Source: https://docs.ekuaibao.com/docs/open-api/datalink/get-platform

Retrieves a list of self-built applications. Only enabled applications are returned. Pagination is supported via `start` and `count` parameters.

```APIDOC
## GET /api/openapi/v2/datalink/getPlatform

### Description
Retrieves a list of self-built applications. Only enabled applications are returned. Pagination is supported via `start` and `count` parameters.

### Method
GET

### Endpoint
/api/openapi/v2/datalink/getPlatform

### Parameters
#### Query Parameters
- **accessToken** (String) - Required - Authentication token. Obtain via 'Get Authorization'.
- **start** (Number) - Optional - Data start number. Defaults to 0.
- **count** (Number) - Optional - Number of items per page. Defaults to 20. Maximum is 100.

### Request Example
```json
{
  "accessToken": "YOUR_ACCESS_TOKEN",
  "start": 0,
  "count": 10
}
```

### Response
#### Success Response (200)
- **count** (Number) - The total number of applications returned.
- **items** (Array) - An array of application objects.
  - **pipeline** (Number) - Pipeline identifier.
  - **grayver** (String) - Gray version information.
  - **version** (Number) - Application version.
  - **active** (Boolean) - Whether the application is enabled.
  - **createTime** (Number) - Creation timestamp.
  - **updateTime** (Number) - Update timestamp.
  - **name** (String) - Application name.
  - **nameSpell** (String) - Spelled name of the application.
  - **code** (String) - Application code.
  - **corporationId** (String) - Corporation ID.
  - **sourceCorporationId** (Null) - Source corporation ID.
  - **dataCorporationId** (Null) - Data corporation ID.
  - **icon** (Null) - Application icon.
  - **id** (String) - Application ID.
  - **importMethod** (Array) - Data import methods.
  - **adminIds** (Array) - List of administrator IDs.
  - **type** (String) - Application type (e.g., 'DATA_LINK', 'DETAILS').
  - **groupType** (String) - Application group type (e.g., 'NORMAL', 'SPECIAL').
  - **properties** (Null) - Application properties.
  - **desc** (String) - Description or remarks.
  - **source** (String) - Source of the application (e.g., 'CUSTOM_CREATE').

#### Response Example
```json
{
  "count": 2,
  "items": [
    {
      "pipeline": 1,
      "grayver": "9.20.0.0:A",
      "version": 3,
      "active": true,
      "createTime": 1649405531157,
      "updateTime": 1649748781020,
      "name": "测试",
      "nameSpell": "CESHI",
      "code": "",
      "corporationId": "xgJ3wajigF25H0",
      "sourceCorporationId": null,
      "dataCorporationId": null,
      "icon": null,
      "id": "ID_3D5AKtl07$g",
      "importMethod": [],
      "adminIds": [
        "xgJ3wajigF25H0:dbc3wajigF1UH0",
        "xgJ3wajigF25H0:Xfi3D10oPJ6DqM"
      ],
      "type": "DATA_LINK",
      "groupType": "NORMAL",
      "properties": null,
      "desc": "",
      "source": "CUSTOM_CREATE"
    },
    {
      "pipeline": 1,
      "grayver": "9.8.0.0:A",
      "version": 1,
      "active": true,
      "createTime": 1641969769414,
      "updateTime": 1641969769414,
      "name": "消费明细",
      "nameSpell": "XIAOFEIMINGXI",
      "code": "",
      "corporationId": "xgJ3wajigF25H0",
      "sourceCorporationId": null,
      "dataCorporationId": null,
      "icon": null,
      "id": "ID_3w9HsnE2jq0",
      "importMethod": [],
      "adminIds": [],
      "type": "DETAILS",
      "groupType": "SPECIAL",
      "properties": null,
      "desc": "",
      "source": "CUSTOM_CREATE"
    }
  ]
}
```

#### Error Response
- **400** - Bad Request
  - **Error Code**: -
  - **Description**: The `count` parameter cannot be greater than 100.
  - **Troubleshooting**: Ensure the `count` (items per page) parameter does not exceed 100.
```

--------------------------------

### Get Department By Path CURL Example

Source: https://docs.ekuaibao.com/docs/open-api/contacts/get-department-byPath

Use this CURL command to make a GET request to retrieve department information by its path. Ensure you replace 'z0wbwXPo6sf400' with a valid accessToken and '%E8%B4%A2%E5%8A%A1%E9%83%A8' with the URL-encoded department path.

```curl
curl --location --request GET 'https://app.ekuaibao.com/api/openapi/v1/departments/getDepartmentByPath?accessToken=z0wbwXPo6sf400&path=%E8%B4%A2%E5%8A%A1%E9%83%A8' \
--header 'content-type: application/json' \
--header 'Accept: application/json'
```

--------------------------------

### POST /api/openapi/v2.1/budgets/create

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

Creates a new budget package including budget information, node structures, visibility settings, and budget编制 (compilation) responsibilities.

```APIDOC
## POST /api/openapi/v2.1/budgets/create

### Description
Creates a new budget package with specified configurations, including budget control settings, node hierarchy, and user permissions.

### Method
POST

### Endpoint
https://app.ekuaibao.com/api/openapi/v2.1/budgets/create

### Parameters
#### Query Parameters
- **accessToken** (string) - Required - The authentication token for the API request.
- **type** (string) - Required - The type parameter (e.g., 'code').

#### Request Body
- **budgetInfo** (object) - Required - Contains budget package configuration (active, name, isCustom, isRollCalc, period).
- **addNodes** (array) - Required - List of budget nodes to be created.
- **visibilities** (array) - Optional - Defines node visibility for staff and roles.
- **editInChargers** (array) - Optional - Defines budget compilation responsibilities for staff and roles.

### Request Example
{
  "budgetInfo": {
    "active": true,
    "name": "测试预算-1",
    "isCustom": false,
    "isRollCalc": false,
    "period": {
      "annual": "2022",
      "period": "SEASON",
      "startTime": null,
      "endTime": null
    }
  },
  "addNodes": [
    {
      "id": "20220419",
      "code": "根节点",
      "content": []
    }
  ]
}
```

--------------------------------

### Get Document List by Document ID Set (CURL)

Source: https://docs.ekuaibao.com/docs/open-api/history/flows/get-forms-sequences-ids

Example using CURL to fetch a list of documents by their IDs. Ensure you replace placeholders with actual values and use the correct accessToken and powerCode.

```bash
curl --location -g --request GET 'https://app.ekuaibao.com/api/openapi/v1/docs/[ID_3lztYYX7DJg]?accessToken=ID_3mMbt0x01LM:Urf3lsFgBp00gw&powerCode=219902&type=expense'
```

--------------------------------

### POST /api/openapi/v2.1/budgets/create

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

Creates a new budget package with specified nodes, visibility, and compilation responsibilities.

```APIDOC
## POST /api/openapi/v2.1/budgets/create

### Description
Creates a new budget package in the Ekuaibao system. This endpoint allows defining budget cycles, fiscal year settings, budget nodes, and assigning staff for visibility and compilation.

### Method
POST

### Endpoint
https://app.ekuaibao.com/api/openapi/v2.1/budgets/create

### Parameters
#### Query Parameters
- **accessToken** (string) - Required - Authentication token
- **type** (string) - Required - Type identifier (e.g., "code")

#### Request Body
- **budgetInfo** (object) - Required - Budget package configuration (active, name, isCustom, isRollCalc, isFiscalYear, period)
- **addNodes** (array) - Required - List of budget nodes to add
- **visibilities** (array) - Optional - Budget node visibility settings (staffIds, roleDefIds)
- **editInChargers** (array) - Optional - Budget compilation responsibility settings (staffIds, roleDefIds)

### Request Example
{
  "budgetInfo": {
    "active": false,
    "name": "测试预算-跨财年-自然季度2",
    "isCustom": false,
    "isRollCalc": false,
    "isFiscalYear": true,
    "period": {
      "annual": "2024",
      "period": "SEASON",
      "periodControl": "NATURAL_SEASON",
      "startTime": 1711036800000,
      "endTime": 1738944000000
    }
  },
  "addNodes": [
    {
      "id": "20240120",
      "code": "根节点",
      "content": [],
      "moneys": [
        {
          "budgetMoney": null,
          "nodeId": "20240120",
          "periodTime": "1",
          "periodStartTime": 1710432000000,
          "periodEndTime": 1711900799999
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /api/openapi/v1/dimensions

Source: https://docs.ekuaibao.com/docs/open-api/dimensions/get-dimensions

Retrieves a list of custom archive categories, which are the main categories displayed in the 'Archive Settings > Extended Archives' interface of the Ekuaibao desktop client. For example, 'Project' is a custom archive category.

```APIDOC
## GET /api/openapi/v1/dimensions

### Description
Retrieves a list of custom archive categories.

### Method
GET

### Endpoint
/api/openapi/v1/dimensions

### Query Parameters
- **accessToken** (String) - Required - Authentication token. Obtain this token via 'Get Authorization'.
- **start** (Number) - Required - The starting index for pagination. Note that the starting value is 0.
- **count** (Number) - Required - The number of data items to query. The maximum value is 100.

### Request Example
```json
{
  "accessToken": "hQgbxfJnlElc00",
  "start": 0,
  "count": 100
}
```

### Response
#### Success Response (200)
- **count** (Number) - The total number of archive categories.
- **items** (Array) - An array of archive category objects.
  - **id** (String) - The archive category ID.
  - **name** (String) - The archive category name.
  - **active** (Boolean) - Indicates if the category is active.
  - **code** (String) - The archive category code.

#### Response Example
```json
{
    "count": 3,
    "items": [
        {
              "id": "JOYbpjPP-E2Q00:项目",
              "name": "项目",
              "active": true,
              "code": "DA001"
        },
        {
              "id": "JOYbpjPP-E2Q00:法人实体",
              "name": "法人实体",
              "active": true,
              "code": "FRST"
        },
        {
              "id": "JOYbpjPP-E2Q00:固定资产类目",
              "name": "固定资产类目",
              "active": true,
              "code": "assets"
        }
    ]
}
```

#### Error Response
- **400** - Bad Request: Indicates input errors, such as a missing 'count' parameter. Please ensure the 'count' parameter (number of data items to query) is provided.
```

--------------------------------

### Project Data Structure Example

Source: https://docs.ekuaibao.com/docs/open-api/dimensions/batch-creat-dimension-items

Defines the structure for a project entry, including its name, code, visibility, and associated form data. Use this as a template for creating new project entries.

```json
{
    "name":"项目测试1",                               //档案项名称  
    "code":"XMCS001",                                 //档案项编码  
    "visibility":{                                    //可见范围  
        "fullVisible":false,                          //是否全部可见  
        "staffs": ["1001"],                           //员工CODE（工号）  
        "roles": ["CODE2"],                           //角色CODE  
        "departments": ["BM001"]                      //部门CODE  
    },  
    "parentId":"",                               //父节点CODE  
    "form":{  
        "projectBase":"[{{\"key\":\"8\",\"label\":\"北京市/海淀区\"}}]",  
        "projectInspector":"bwa3wajigF0WH0:ID_3lokDfb1p5w",  
        "projectManager":"bwa3wajigF0WH0:ID_3lokDfb1p5w",  
        "projectType":"ID_3FB3TN25jU0"  
    },  
    "rankType":"CODE1",                                             //职级类型，值为【职级类型预置】档案实例ID或CODE，与 “type” 参数保持一致  
    "postType":"CODE1",                                             //岗位类型，值为【岗位类型预置】档案实例ID或CODE，与 “type” 参数保持一致  
    "baseCurrencyId":"156",                                         //法人实体本位币数字代码，取值见币种设置，只可传系统内配置好的本位币，需要开通【法人实体多币种】功能          
    "taxpayerType":"GeneralTaxpayer"                                //纳税人类型，GeneralTaxpayer:一般纳税人；SmallScaleTaxpayer：小规模纳税人  
},
{
    "name":"项目测试2",                               //档案项名称  
    "code":"XMCS002",                                 //档案项编码  
    "visibility":{                                    //可见范围  
        "fullVisible":false,                          //是否全部可见  
        "staffs": ["1001"],                           //员工CODE（工号）  
        "roles": ["CODE2"],                           //角色CODE  
        "departments": ["BM001"]                      //部门CODE  
    },  
    "parentId":"CODE12"                               //父节点CODE  
}
]
```

--------------------------------

### CURL Request for External Department List

Source: https://docs.ekuaibao.com/docs/open-api/corporation/get-external-department

Use this CURL command to make a GET request to the external department API. Ensure you replace the placeholder accessToken with a valid one. The start and count parameters control pagination.

```bash
curl --location 'https://app.ekuaibao.com/api/openapi/v1/departments/external/department?accessToken=ID01w4CBf6GhmT%3AxgJ3wajigF25H0&start=0&count=10'
```

--------------------------------

### POST /api/openapi/v2.1/budgets/create

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

Creates a new budget package with specified nodes, dimensions, and control rules.

```APIDOC
## POST /api/openapi/v2.1/budgets/create

### Description
Creates a new budget package in the system. The request includes budget information, node hierarchy, and control settings.

### Method
POST

### Endpoint
https://app.ekuaibao.com/api/openapi/v2.1/budgets/create

### Query Parameters
- **accessToken** (string) - Required - The authentication token for the API request.

### Request Body
- **budgetInfo** (object) - Required - Contains budget package configuration (name, active status, period settings).
- **addNodes** (array) - Required - List of budget nodes to be added, including dimensions, money allocations, and control rules.

### Request Example
{
    "budgetInfo": {
        "active": true,
        "name": "测试预算-1",
        "isCustom": false,
        "isRollCalc": false,
        "period": {
            "annual": "2022",
            "period": "SEASON"
        }
    },
    "addNodes": [
        {
            "id": "20220419",
            "code": "根节点",
            "content": [],
            "moneys": [],
            "control": "ALLOW",
            "nodeId": "20220419",
            "parentId": ""
        }
    ]
}
```

--------------------------------

### Create Budget via API

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

cURL command to invoke the budget creation endpoint with authentication and initial budget package metadata.

```bash
curl --location --request POST 'https://app.ekuaibao.com/api/openapi/v2.1/budgets/create?accessToken=ID01wLfbKesbr9%3ATdk3tgber501v0&type=id' \
--header 'Content-Type: application/json' \
--data '{
    "budgetInfo": {                        //预算包信息
        "active": false,                   //是否激活 true : 发布  false : 草稿
        "name": "测试预算-跨财年-自然季度", //预算包名称
```

--------------------------------

### GET /api/openapi/v4/payerInfos/search

Source: https://docs.ekuaibao.com/docs/open-api/pay/get-payerInfos-search

Retrieves a list of payer accounts based on the provided query parameters. Supports filtering by account ID, name, bank card number, and active status. Pagination is available using start and count parameters.

```APIDOC
## GET /api/openapi/v4/payerInfos/search

### Description
Retrieves a list of payer accounts based on the provided query parameters. Supports filtering by account ID, name, bank card number, and active status. Pagination is available using start and count parameters.

### Method
GET

### Endpoint
/api/openapi/v4/payerInfos/search

### Parameters
#### Query Parameters
- **accessToken** (String) - Required - Authentication token obtained via 'Get Authorization'.
- **ids** (String) - Required - Payer account ID. Can be empty, multiple values separated by English commas.
- **names** (String) - Required - Account opening name (not account remark name). Can be empty, multiple values separated by English commas.
- **cardNos** (String) - Required - Bank card number. Can be empty, multiple values separated by English commas.
- **start** (Number) - Optional - Start index for query. Defaults to 0.
- **count** (Number) - Optional - Number of items per page. Maximum is 100. Defaults to 100.
- **active** (Boolean) - Optional - Whether the account is enabled. `true`: enabled, `false`: disabled. Defaults to true.

**Note:** `ids`, `names`, and `cardNos` can be empty but must be present. When all three are provided, they act as an AND condition. To query disabled accounts, use `active = false` along with one of `ids`, `names`, or `cardNos`.

### Request Example
```json
{
  "example": "curl --location --request GET 'https://app.ekuaibao.com/api/openapi/v4/payerInfos/search?accessToken=ID01u8vU7V5leC%3ATdk3tgber501v0&ids=&names=&cardNos=&start=0&count=10&active=true'"
}
```

### Response
#### Success Response (200)
- **count** (Number) - Total number of query results.
- **items** (Array) - List of payer account objects.
  - **pipeline** (Number) - Pipeline information.
  - **grayver** (String) - Gray version.
  - **id** (String) - Payer account ID.
  - **version** (Number) - Version number.
  - **active** (Boolean) - Whether the account is enabled (`true`: enabled, `false`: disabled).
  - **createTime** (Number) - Creation timestamp.
  - **updateTime** (Number) - Update timestamp.
  - **nameSpell** (String) - Name spell.
  - **corporationId** (String) - Corporation ID.
  - **sourceCorporationId** (String or null) - Source corporation ID.
  - **dataCorporationId** (String or null) - Data corporation ID.
  - **name** (String) - Account remark name.
  - **code** (String) - Account code.
  - **accountName** (String) - Account opening name.
  - **accountNo** (String) - Bank card number.
  - **type** (String) - Account type (`PUBLIC`: corporate account, `PERSONAL`: personal account).
  - **owner** (String) - Owner type (`INDIVIDUAL`: individual, `CORPORATION`: enterprise).
  - **sort** (String) - Account category (`BANK`: bank card, `ALIPAY`: Alipay, `OVERSEABANK`: overseas account, `CHECK`: check, `ACCEPTANCEBILL`: acceptance bill, `OTHER`: other, `WALLET`: wallet).
  - **logs** (Array) - Log entries.
  - **staffId** (String or null) - Owner ID for personal accounts.
  - **bank** (String) - Bank name.
  - **icon** (String) - Bank icon URL.
  - **asPayee** (Boolean) - Whether it serves as a payee account (`true`: yes, `false`: no).
  - **asPayer** (Boolean) - Whether it serves as a payer account (`true`: yes, `false`: no).
  - **channels** (Array) - Payment methods (e.g., `OFFLINE`: offline payment).
  - **visibility** (Object) - Visibility settings.
    - **fullVisible** (Boolean) - Whether fully visible (`true`: all visible, `false`: visible to specified personnel).
    - **staffs** (Array) - List of visible staff IDs.
    - **roles** (Array) - List of visible role IDs.
    - **departments** (Array) - List of visible department IDs.
    - **departmentsIncludeChildren** (Boolean) - Whether visible departments include children.
  - **advancedOption** (Object or null) - Advanced options.
  - **defaultChannel** (String) - Default payment channel (`OFFLINE`: offline payment).
  - **bankLinkNo** (String) - Bank linkage number.
  - **certificateType** (String or null) - Certificate type.
  - **certificateNo** (String or null) - Certificate number.
  - **remark** (String) - Remarks.
  - **branch** (String) - Bank branch.
  - **province** (String) - Bank province.
  - **city** (String) - Bank city.
  - **unionIcon** (String or null) - Union icon.
  - **unionBank** (String or null) - Union bank.
  - **extensions** (Object or null) - Extensions.

#### Response Example
```json
{
    "count": 1,
    "items": [
        {
            "pipeline": 1,
            "grayver": "9.30.0.0:A",
            "id": "ID_3GZoeLd1$bM",
            "version": 1,
            "active": true,
            "createTime": 1653562879847,
            "updateTime": 1653562879847,
            "nameSpell": "ZHANGHUBEIZHUMINGCHENG",
            "corporationId": "Urf3lsFgBp00gw",
            "sourceCorporationId": null,
            "dataCorporationId": null,
            "name": "账户备注名称",
            "code": "账户编码",
            "accountName": "测试账户",
            "accountNo": "12345",
            "type": "PUBLIC",
            "owner": "CORPORATION",
            "sort": "BANK",
            "logs": [],
            "staffId": null,
            "bank": "商业银行",
            "icon": "https://images.ekuaibao.com/bank/bank-other.svg",
            "asPayee": false,
            "asPayer": true,
            "channels": [
                "OFFLINE"
            ],
            "visibility": {
                "fullVisible": false,
                "staffs": [
                    "Urf3lsFgBp00gw:ID_3qJdVnbcX9w"
                ],
                "roles": [
                    "Urf3lsFgBp00gw:admin"
                ],
                "departments": [
                    "Urf3lsFgBp00gw:ID_3lvD_Gqk1Eg"
                ],
                "departmentsIncludeChildren": true
            },
            "advancedOption": null,
            "defaultChannel": "OFFLINE",
            "bankLinkNo": "313100000013",
            "certificateType": null,
            "certificateNo": null,
            "remark": "无备注",
            "branch": "北京银行",
            "province": "北京市",
            "city": "北京市",
            "unionIcon": null,
            "unionBank": null,
            "extensions": null
        }
    ]
}
```
```

--------------------------------

### 查询业务对象数据接口调用

Source: https://docs.ekuaibao.com/docs/open-api/datalink-extend/get-entity-ik-crm

使用CURL发送POST请求以获取业务对象数据，需在URL中提供accessToken。

```bash
curl --location --request POST 'https://app.ekuaibao.com/api/openapi/v2/extension/IKCRM/object/contract/search?accessToken=Ts0byCA-_A4M00' \
--header 'content-type: application/json' \
--header 'Accept: application/json' \
--data-raw '{
    "index":1,
    "count":10,
    "ids":["0h89iAv3CQvQ00"]
}'
```

--------------------------------

### Successful Response Example

Source: https://docs.ekuaibao.com/docs/open-api/budget/add-budget

This is the format of a successful response when a new budget package is created, returning its unique ID.

```json
{
    "id": "ID_3D$8ov23ECg"
}
```

--------------------------------

### Successful Response for Get Product List

Source: https://docs.ekuaibao.com/docs/open-api/invoice/ouput-invocing-getArGoodList

This is an example of a successful JSON response from the getArGoodsList API. It includes a 'value' object containing a 'code', 'success' status, and 'data' with product records. Each record contains details like goodsCode, goodsName, taxNo, and taxrate.

```json
{
  "value": {
    "code": 200,
    "success": true,
    "data": {
      "records": [
        {
          "id": "1892780309891956738",
          "createUser": "1678971214676529154",
          "createDept": "1678971214349373441",
          "createTime": "2025-02-21 11:36:07",
          "updateUser": "1678971214676529154",
          "updateTime": "2025-02-21 11:36:07",
          "status": 0,
          "isDeleted": 0,
          "tenantId": "HSKJ",
          "goodsCode": "", //商品编码  
          "goodsName": "蓝月亮健康洗手液5kg大桶补充装 配方温和 家庭酒店车间可用 10斤装", //商品名称  
          "anotherName": "", //商品别名  
          "taxNo": "91320105MA1MULYY44", //纳税人识别号  
          "taxTaxonomyCode": "1070222020000000000", //税收分类编码  
          "taxonomyName": "合成洗涤剂", //税收分类名称  
          "goodsSpecification": "洗手液", //规格型号  
          "goodsUnit": "桶", //计量单位  
          "taxSign": "", //免税类型  
          "isenjoy": "0", //是否享受优惠政策 0：否 1：是  
          "isgxcp": "0",  
          "iscommon": "",  
          "preferentialType": "", //优惠政策类型  
          "taxrate": "0.13", //税率  
          "spbmjc": "洗涤剂", //商品编码简称  
          "goodsType": "", //商品大类  
          "goodsUnitPrice": "",  
          "goodsKey": ""
        }
      ],
      "total": 3,
      "size": 1,
      "current": 1,
      "orders": [],
      "optimizeCountSql": true,
      "searchCount": true,
      "countId": "",
      "maxLimit": "",
      "pages": 3
    },
    "msg": "操作成功"
  }
}
```

--------------------------------

### Error Response Example

Source: https://docs.ekuaibao.com/docs/open-api/invoice/get-invoice-collection-data

Example of a failed API response, indicating an error during invoice processing.

```APIDOC
## Failed Response

```json
{
    "value": {
        "corpId": "EL4c6CdCmAnE00",
        "reqId": "",
        "code": "500",
        "success": false,
        "message": "发票类型格式错误",
        "data": null
    }
}
```
```
Tokens:
Raw