Skip to content

脚本使用手册 - 金蝶 Kingdee API接口调用

操作选项 URL 配置

查看接口 - View

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.View.common.kdsvc

暂存接口 - View

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Draft.common.kdsvc

保存接口 - Save

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.Save.common.kdsvc

单据查询接口 - ExecuteBillQuery

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc

单据查询 (json) 接口 - BillQuery

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BillQuery.common.kdsvc

客户物料对应表接口参数示例

  • FieldKeys 说明
    • FBillNo: 单据编号
    • FDocumentStatus: 单据状态
    • FCustomerId: 客户ID
    • FCustomerId.FNumber: 客户编号
    • FCustMatNo: 客户物料编码
    • FCustMatName: 客户物料名称
    • FMaterialId: 物料编码ID
    • FMaterialId.FNumber: 物料编码
    • FMaterialName: 物料名称
    • FEffective: 启用状态
json5
{
  "data": {
    "FormId": "SAL_CustMatMapping",
    "FieldKeys": "FBillNo,FDocumentStatus,FCustomerId,FCustomerId.FNumber,FCustMatNo,FCustMatName,FMaterialId,FMaterialId.FNumber,FMaterialName,FEffective",
    "FilterString": [
      {
        "FieldName": "FEffective",
        "Compare": "74",
        "Value": true, // 查询启用状态的物料信息
        "Left": "(",
        "Right": ")",
        "Logic": 0
      },
      {
        "FieldName": "FBillNo",
        "Compare": "67",
        "Value": "xxx", // 单据编号, 用于查询指定单据
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      }
    ],
    "OrderString": "",
    "TopRowCount": 0,
    "StartRow": 0,
    "Limit": 2000,
    "SubSystemId": ""
  }
}

查询发货单据信息接口参数示例

  • FieldKeys 说明
    • FBillNo: 单据编号
    • FDocumentStatus: 单据状态
    • FBillTypeID.FNumber: 单据类型
    • FDate: 日期
    • FCustomerId.FNumber: 客户编号
    • FCarriageNO: 运输单号
    • FHeadDeliveryWay: 交货方式
    • FReceiveAddress: 收货方地址
    • FHeadLocId.FNumber: 交货地点
    • FMaterialID.FNumber: 物料编码
    • FMaterialName: 物料名称
    • FUnitID.FNumber: 物料单位
    • FQty: 销售数量
    • FDeliveryLoc: 交货地点
    • FDeliveryLAddress: 交货地址
    • FOrderNo: 订单单号
    • FOrderSeq: 订单行号
    • FCustMatID.FNumber: 客户物料编码
    • FLot.FNumber: 批号
    • FDeliveryDate: 客户要求交货日期
    • FPlanDeliveryDate: 计划发货日期
    • FPrice: 单价
    • FTaxPrice: 含税单价
    • FAmount: 金额
    • FEntryTaxAmount: 税额
    • FAllAmount: 价税合计
json5
{
  "data": {
    "FormId": "SAL_DELIVERYNOTICE",
    "FieldKeys": "FBillNo,FDocumentStatus,FBillTypeID.FNumber,FDate,FCustomerId.FNumber,FCarriageNO,FHeadDeliveryWay,FReceiveAddress,FHeadLocId.FNumber,FMaterialID.FNumber,FMaterialName,FUnitID.FNumber,FQty,FDeliveryLoc,FDeliveryLAddress,FOrderNo,FOrderSeq,FCustMatID.FNumber,FLot.FNumber,FDeliveryDate,FPlanDeliveryDate,FPrice,FTaxPrice,FAmount,FEntryTaxAmount,FAllAmount",
    "FilterString": [
      {
        "FieldName": "FDate",
        "Compare": "3",
        "Value": 60, // 最近60天
        "Left": "(",
        "Right": ")",
        "Logic": 0
      },
      {
        "FieldName": "FCustomerID.FNumber",
        "Compare": "67",
        "Value": "xxx", // 客户编号
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      }
    ],
    "OrderString": "FDate DESC",
    "TopRowCount": 0,
    "StartRow": 0,
    "Limit": 20,
    "SubSystemId": ""
  }
}

查询销售出库单信息接口参数示例

  • FieldKeys 说明
    • FID: ID值,用于更新数据
    • FBillNo: 单据编号
    • FDocumentStatus: 单据状态
    • FBillTypeID.FNumber: 单据类型
    • FDate: 日期(发货日期)
    • FCustomerId.FNumber: 客户编号
    • FCarriageNO: 运输单号
    • FReceiveAddress: 收货方地址
    • FHeadLocationId.FNumber: 交货地点
    • FZXQDNo: 装箱清单单号
    • FCustMatID.FNumber: 客户物料编号
    • FCustMatName: 客户物料名称
    • FMaterialId.FNumber: 物料编码
    • FMaterialName: 物料名称
    • FUnitID.FNumber: 库存单位
    • FMustQty: 应发数量
    • FRealQty: 实发数量
    • FSrcBillNo: 源单编号
    • FSoorDerno: 订单单号
    • FLot.FNumber: 批号
    • FCustMatID.FNumber: 客户物料编码
    • FLot.FNumber: 批号
    • FNote: 备注
    • FPrice: 单价
    • FTaxPrice: 含税单价
    • FAmount: 金额
    • FEntryTaxAmount: 税额
    • FAllAmount: 价税合计
    • F_uc_SyncEdi: 是否允许同步EDI(扩展参数,用于识别是否同步到EDI)
    • F_uc_SyncEdiResult: EDI同步返回结果(用于记录同步结果,默认为空,其他状态: DOING/SUCCESS/FAILURE)
json5
{
  "data": {
    "FormId": "SAL_OUTSTOCK",
    "FieldKeys": "FID,FBillNo,FDocumentStatus,FBillTypeID.FNumber,FDate,FCustomerId.FNumber,FCarriageNO,FReceiveAddress,FHeadLocationId.FNumber,FZXQDNo,FCustMatID.FNumber,FCustMatName,FMaterialId.FNumber,FMaterialName,FUnitID.FNumber,FMustQty,FRealQty,FSrcBillNo,FSoorDerno,FLot.FNumber,FNote,FPrice,FTaxPrice,FAmount,FEntryTaxAmount,FAllAmount,F_uc_SyncEdi,F_uc_SyncEdiResult",
    "FilterString": [
      {
        "FieldName": "FDate",
        "Compare": "3",
        "Value": 60, // 最近60天
        "Left": "(",
        "Right": ")",
        "Logic": 0
      },
      {
        "FieldName": "FCustomerID.FNumber",
        "Compare": "67",
        "Value": "xxx", // 客户编号
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "F_uc_SyncEdi",
        "Compare": "29",
        "Value": "1", // 是否允许同步EDI状态为是
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "F_uc_SyncEdiResult",
        "Compare": "100",
        "Value": "", // 同步结果为空
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      }
    ],
    "OrderString": "FDate DESC",
    "TopRowCount": 0,
    "StartRow": 0,
    "Limit": 10,
    "SubSystemId": ""
  }
}

更新销售出库单发送状态接口参数示例

数据更新原则

  1. 修改保存时,除了构造主键FID、分录主键FEntryId 以及需要修改的字段外,不要构造其他多余字段。
  2. 修改保存时,注意IsDeleteEntry参数非常重要,且默认为true,需小心使用。如为true,则原分录行的FEntryId未在分录json出现的行,将会被删除 (如无需删除分录行,需将参数值改为fasle 或者 json里面传入对应行的FEntryId值)。
json5
{
  "formid": "SAL_OUTSTOCK",
  "data": {
    "IsDeleteEntry": "false",
    "Model": {
      "FId": "100917",
      "F_uc_SyncEdiResult": "DOING"
    }
  }
}

查询装箱清单下达信息接口参数示例

  • FieldKeys 说明
    • FID: ID值,用于更新数据
    • FBillNo: 单据编号
    • FDocumentStatus: 审核状态
    • FCreateDate: 创建时间
    • FComboBox: 单据状态[1-正常]
    • FCustomerName.FNumber: 客户编号
    • FDate2: 计划发货日期
    • FDate3: 发货日期
    • FText11: 装箱单号
    • FBase.FNumber: 物料编号
    • FCustomerNumber: 客户物料编号
    • FProductname: 品名
    • FSalesNumber: 订单号
    • FBOXNumber.FNumber: 箱号
    • FAmount: 数量
    • FsalverNumber: 托盘号
    • FBillNo_SRC: 源单编号
    • FCustNo: 客户订单号
    • FOutBillNo: 出库单号
    • Fprice: 单价
    • F_uc_SyncEdi: 是否允许同步EDI(扩展参数,用于识别是否同步到EDI)
    • F_uc_SyncEdiResult: EDI同步返回结果(用于记录同步结果,默认为空,其他状态: DOING/SUCCESS/FAILURE)
    • F_QAZF_BaseProperty_7ra: 箱号客户对应规格
    • F_uc_SalverModel: 托盘客户对应规格
json5
{
  "data": {
    "FormId": "QAZF_ZXQD",
    "FieldKeys": "FID,FBillNo,FDocumentStatus,FCreateDate,FComboBox,FCustomerName.FNumber,FDate2,FDate3,FText11,FBase.FNumber,FCustomerNumber,FProductname,FSalesNumber,FBOXNumber.FNumber,FAmount,FsalverNumber,FBillNo_SRC,FCustNo,FOutBillNo,Fprice,F_uc_SyncEdi,F_uc_SyncEdiResult,F_QAZF_BaseProperty_7ra,F_uc_SalverModel",
    "FilterString": [
      {
        "FieldName": "FCreateDate",
        "Compare": "3",
        "Value": 60, // 最近60天
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "FComboBox",
        "Compare": "29",
        "Value": "1", // 正常状态
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "FCustomerName.FNumber",
        "Compare": "67",
        "Value": "xxx", // 客户编号
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "F_uc_SyncEdi",
        "Compare": "29",
        "Value": "1", // 是否允许同步EDI状态为是
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      },
      {
        "FieldName": "F_uc_SyncEdiResult",
        "Compare": "100",
        "Value": "", // 同步结果为空
        "Left": "(",
        "Right": ")",
        "Logic": "0"
      }
    ],
    "OrderString": "FCreateDate DESC",
    "TopRowCount": 0,
    "StartRow": 0,
    "Limit": 2000,
    "SubSystemId": ""
  }
}

元数据查询接口 - QueryBusinessInfo

/Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery.common.kdsvc