IM-ERP Real Connect for Accel Platform プログラミングガイド 初版 2013-02-01

請求伝票一覧 照会 API (BillingDocGetListController)

請求伝票一覧を照会するためには、BillingDocGetListController クラスの持つ各メソッドを利用する必要があります。
引数、戻り値についての詳細な情報は、API リストを参照してください。

各メソッドの説明

コンストラクタ / メソッド名 説明
BillingDocGetListController コンストラクタ(引数無し)
BillingDocGetListController
コンストラクタ(第 1 引数あり)。
ConnectionManager を使う場合に使用する。第 1 引数で「ConnectionManager」を設定する。
BillingDocGetListController
コンストラクタ(第 1 引数あり)。
SAPClient の接続情報を使う場合に使用する。第 1 引数で「SAPClient」(オブジェクト)を設定する。
setStrParam
構造型の各項目に値を設定する。
第 1 引数に structure 名、第 2 引数に項目名、第 3 引数に値を設定する。
setTblParam
テーブル型の各項目に値を設定する。
第1引数にテーブル名、第2引数に項目名第3引数に値、第4引数にレコード番号を設定する。
executeBapi BapiController により後続請求伝票一覧を取得します。
getBapiReturnErrMessage
BAPI実行結果である BapiReturn の Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn オブジェクトのメッセージ情報を全て返します。
全て正常の場合は null が返却されます。
getBapiReturnMessage
BAPI実行結果である BapiReturn の Type 情報が正常(デフォルト値: “S” / “”)と判断された Type 情報のメッセージ情報を全て返します。
メッセージが存在しない場合は null が返却されます。
getBillingDocumentDetailListList 後続請求伝票のテーブル情報を取得します。
getSuccessList 後続請求伝票の明細テーブル情報を取得します。

サンプルプログラム

var detailList;
var detaillistCount;
var successList;
var successlistCount;

function init(request) {
    //--------------------------------------------------------------------------
    //変数宣言 
    //--------------------------------------------------------------------------
    var sign = "I";                  // 範囲テーブル
    var option = "GT";               // テーブル範囲
    var refdoclow = "0900000005";    // 前伝票の開始伝票番号
    var refdochigh = "";             // 前伝票の終了伝票番号

    var objCon;
    var objResult;

    //--------------------------------------------------------------------------
    //インスタンス生成   // 説明 1
    //--------------------------------------------------------------------------
    objCon = new BillingDocGetListController(sign, option, refdoclow, refdochigh);

    //--------------------------------------------------------------------------
    // executeBapi実行   // 説明 4
    //--------------------------------------------------------------------------
    objResult = objCon.executeBapi();

    //--------------------------------------------------------------------------
    // エラー判定
    //--------------------------------------------------------------------------
    if(objResult["ERR_CODE"] != null) {
        //インスタンス生成時に例外が発生した場合
        //エラーメッセージを出力
        Debug.browse(objResult);
    }
    
    //請求伝票一覧を取得   // 説明 5
    detailList  = objCon.getBillingDocumentDetailListList();
    detaillistCount = detailList.length;
    
    //請求伝票一覧を取得
    successList  = objCon.getSuccessList();
    successlistCount = successList.length;
}
  • 請求伝票一覧照会 API のインスタンス生成(説明1)

    BillingDocGetListController クラスのインスタンスを生成します。
    引数は不要です。
    インスタンスを生成すると、請求伝票一覧 BAPI(BAPI_BILLINGDOC_GETLIST)の import 型の structure、table パラメータに値を設定することができます。
„
  • structure の各項目に値を設定(説明2)

    structure パラメータの項目に値を設定する場合は、setStrParam メソッドを使用します。
    第1引数のstructure 名称は固定値になっています。
    後述のとおりに名称を設定して下さい。
    第2引数の項目名称はSAPの各属性の項目名称を設定してください。
    structure 名称、項目名称は英字の大文字、小文字は厳密に区別されます。
    第三引数に値を設定します。
    SAP structure セットする固有名称
    REFDOCRANGE ( 前伝票の範囲 ) RefDocRange
„
  • table の各項目に値を設定(説明3)

    table パラメータの項目に値を設定する場合は、setTblParam メソッドを使用します。
    第1引数のtable名称は固定値になっています。
    後述のとおりに名称を設定して下さい。
    第2引数の項目名称は SAP の各属性の項目名称を設定してください。
    table 名称、項目名称は英字の大文字、小文字は厳密に区別されます。
    第3引数に値、第四引数にレコード番号を設定します。
    SAP table セットする固有名称
    BILLINGDOCUMENTDETAIL ( 後続請求伝票のテーブル) BillingDocumentDetail
    SUCCESS ( 後続請求伝票の明細テーブル ) Success
„
  • 請求伝票一覧照会(説明4)

    BillingDocGetListControllerクラスのexecuteBapiメソッドを実行すると、各項目にセットされた値でSAP より請求伝票一覧データとして照会されます。
    請求伝票一覧 BAPI(BAPI_BILLINGDOC_GETLIST)の実行後に RETURN パラメータの内容も取得します。
„
  • サンプルプログラムの中で記載されたデータ取得メソッドの詳細説明については、以下を参照してください。(説明5)

    • Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn を取得

      BillingDocGetListController クラスの getBapiReturnErrMessage メソッドを使用すると、取得したBapiReturn の Type 情報が正常(デフォルト値: “S” / “”)以外の BapiReturn オブジェクトのメッセージ情報を取得することが可能です。
      全て正常の場合は null を取得します。
      項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。
    • Type 情報が正常(デフォルト値: “S” / “”)の BapiReturn を取得

      BillingDocGetListControllerクラスのgetBapiReturnMessageメソッドを使用すると、取得したBapiReturn の Type 情報が正常(デフォルト値: “S” / “”)と判断された Type 情報のメッセージ情報を取得することが可能です。
      メッセージが存在しない場合は null を取得します。
      項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。
    • 後続請求伝票のテーブル情報を取得

      BillingDocGetListController クラスの getBillingDocumentDetailListList メソッドを使用すると、取得した後続請求伝票のテーブル情報を取得することが可能です。
      項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。
    • 後続請求伝票の明細テーブル情報を取得

      BillingDocGetListControllerクラスのgetSuccessListメソッドを使用すると、取得した後続請求伝票の明細テーブル情報を取得することが可能です。
      項目の値を取得するには、KEY に SAP の各属性の項目名称を設定してください。