添加对手方接口

接口概述

该接口用于在系统中添加或更新对手方信息。

  • 请求方式POST

  • 请求 URLhttps://openapi.elven.com/open/v3/counterparty

请求头参数

参数名类型必填说明

elven-api-key

String

分配给您的API密钥

elven-api-sign

String

请求签名,用于验证请求合法性

elven-api-timestamp

String

请求时间戳,毫秒级

查看详细说明

请求参数

Body 参数(JSON 格式)

参数名类型必填说明

name

String

对手方名称;如果名称已存在且类型相同,则进行更新

platformId

String

对手方所属平台的主键ID,可通过平台查询接口获取

accountNo

String

对手方的地址或账号,可为空

type

String

对手方类型,可选值:INDIVIDUAL(个人)、ORGANIZATION(组织)

tags

Array

标签列表,只进行追加操作,不会覆盖已有标签

memo

String

备注信息

identifications

Array

识别码列表,用于存储对手方的特定标识信息

identifications 数组元素

参数名类型必填说明

name

String

识别码名称;如果名称相同,则 code 会覆盖现有的值

code

String

识别码代码

请求示例

{
    "name": "对手方A",
    "platformId": "platformId123",
    "accountNo": "address123",
    "type": "ORGANIZATION",
    "tags": ["合作伙伴", "重要客户"],
    "memo": "这是一个重要的对手方",
    "identifications": [
        {
            "name": "税号",
            "code": "1234567890"
        },
        {
            "name": "营业执照",
            "code": "ABCDEFGH"
        }
    ]
}

响应参数

参数名类型说明

counterpartyId

String

对手方的主键 ID

响应示例

{
    "counterpartyId": "counterpartyId456"
}

注意事项

  • 请求头中的 elven-api-keyelven-api-signelven-api-timestamp 为必填参数,用于验证请求的合法性和安全性。

  • nametype 为必填字段,必须提供。

  • 如果对手方名称已存在,且类型也相同,则会对现有对手方进行更新操作。

Last updated