.NetCore對接各大財務軟件憑證API——金蝶系列(1)

哈嘍,又和你們見面了,雖然看文章的小夥伴很少,可是我相信總有一天,本身寫的這些文章或多或少會對其餘人有些幫助,讓他們在相關的業務開發下能少走些彎路,那個人目的就達到了,好了,今天就正式開始咱們的系列了,今天要講的是金蝶系列的API,你們都知道,金蝶的產品是比較多的,那麼咱們此次要講解的就是金蝶雲星空,或者叫K3Cloud。web

首先,做爲一名程序猿咱們在拿到相似的接口對接需求,第一件是確定是看相關文檔,而後作接口分析,最後是封裝接口,運用到咱們的項目中去,因此對於咱們來講,第一步就是尋找相關的開發文檔,在這方面不得不認可,金蝶社區是個好地方。裏面有關於產品的全部知識點和你們遇到的各類問題。廢話很少說,文檔哪裏找,請看下面的步驟api

一.K3Cloud接口地址以及財務環境的登陸信息

咱們在作.netCore對接財務系統時,要用到的幾個參數有:帳套號,用戶名,密碼,財務環境地址(支持外網訪問)數組

這個信息你能夠找你對接的客戶要,最好是能要到外網登陸的地址,由於這樣省去你遠程登陸的麻煩,其次,帳號的權限也很重要,該帳號下必須能看到名爲-- WebAPI的菜單,由於咱們須要的接口信息包括後續的測試等均可以在這裏處理。以下圖所示安全

 

 

二.對接要用到的接口列表

既然將憑證API,那麼咱們須要用到的幾個菜單在財務會計--總帳下:主要有科目查詢接口、憑證字查詢接口、憑證新增接口app

每一個操做咱們均可以經過在線測試WebAPI來驗證咱們的接口信息,查詢接口的請求參數說明詳見下圖異步

1.惟一碼的FormId

FormId爲每一個業務對象的表單Id,如科目對應的就是BD_Account,這裏建議咱們在開發時,能夠提早將這些用到的表單ID統一設置爲常量。參考如下代碼片斷,固然實際開發中咱們可能用不到這麼多,你們根據本身的狀況進行合理的取捨。分佈式

public class BillKeyConst { #region 財務會計 總帳 public const string 科目 = "BD_Account"; ​ public const string 賬薄 = "BD_AccountBook"; ​ public const string 會計日曆 = "BD_ACCOUNTCALENDAR"; ​ public const string 會計要素 = "BD_AccountGroup"; ​ public const string 幣別 = "BD_Currency"; ​ public const string 費用項目 = "BD_Expense"; ​ public const string 匯率 = "BD_Rate"; ​ public const string 結算方式 = "BD_SETTLETYPE"; ​ public const string 憑證字 = "BD_VOUCHERGROUP"; ​ public const string 調整期間管理 = "GL_ADJUSTPERIOD"; ​ public const string 自動轉帳 = "GL_AutoTransfer"; ​ public const string 現金流量項目 = "GL_CashFlow"; ​ public const string 附表項目指定 = "GL_CashIndirectItem"; ​ public const string 智能轉存 = "GL_DepositScheme"; ​ public const string 期末調匯 = "GL_ExchangeScheme"; ​ public const string 摘要庫 = "GL_Explanation"; ​ public const string 附表項目調整 = "GL_INDIRECTITEMADJUST"; ​ public const string 賬薄隸屬關係 = "GL_MultiBookMergeScheme"; ​ public const string 結轉損益 = "GL_PLScheme"; ​ public const string T型帳 = "GL_TACCOUNT"; ​ public const string 憑證 = "GL_VOUCHER"; ​ public const string 憑證攤銷 = "GL_VoucherAmortize"; ​ public const string 模式憑證 = "GL_VoucherModel"; ​ public const string 憑證預提 = "GL_VoucherProvision"; ​ public const string 會計覈算體系 = "Org_AccountSystem"; ​ #endregion#region 財務會計 智能會計平臺public const string 業務憑證 = "BAS_BusinessVoucher"; ​ public const string 憑證生成 = "Bas_MakeBizVchWizard"; ​ public const string 分錄類型 = "BAS_VchEntryType"; ​ public const string 憑證模板 = "BAS_VchTemplate"; ​ public const string 增值稅發票單據 = "GL_AddedTaxBill"; ​ public const string 增值稅發票識別 = "GL_AddedTaxOcrResult"; ​ public const string 憑證自動生成方案 = "GL_AutoBuildVoucherScheme"; ​ public const string 掃描識別模板管理 = "GL_BillOcrTemplate"; ​ public const string 對帳方案 = "GL_CHECKSCHEME"; ​ public const string 自定義單據識別 = "GL_OcrResultBase"; ​ public const string 掃描儀注冊登記 = "GL_ScannerSign"; ​ public const string 銀行回單_付款 = "GL_YHHDFK"; ​ public const string 銀行回單_收款 = "GL_YHHDSK"; ​ #endregion#region 供應鏈 採購單據public const string SCM_警示燈方案 = "SCM_WarnScheme"; ​ public const string BD_採購條款 = "BD_PURCLAUSE"; ​ public const string BD_採購折扣表 = "BD_PurDiscount"; ​ public const string PUR_評估等級 = "PUR_Assessment"; ​ public const string PUR_採購評估指標 = "PUR_AssessmentIndex"; ​ public const string PUR_採購評估方案 = "PUR_AssessmentPlans"; ​ public const string PUR_貨源清單 = "PUR_CATALOG"; ​ public const string PUR_採購合同 = "PUR_Contract"; ​ public const string PUR_採購合同變動單 = "PUR_ContractChange"; ​ public const string PUR_期初採購退料單 = "PUR_InitMRS"; ​ public const string PUR_退料申請單 = "PUR_MRAPP"; ​ public const string PUR_採購退料單 = "PUR_MRB"; ​ public const string PUR_採購調價表 = "PUR_PAT"; ​ public const string PUR_採購訂價變動單 = "PUR_POChange"; ​ public const string PUR_採購訂價新變動單 = "PUR_POXChange"; ​ public const string PUR_採購價目表 = "PUR_PriceCategory"; ​ public const string PUR_物權轉移單 = "PUR_PropertyConvert"; ​ public const string PUR_採購訂單 = "PUR_PurchaseOrder"; ​ public const string PUR_收料通知單 = "PUR_ReceiveBill"; ​ public const string PUR_採購申請單 = "PUR_Requisition"; ​ public const string PUR_供應商評分表 = "PUR_SupplierAsseementTb"; ​ public const string PUR_消耗彙總表 = "PUR_VMIConsumeSum"; ​ public const string STK_期初採購入庫單 = "STK_InitInStock"; ​ public const string STK_採購入庫單 = "STK_InStock"; ​ #endregion#region 供應鏈 銷售管理public const string BD_雲之家考勤設置 = "BD_AttendanceSetting"; ​ public const string BD_輕應用自定義字段設置 = "BD_MobExtendFieldConfig"; ​ public const string BD_銷售折扣表 = "BD_SAL_DiscountList"; ​ public const string BD_銷售價目表 = "BD_SAL_PriceList"; ​ public const string BD_銷售條款 = "BD_SALCLAUSE"; ​ public const string SAL_銷售調價方案 = "SAL_ADJUSTPRICE"; ​ public const string SAL_可髮量查詢 = "SAL_AvailableQuery"; ​ public const string SAL_批量調價單 = "SAL_BATCHADJUSTPRICE"; ​ public const string SAL_寄售結算單 = "SAL_ConsignmentSettle"; ​ public const string SAL_客戶物料對應表 = "SAL_CustMatMapping"; ​ public const string SAL_發貨通知單 = "SAL_DELIVERYNOTICE"; ​ public const string SAL_期初銷售出庫單 = "SAL_INITOUTSTOCK"; ​ public const string SAL_電子面單 = "SAL_KuaidiBill"; ​ public const string SAL_銷售物流信息 = "SAL_LogisticsInfo"; ​ public const string SAL_銷售出庫單 = "SAL_OUTSTOCK"; ​ public const string SAL_銷售報價單 = "SAL_QUOTATION"; ​ public const string SAL_退貨通知單 = "SAL_RETURNNOTICE"; ​ public const string SAL_銷售退貨單 = "SAL_RETURNSTOCK"; ​ public const string SAL_銷售訂單 = "SAL_SaleOrder"; ​ public const string SAL_銷售訂單變動單 = "SAL_SaleOrderChange"; ​ public const string SAL_模擬報價單 = "Sal_SimulateQuotation"; ​ public const string SAL_標準費率維護 = "Sal_StdExchangeRate"; ​ public const string SAL_銷售訂單新變動單 = "SAL_XORDER"; ​ public const string SAL_銷售報價變動單 = "SAL_XQUOTATION"; ​ #endregion#region 供應鏈 信用管理public const string CRE_信用檢查規則 = "CRE_CheckRule"; ​ public const string CRE_信用表更 = "CRE_CreditChange"; ​ public const string CRE_信用總額特批 = "CRE_CreditSumPermit"; ​ public const string CRE_信用檔案 = "CRE_CustArchives"; ​ public const string CRE_客戶物料信用檔案 = "CRE_CustMaterialArchive"; ​ public const string CRE_信用評估模型 = "CRE_EvalModel"; ​ public const string CRE_信用評估指標 = "CRE_EvaluateIndex"; ​ public const string CRE_信用等級方案 = "CRE_Gade"; ​ public const string CRE_信用評分表 = "CRE_ScoringTable"; ​ public const string CRE_信用特批權限 = "CRE_SpecPermission"; ​ public const string CRE_臨時信用檔案 = "CRE_TmpCustArchives"; ​ #endregion#region 供應鏈 庫存管理public const string BD_歸檔序列號 = "BD_ArchivedSerial"; ​ public const string BD_批號主檔 = "BD_BatchMainFile"; ​ public const string BD_批號_序列號屬性 = "BD_LotCodeItem"; ​ public const string BD_批號_序列號編碼規則 = "BD_LotCodeRule"; ​ public const string BD_生產追溯序列號主檔 = "BD_MTSerialMainFile"; ​ public const string BD_序列號主檔 = "BD_SerialMainFile"; ​ public const string BD_倉庫 = "BD_STOCK"; ​ public const string BD_倉庫最大最小安全庫存 = "BD_StockAlert"; ​ public const string BD_庫存狀態 = "BD_StockStatus"; ​ public const string SP_簡單生成入庫單 = "SP_InStock"; ​ public const string SP_簡單生成退庫單 = "SP_OUTSTOCK"; ​ public const string SP_簡單生成領料單 = "SP_PickMtrl"; ​ public const string SP_簡單生成退料單 = "SP_ReturnMtrl"; ​ public const string STK_組裝拆卸單 = "STK_AssembledApp"; ​ public const string STK_週期盤點計劃 = "STK_CycleCountPlan"; ​ public const string BD_物料週期盤點表 = "STK_CycleCountTable"; ​ public const string STK_即時庫存 = "STK_Inventory"; ​ public const string STK_初始庫存 = "STK_InvInit"; ​ public const string STK_庫存鎖庫 = "STK_LockStock"; ​ public const string STK_鎖庫日誌 = "STK_LOCKSTOCKLOG"; ​ public const string STK_批號調整單 = "STK_LOTADJUST"; ​ public const string STK_ABC分配組 = "STK_MaterialABCGroup"; ​ public const string STK_其餘入庫單 = "STK_MISCELLANEOUS"; ​ public const string STK_其餘出庫單 = "STK_MisDelivery"; ​ public const string STK_委託加工材料入庫單 = "STK_OEMInStock"; ​ public const string STK_委託加工材料退料單 = "STK_OEMInStockRETURN"; ​ public const string STK_委託加工材料收料單 = "STK_OEMReceive"; ​ public const string STK_出庫申請單 = "STK_OutStockApply"; ​ public const string STK_形態轉換單 = "STK_StatusConvert"; ​ public const string STK_庫存狀態轉換 = "STK_StockConvert"; ​ public const string STK_盤盈單 = "STK_StockCountGain"; ​ public const string STK_物料盤點做業 = "STK_StockCountInput"; ​ public const string STK_盤虧單 = "STK_StockCountLoss"; ​ public const string STK_盤點方案 = "STK_StockCountScheme"; ​ public const string STK_調撥申請單 = "STK_TRANSFERAPPLY"; ​ public const string STK_直接調撥單 = "STK_TransferDirect"; ​ public const string STK_分佈式調入單 = "STK_TRANSFERIN"; ​ public const string STK_分佈式調出單 = "STK_TRANSFEROUT"; ​ #endregion#region 供應鏈  組織間結算public const string IOS_應付結算清單_物料 = "IOS_APSettlement"; ​ public const string IOS_應付結算清單_費用 = "IOS_APSettlementExp"; ​ public const string IOS_應付結算清單_資產 = "IOS_APSettlementFA"; ​ public const string IOS_應收結算清單_物料 = "IOS_ARSettlement"; ​ public const string IOS_應收結算清單_費員 = "IOS_ARSettlementExp"; ​ public const string IOS_應收結算清單_資產 = "IOS_ARSettlementFA"; ​ public const string IOS_組織間結算價目表 = "IOS_PriceList"; ​ public const string IOS_定時結算 = "IOS_ScheduleSettle"; ​ public const string IOS_組織間結算關係 = "IOS_SettleRelation"; ​ public const string IOS_跨組織業務類型 = "IOS_TransferBizType"; ​ #endregion#region 供應鏈 條碼管理public const string BD_異步生成數據 = "BD_AsyncBillScanData"; ​ public const string BD_條碼盤點清單 = "BD_BarcodeInventoryData"; ​ public const string BD_條碼屬性 = "BD_BarCodeItem"; ​ public const string BD_條碼主檔 = "BD_BarCodeMainFile"; ​ public const string BD_條碼打印 = "BD_BarCodePrint"; ​ public const string BD_條碼規則 = "BD_BarCodeRule"; ​ public const string BD_條碼掃描 = "BD_BarCodeScan"; ​ public const string BD_條碼拆分 = "UN_BarCodeSplit"; ​ public const string BD_物料編碼解析對應表 = "UN_MaterialMap"; ​ public const string BD_條碼拆箱表 = "UN_Packaging"; ​ public const string BD_掃描配置 = "UN_SCAN"; ​ public const string BD_掃描記錄 = "UN_SCANRecordSet"; ​ public const string BD_條碼掃描任務 = "UN_SCANTASK"; ​ public const string BD_條碼掃描任務生成日誌 = "UN_SCANTASKCREATELOG"; ​ public const string BD_條碼掃描任務方案 = "UN_SCANTASKSCHEME"; ​ #endregion#region 供應鏈 供應商管理public const string SVM_企業公告 = "SVM_BusinessBulletin"; ​ public const string SVM_比價單 = "SVM_ComparePrice"; ​ public const string SVM_詢價單 = "SVM_InquiryBill"; ​ public const string SVM_報價單 = "SVM_QuoteBill"; ​ public const string SVM_供應商角色 = "SVM_Role"; ​ public const string SVM_供應商用戶 = "SVM_SUPPLIERUSER"; ​ #endregion#region 供應鏈 供應商協同public const string SCP_供應商協同條碼打印 = "SCP_BarCodePrint"; ​ public const string SCP_供應商協同條碼掃描 = "SCP_BarCodeScan"; ​ public const string SCP_企業公告 = "SCP_BusinessBulletin"; ​ public const string SCP_詢價單 = "SCP_InquiryBill"; ​ public const string SCP_採購入庫單 = "SCP_InStock"; ​ public const string SCP_退料通知單 = "SCP_MRAPP"; ​ public const string SCP_採購退料單 = "SCP_MRB"; ​ public const string SCP_應付單 = "SCP_Payable"; ​ public const string SCP_採購訂單變動單 = "SCP_POChange"; ​ public const string SCP_採購訂單 = "SCP_PurchaseOrder"; ​ public const string SCP_報價單 = "SCP_QuoteBill"; ​ public const string SCP_送貨通知單 = "SCP_ReceiveBill"; ​ public const string SCP_供應商協同即時庫存查詢 = "SCP_STKInventory"; ​ public const string SCP_供應商評估報告 = "SCP_SupplierAssResport"; ​ public const string SCP_供應商註冊資料 = "SCP_SupReg"; ​ public const string SCP_供應商協同VMI消耗彙總表 = "SCP_VMIConsumeSum"; ​ #endregion#region 基礎管理--基礎資料public const string 關鍵字_智能機器人 = "BAS_ROBOTKEYWORDS"; ​ public const string 消息任務_智能機器人 = "BAS_ROBOTMSGTASK"; ​ public const string 關鍵字服務_智能機器人 = "BAS_ROBOTSERVICE"; ​ public const string 會計政策 = "BD_ACCTPOLICY"; ​ public const string 輔助屬性值組合 = "BD_AuxPtyValCom"; ​ public const string 輔助屬性值 = "BD_AuxPtyValue"; ​ public const string 銀行 = "BD_BANK"; ​ public const string 聯繫對象 = "BD_ContactObject"; ​ public const string 客戶 = "BD_Customer"; ​ public const string 客戶_包含非交易客戶 = "BD_Customer_All"; ​ public const string 部門 = "BD_Department"; ​ public const string 員工 = "BD_Empinfo"; ​ public const string 快遞100物流公司 = "BD_KD100LogisticsCom"; ​ public const string 物料 = "BD_MATERIAL"; ​ public const string 存貨類別 = "BD_MATERIALCATEGORY"; ​ public const string 存貨模板 = "BD_MATERIALTEMPLATE"; ​ public const string 物料單位換算 = "BD_MATERIALUNITCONVERT"; ​ public const string 員工任崗信息 = "BD_NEWSTAFF"; ​ public const string 業務員 = "BD_OPERATOR"; ​ public const string 業務組 = "BD_OPERATORGROUPBILL"; ​ public const string 付款條件 = "BD_PaymentCondition"; ​ public const string 崗位彙報 = "BD_PostReport"; ​ public const string 收款條件 = "BD_RecCondition"; ​ public const string 供應商 = "BD_Supplier"; ​ public const string 稅組合 = "BD_TAXMIX"; ​ public const string 稅率 = "BD_TaxRate"; ​ public const string 稅務規則 = "BD_TAXRULE"; ​ public const string 稅收制度 = "BD_TAXSYSTEM"; ​ public const string 稅種 = "BD_TAXTYPE"; ​ public const string 計量單位 = "BD_UNIT"; ​ public const string 銀行帳號 = "CN_BANKACNT"; ​ public const string 現金帳號 = "CN_CASHACCOUNT"; ​ public const string 內部帳戶 = "CN_INNERACCOUNT"; ​ public const string 其餘往來單位 = "FIN_OTHERS"; ​ public const string 崗位信息 = "HR_ORG_HRPOST"; ​ #endregion#region 基礎管理--組織管理public const string 組織隸屬關係 = "ORG_Affiliation"; ​ public const string 分配執行狀況 = "ORG_AutoAllocateLogInfo"; ​ public const string 基礎資料自動分配計劃 = "ORG_AUTOALLOCATEPLAN"; ​ public const string 基礎資料控制策略 = "ORG_BaseDataControlPolicy"; ​ public const string 組織業務關係 = "ORG_BizRelation"; ​ public const string 組織變動檢查規則 = "ORG_ChangeChkRule"; ​ public const string 組織變動方案 = "ORG_ChangeSolution"; ​ public const string 組織機構 = "ORG_Organizations"; ​ public const string 組織形態 = "ORG_OrgBodyForm"; ​ public const string 組織用戶維護 = "Org_OrgUserRoleMap"; ​ #endregion ​ }
View Code

 2.查詢字段集合

FieldKeys爲要查詢的字段Key集合,如我須要查詢的字段有FName,FNumber等,詳細的字段說明能夠經過保存接口查看ide

那麼咱們只須要傳入FName,FNumber便可。測試

3.返回結果的處理

返回的結果是個數組類型,因此咱們沒法直接經過.net序列化爲對象,因此建議是直接序列化爲JArry數組,而後進行取值。flex

三. .NetCore對接處理

3.1登陸以及業務接口處理

有了以上的對接參數和簡單的接口信息瞭解以後,咱們就能夠開始咱們的API接口對接工做了,

首先,在社區一位大佬封裝的WebAPI的基礎上,咱們來處理.netCore環境下的WebAPI接口,很是感謝大佬,咱們能夠看到封裝的接口文件以下圖所示:

 

經常使用的有Query、BatchSave類,以下圖所示

Query操做

    /// <summary>
    /// 執行查詢操做。 /// </summary>
    public class Query : FormOperation { #region 公共覆蓋操做參數

        /// <summary>
        /// 操做的服務名稱定義。 /// </summary>
        public override string ServiceName { get { return "Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.ExecuteBillQuery"; } }//end property

        /// <summary>
        /// 操做的請求參數。 /// </summary>
        public override string RequestParameters { get { var parametersArray = new object[] { new { FormId = this.ObjectTypeId, TopRowCount = this.TopRowCount, Limit = this.PageRowCount == default(int) ? 2000 : this.PageRowCount, StartRow = this.PageIndex, FilterString = this.Filter, OrderString = this.OrderBy, FieldKeys = string.Join(",", this.FieldKeys) } }; return JsonConvert.SerializeObject(parametersArray); } }//end property

        #endregion

        #region 公共操做參數屬性

        /// <summary>
        /// 讀寫最多容許查詢的數量屬性值。 /// </summary>
        /// <remarks>
        /// 0或者不要此屬性表示不限制。 /// </remarks>
        public virtual int TopRowCount { get; set; }//end property

        /// <summary>
        /// 讀寫分頁取數每頁容許獲取的數據屬性值。 /// </summary>
        /// <remarks>
        /// 最大不能超過2000。 /// </remarks>
        public virtual int PageRowCount { get; set; }//end property

        /// <summary>
        /// 讀寫分頁取數開始行索引屬性值。 /// </summary>
        /// <remarks>
        /// 從0開始,例如每頁10行數據,第2頁開始是10,第3頁開始是20,以此類推,當不提供此屬性,表示僅查詢Limit中填寫的數據量。 /// </remarks>
        public virtual int PageIndex { get; set; }//end property

        /// <summary>
        /// 讀寫過濾條件屬性值。 /// </summary>
        public virtual string Filter { get; set; }//end property

        /// <summary>
        /// 讀寫排序條件屬性值。 /// </summary>
        public virtual string OrderBy { get; set; }//end property

        /// <summary>
        /// 讀寫表單返回數據字段的索引鍵屬性值。 /// </summary>
        public virtual List<string> FieldKeys { get; set; }//end property

        #endregion

        #region 公共方法

        /// <summary>
        /// 設置讀寫動態表單類型標識。 /// </summary>
        /// <param name="objectTypeId">動態表單類型標識。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetObjectTypeId(string objectTypeId) { return this.SetObjectTypeId<Query>(objectTypeId); }//end method

        /// <summary>
        /// 設置最多容許查詢的單據數量。 /// </summary>
        /// <param name="topRowCount">單據數量值。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetTopRowCount(int topRowCount) { this.TopRowCount = topRowCount; return this; }//end method

        /// <summary>
        /// 設置分頁取數每頁容許獲取的單據數量。 /// </summary>
        /// <param name="pageRowCount">分頁數量值。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetPageRowCount(int pageRowCount) { this.PageRowCount = pageRowCount; return this; }//end method

        /// <summary>
        /// 設置分頁取數開始行索引。 /// </summary>
        /// <param name="pageIndex">索引值。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetPageIndex(int pageIndex) { this.PageIndex = pageIndex; return this; }//end method

        /// <summary>
        /// 設置過濾條件。 /// </summary>
        /// <param name="filter">過濾條件。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetFilter(string filter) { this.Filter = filter; return this; }//end method

        /// <summary>
        /// 設置排序條件。 /// </summary>
        /// <param name="orderBy">排序條件。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query SetOrderBy(string orderBy) { this.OrderBy = orderBy; return this; }//end method

        /// <summary>
        /// 表單返回數據字段。 /// </summary>
        /// <param name="fieldKey">字段索引鍵。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual Query AddFieldKey(string fieldKey) { if (this.FieldKeys == null) { this.FieldKeys = new List<string>(); }//end if

            this.FieldKeys.Add(fieldKey); return this; }//end method

        #endregion }//end class
View Code

BatchSave操做,主要用於憑證的批量保存

    /// <summary>
    /// 執行批量保存操做。 /// </summary>
    public class BatchSave : Save { #region 公共覆蓋操做參數

        /// <summary>
        /// 操做的服務名稱定義。 /// </summary>
        public override string ServiceName { get { return "Kingdee.BOS.WebApi.ServicesStub.DynamicFormService.BatchSave"; } }//end property

        /// <summary>
        /// 待保存的數據對象。 /// </summary>
        public override string RequestParameters { get { var parametersArray = new object[]{ this.ObjectTypeId, new { Creator = string.IsNullOrEmpty(this.Creator) ? "IT" : this.Creator , NeedUpDateFields = this.NeedUpdateFieldKeys, NeedReturnFieldKeys=this.NeedReturnFieldKeys, Model = this.Models, IsEntryBatchFill=this.IsEntryBatchFill, IsDeleteEntry = this.IsDeleteEntry, SubSystemId = this.SubSystemId, IsAutoSubmitAndAudit=this.IsAutoSubmitAndAudit, IsVerifyBaseDataField = this.IsVerifyBaseDataField, NumberSearch = (this.BDSetter == BaseDataSetter.Number), BatchCount=this.BatchCount } }; return JsonConvert.SerializeObject(parametersArray); } }//end property

        #endregion

        #region 公共操做參數屬性

        /// <summary>
        /// 讀寫待保存的數據對象。 /// </summary>
        public override object Model { get { return this.Models == null ? null : this.Models.FirstOrDefault(); } set { if (this.Models == null) { this.Models = new List<object>(); }//end if
                this.Models.Add(value); } }//end property

        /// <summary>
        /// 讀寫待保存的多個數據對象。 /// </summary>
        public virtual List<object> Models { get; set; }//end property

        /// <summary>
        /// 是否批量填充分錄。 /// </summary>
        public virtual bool IsEntryBatchFill { get; set; }//end property

        public virtual bool IsAutoSubmitAndAudit { get; set; } public virtual int BatchCount { get; set; } #endregion

        #region 公共方法

        /// <summary>
        /// 添加待保存的數據對象。 /// </summary>
        /// <param name="model">待保存的數據對象。</param>
        /// <returns>返回類自己實例對象。</returns>
        public virtual BatchSave AddModel(object model) { if (this.Models == null) { this.Models = new List<object>(); }//end if
            this.Models.Add(model); return this; }//end method

        /// <summary>
        /// 設置待保存的數據對象,但不管執行多少次只會保留最後一次設置的數據對象。 /// </summary>
        /// <param name="model">待保存的數據對象。</param>
        /// <returns>返回類自己實例對象。</returns>
        new public virtual BatchSave SetModel(object model) { return this.SetModel<BatchSave>(model); }//end method

        #endregion }//end class
View Code

 而後咱們來看APIException類,能夠看到該異常處理類統一繼承自Kingdee.BOS.WebAPi.Client.ServiceException.

因此咱們要引用 Kingdee.BOS.WebApi.Client.dll

另外這裏官網給的代碼示例中有句話很值得重視:// 使用webapi引用組件Kingdee.BOS.WebApi.Client.dll

這個組件咱們能夠在金蝶的安裝目錄下找到,當你興致勃勃的找到這個dll,並將它引用到你的.netCore的項目中時,編譯運行你會發現有個ServiceException類在.netCore環境下不支持,由於它僅在.net Framework支持。

因此呢,咱們的第一反應是這可咋辦,彆着急,咱們總有辦法解決,反編譯應該是咱們在開發過程當中比較常見的解決問題的辦法,因此當咱們將上述的dll進行反編譯之後,咱們能夠獲得以下一堆文件

 

接着咱們就能夠來處理咱們的接口了,按照示例代碼中的同樣,咱們來實現登陸接口

/// <summary>
/// 實現登陸。 /// </summary>
/// <returns>返回API結果。</returns>
public virtual APIResponse<LoginResult> Login() { var result = APIClient.CreateAPIOperation<LoginByUserPassword>(_Config.URL) .SetDBId(_Config.DBId) .SetUserName(_Config.UserName) .SetPassword(_Config.Password) .ToKdAPIRequest() .ToAPIResponse<LoginResult>(); return result; }
View Code

_config.Url---對應咱們的金蝶財務環境的登陸地址

_config.DBid--對應咱們要操做的帳套號---怎麼查看到這個帳套號是多少呢?還記得咱們上面說的那個WebAPI菜單嘛,沒錯就是那裏。咱們隨便點開一個菜單,好比我這裏以科目爲例,咱們選中科目後,點擊在線測試WebAPI按鈕,就能找到咱們所需的各自參數了。

_config.UserName --登陸的用戶名

_config.Password -- 登陸的用戶名的密碼

這四個參數就對應咱們登陸接口的四個參數。

要注意的一點是咱們在調用咱們的業務接口時,必須先調用登陸接口以實現登陸操做。否則沒法操做咱們的業務接口。

        /// <summary>
        /// 查詢人民幣幣別編碼 /// </summary>
        /// <returns></returns>
        public string QueryCurrency() { this.Login(); var result = APIClient.CreateAPIOperation<Query>(_Config.URL) .SetObjectTypeId(BillKeyConst.幣別) .AddFieldKey("FNumber") .AddFieldKey("FName") .SetFilter("FName like '%人民幣%'") .ToAPIRequest<KdAPIRequest>().Execute<JArray>(); if (result.Count > 0) { return result[0][0].ToString(); } else { return ""; } }

如咱們上圖所示的查詢人民幣的名稱和編碼。固然這只是查詢單個實體,當咱們查詢全部的數據時,就可能會用到分頁查詢,由於金蝶的查詢接口默認一次查詢2000條數據,因此當總數量超過2000時,咱們就須要用到分頁查詢了。

       public string QueryBasicInfoByPageList(string typeId, string FieldName, string Filter, int pageIndex) { this.Login(); var result = APIClient.CreateAPIOperation<Query>(_Config.URL) .SetObjectTypeId(typeId) .AddFieldKey(FieldName) .SetFilter(Filter) .SetPageIndex(pageIndex) .ToAPIRequest<KdAPIRequest>().Execute<string>(); return result; }

只須要在原有的基礎上,增長pageIndex-頁碼參數便可,不過要注意的是每次查詢的起始頁碼是不同的,這樣才能經過循環來獲得咱們須要的列表數據。

3.2 憑證保存接口

        /// <summary>
        /// 批量保存單據實體 /// </summary>
        /// <param name="typeId"></param>
        /// <param name="models"></param>
        /// <returns></returns>
        public string BatchSave(string typeId, List<object> models) { this.Login(); var client = APIClient.CreateAPIOperation<BatchSave>(_Config.URL); client.SetObjectTypeId(typeId); client.Models = models; return client.ToAPIRequest<KdAPIRequest>().Execute<string>(); }
View Code

憑證批量保存接口,因此當咱們在外部構造好憑證明體後,就可直接經過該接口來處理憑證的保存工做。憑證保存實體以下CloudSaveVoucherModel

  public class CloudSaveVoucherModel { public string FVoucherID { get; set; } public FVoucherNumber FAccountBookID { get; set; } public string FDate { get; set; } public FVoucherNumber FVoucherGroupID { get; set; } public string FVoucherGroupNo { get; set; } public string FIsAdjustVoucher { get; set; } public string FDocumentStatus { get; set; } public string FYear { get; set; } public FVoucherNumber FSourceBillKey { get; set; } public string FPeriod { get; set; } public string FImportVersion { get; set; } public Fentity[] FEntity { get; set; } } public class FVoucherNumber { public string FNumber { get; set; } } public class Fentity { public string FEntryID { get; set; } public string FExplanation { get; set; } public FVoucherNumber FAccountID { get; set; } public Fdetailid FDetailID { get; set; } public FVoucherNumber FCurrencyID { get; set; } public FVoucherNumber FExchangerateType { get; set; } public string FExchangeRate { get; set; } public FVoucherNumber FUnitId { get; set; } public string FPrice { get; set; } public string FQty { get; set; } public decimal FAmountFor { get; set; } public decimal FDebit { get; set; } public decimal FCredit { get; set; } public FVoucherNumber FSettleTypeID { get; set; } public string FSettleNo { get; set; } public string FExportentryID { get; set; } } public class Fdetailid { /// <summary>
        /// 費用項目 /// </summary>
        public FVoucherNumber FDetailID__Fflex9 { get; set; } /// <summary>
        /// 供應商 /// </summary>
        public FVoucherNumber FDetailID__Fflex4 { get; set; } public FVoucherNumber FDetailID__Fflex5 { get; set; } /// <summary>
        /// 客戶 /// </summary>
        public FVoucherNumber FDetailID__Fflex6 { get; set; } /// <summary>
        /// 員工 /// </summary>
        public FVoucherNumber FDetailID__Fflex7 { get; set; } /// <summary>
        /// 物料 /// </summary>
        public FVoucherNumber FDetailID__Fflex8 { get; set; } /// <summary>
        /// 資產類別 /// </summary>
        public FVoucherNumber FDetailID__Fflex10 { get; set; } /// <summary>
        /// 組織機構 /// </summary>
        public FVoucherNumber FDetailID__Fflex11 { get; set; } /// <summary>
        /// 物料分組 /// </summary>
        public FVoucherNumber FDETAILID__FF100005 { get; set; } public FVoucherNumber FDetailID__Fflex12 { get; set; } public FVoucherNumber FDetailID__Fflex13 { get; set; } }

經過前面的BatchSave類,咱們能夠看到有個屬性叫作NeedReturnFieldKeys -- 意爲須要返回的字段,等因而在執行成功保存操做後,金蝶能夠直接將咱們須要返回的字段返回回來,傳遞形式仍是和查詢的FieldsKey格式同樣,可是在實際的開發過程當中我發現其實即使你傳了NeedReturnFieldKeys,可是在返回值中並無正常返回。我曾經在論壇裏找個該問題,發現有小夥伴也遇到一樣的問題。可是都沒有獲得解決,由於我在實際的邏輯中還須要獲得相似總金額,憑證日期,憑證號等字段,因此沒辦法只能經過查詢接口再執行一次查詢操做了,固然不涉及後續的業務處理的話,能夠不用執行該步驟的。

ps:當你執行批量保存操做時,若是一次操做的JSon數據量過大時,接口提示操做超時,因此在實際開發中建議能夠分批次進行保存操做。

四.結語

相對來講,K3Cloud的接口文檔仍是比較全面的,因此當時在實際開發的時候,並無遇到不少坑,只是在API封裝的過程當中,如上述說到的.netCore環境不支持的狀況,這樣的話經過反編譯來處理問題也是一個不錯的辦法。後續咱們還會在處理用友的一個產品時一樣使用反編譯來處理問題。

以上就是本身在實際生產過程當中處理K3CloudAPI接口時的一些想法和思路。好比金蝶社區,論壇是不錯的選擇。一樣QQ羣也是一個溝通交流的途徑。好比上面說到的批量保存時JSon串過大致使接口操做超時的問題,就是經過羣裏一個小夥伴的提醒,改變了思路經過分批傳遞的方法來解決問題的。我想說的是在開發過程當中咱們會遇到各類各樣的問題,可是經過解決這些問題咱們就能獲得鍛鍊和成長,這就是咱們的財富。說實話在以前我從沒接觸過這些知識點和業務範圍,可是這不是也是一種成長的方式嘛。但願能夠給在開發對接此產品的小夥伴一點幫助,一點支持就夠了。

附上本文中的示例代碼:K3Cloud接口

相關文章
相關標籤/搜索