Spendia开放接口

追加客户信息

接口描述

此接口用于使用中间件同步追加客户信息

请求URI

/api/openapi/customer

请求方式

POST

请求体示例

{
  "companyCode": "3",
  "typeCode": "1",
  "code": "1111",
  "name": "取引先名",
  "halfKanaName": "1",
  "effectiveDate": "2024-02-01",
  "isCounterparty": true,
  "isPayer": true,
  "payerCode": null,
  "status": true,
  "selectBankMethod": "1002",
  "collectionTermCode": null,
  "selectCollectionMethod": "Y",
  "collectionMethods": null,
  "defaultCollectionMethod": "1",
  "tradingConditions": null,
  "contact": {
    "legalRepresentative": "11",
    "name": "12345",
    "phone": "9999999999",
    "email": "2345@qq.com",
    "fax": "12345678",
    "address": "2323",
    "halfKanaAddress": "23423434",
    "postalCode": "213214",
    "remark": "00000",
    "remarkForInquiry": "00000000"
  },
  "principalDepartment": {
    "departmentCode": "0219",
    "phoneNumber": "66662222",
    "address": "アドレス１",
    "email": "66663333@function-test.com"
  },
  "principalUser": {
    "employeeNo": "1016",
    "phoneNumber": "66661111",
    "email": "66661111@funxtionn.com"
  },
  "isPrintCompanySeal": false,
  "customFields": []
}

请求体字段

字段名 类型 必须 主键 约束 说明
companyCode String ○ ○ 最大长度 50 公司编码
typeCode String ○ ○ 最大长度 50 客户类型代码
code String ○ 最大长度 50 客户编码
name String 最大长度 50 客户名称
halfKanaName String 最大长度 50 客户名称半角假名
effectiveDate Date yyyy-mm-dd 启用日期
isCounterparty Boolean 交易方flag
isPayer Boolean 付款方flag
payerCode String 最大50文字 付款方编码
status Boolean 状态
selectBankMethod String 固定4文字 可选银行方式
1001：从公司
1002：从客户
collectionTermCode String 值列表 收款条件
收款条件的值列表项编码
selectCollectionMethod String 可选收款方式
Y：全部(默认)
N：部分
collectionMethods List 部分收款方式编码列表
defaultCollectionMethod String 默认收款方式编码
tradingConditions String 最大长度 200 交易条件
contact Contact 联系人信息
principalDepartment PrincipalDepartment 责任部门信息
principalUser PrincipalUser 责任人信息
isPrintCompanySeal Boolean 是否打印公司印章
customFields CustomField[] 最大10個 fieldCode不能重复

Contact

字段名 类型 必填 主键 约束 说明
legalRepresentative String 最大长度 30 法人代表
name String 最大长度 30 联系人
phone String 最大长度 20 联系人电话
email String 最大长度 100 邮箱
fax String 最大长度 20 传真
postalCode String 最大长度 10 邮政编码
address String 最大长度 200 地址
halfKanaAddress String 最大长度 200 地址(半角假名)
remark String 最大长度 200 备注
remarkForInquiry String 最大长度 50 备注(查询用)

PrincipalDepartment

字段名 类型 必须 主键 约束 说明
departmentCode String ○ 最大长度 36 责任部门编码
phoneNumber String ○ 最大长度 20 联系方式
责任部门编码有值时，必填
email String ○ 最大长度 100 邮箱
责任部门编码有值时，必填
address String ○ 最大长度 200 地址
责任部门编码有值时，必填

PrincipalUser

字段名 类型 必须 主键 约束 说明
employeeNo String ○ 最大长度 36 担当者
phoneNumber String ○ 最大长度 20 联系方式
责任人编码有值时，必填
email String ○ 最大长度 100 邮箱
责任人编码有值时，必填

CustomField

参数名 类型 必填 主键 约束 说明
fieldCode String ○ ○ 最大长度 50 自定义字段编码
value String 最大长度 200 自定义字段值，如果自定义字段设定为必填，则该值不可为空

接口返回示例

成功

{
    "message": "success",
    "key": "123412"
}

失败示例

{
    "message": "公司不存在或已失效",
    "errorCode": "121310"
}

字段说明

字段名称 类型 说明
message String 返回信息说明
errorCode String 返回错误码

错误代码

errorCode message 说明
120003 缺少必填项:{0}
121310 公司不存在或已失效
121309 公司Code与登录的公司Code不一致
0013 参数:{0},最大长度{1}
SPD.26428.001 客户类型不存在或已失效
120007 编码不合法,包含非法字符
spd.5480.001 {0}只允许半角片假名
6013009 日期格式为:yyyy-MM-dd
SPD.26428.002 付款方编码不存在或已失效
SPD.26428.003 该客户不是付款方
SPD.26428.004 该客户编码已存在
SPD.26428.005 可选银行方式不合法
SPD.26428.006 收款条件不存在或已失效
SPD.26428.007 可选收款方式的值填写不正确
SPD.26428.008 收款方式{0},不存在或已失效
SPD.26428.009 收款方式不存在或已失效
SPD.26428.010 默认收款方式在部分收款方式列表中不存在
SPD.26428.011 可选收款方式为部分时，可选收款方式不能为空
120206 手机号不合法
120210 Email不合法
120234 传真格式不合法
121752 供应商邮政编码字段不合法
SPD.26428.012 责任部门不存在或已失效
SPD.26428.013 责任人不存在或已失效
6061006 自定义字段:{0} 的值填写不正确
SPD.26428.customField.001 客户最多有10个扩展字段
SPD.26428.customField.002 客户扩展字段编码不能为空
SPD.26428.customField.003 客户扩展字段编码不存在:{0}
SPD.26428.customField.004 客户扩展字段编码不能重复
SPD.26428.customField.005 客户扩展字段值不能为空

更新客户信息 →