API名 | 領収書情報取得API |
ID | el_ReceiptInfo_get_api |
2.詳細解説
領収書情報を取得するAPIです。
$cstream->call_el_ReceiptInfo_get_api($input_array);
3.I/O情報
INPUT
No | 項目名 | 項目ID | 項目説明 | 必須 | |||||
1 | 会社ID | kaisha_id | 会社を表すID | 〇 | |||||
2 | アクセスキー | access_key | APIを認証するためのアクセスキー | 〇 | |||||
3 | オーダーNo | order_no | オーダーID | 〇 | |||||
4 | ステータス | status |
OUTPUT
No | 項目名 | 項目ID | 項目説明 | |||||
1 | 実行フラグ | exec_flg | 1:正常 9:エラー | |||||
2 | エラータイプ | error_type | 実行フラグ=エラーの場合挿入。どのような種類のエラーなのかを判断するフラグ。 | |||||
3 | エラーメッセージ | error_msg | エラーごとに発生するメッセージ | |||||
4 | エラー情報 | error_info | エラーメッセージを表示(登録に失敗したケース) | |||||
5 | 領収書情報 | ReceiptInfo | 領収書の情報(1件のみ) | |||||
5-1 | オーダーNo | order_no | ||||||
5-2 | 領収書宛名 | receiptName | ||||||
5-3 | 請求日(入金日) | billing_date | ||||||
5-4 | 金額 | payment_amount | ||||||
5-5 | 但し書き | paymentof | ||||||
5-6 | 発行元会社名 | publisher | ||||||
5-7 | 発行元住所 | publisher_address | ||||||
5-8 | 押印画像 | imprint | ||||||
5-9 | ステータス | status | ||||||
5-10 | 領収書URL | receipt_url |
エラー
エラータイプ | エラー概要 | 発生させるメッセージ | 発生させるException | ||||||
0 | アクセスキー不適合エラー | アクセスキーが適合しません。 | AccessKeyException | ||||||
1 | ホスト許可エラー | 対象のホストからのAPI実行を許可していません。 | HostRestrictException | ||||||
2 | 引数エラー | 呼出パラメータが不足しているため実行できません。 | CallParameterException | ||||||
9 | システムメンテナンスエラー | 現在システムのメンテナンス中です。YYYY/MM/DD HH - HH の間システムをご利用できません。ご不便おかけし申し訳ございません。 | SystemMaintenanceException |
4.実装例
1 2 3 4 5 6 7 8 9 |
//領収書取得 $apiParams = array(); $apiParams['order_no'] = $order_no; $output = $cstream->call_el_ReceiptInfo_get_api($apiParams); if($output['exec_flg'] == 1){ echo $output['ReceiptInfo']['receipt_url']; } |