BtoBプラットフォーム 請求書
SmartDBとBtoBプラットフォーム 請求書を連携すると、請求書発行における承認ワークフローから取引先への請求書発行までの業務プロセス全体のデジタル化が実現できます。
業務プロセス内から当APIを呼び出すことで対象文書の計算・値の反映を実行します。税率別合計金額を計算する際は当APIを呼び出すだけです。部品のマッピングとWebhook APIの設定のみで実現します。
全体のフローイメージ
- SmartDBから請求書を作成する。
- 業務プロセスを開始する。
- 税率ごとの請求明細を計算するWebhook APIを呼び出し、税率別請求額を計算する。
- 承認者は入力内容、税率別請求額などを確認して承認する。
- 承認時にBtoBプラットフォーム 請求書へ請求書発行が依頼される。
事前準備
SmartDBアクセストークンを取得するために【共通設定】が必要です。既に設定済みの場合は、追加で実施する必要がありません。
| BtoBプラットフォーム 請求書 | |
|---|---|
| アカウント | BtoBプラットフォーム 請求書にログインできるアカウントを用意します。 |
| SmartDB | |
| バインダ 業務プロセス |
請求書発行サービスで利用するバインダと業務プロセスを用意します。 ※請求書発行サービスで利用するバインダと業務プロセスは、次のテンプレートからインポートできます。 カテゴリ名：オプション 定義名：BtoB請求書発行申請 含まれるバインダ：BtoB請求書発行申請 含まれるプロセス：BtoB請求書発行申請 |
請求書発行サービスで利用するバインダ・業務プロセスでは、下記設定が必要となります。 なお、 BtoBプラットフォーム 請求書定義の中で、連携対象となる部品を変更することも可能です。
連携定義設定
BtoBプラットフォーム 請求書
本連携ではBtoBプラットフォーム 請求書の請求書保存方式のうち下記の方式に対応しています。
- 適格請求書等保存方式
- フリーフォーマット
※フリーフォーマットでも伝票単位の請求書は対象外となります。
請求書発行サービス設定
管理画面のサイドメニューから「新連携オプション」メニューをクリックします。
SmartDB連携オプション設定の画面が表示されます。「 BtoBプラットフォーム 請求書」をクリックします。
本番環境、試験環境のいずれかを選択します。
※BtoBプラットフォームの「本番環境」、「試験環境」へ連携します。
BtoBプラットフォーム 請求書定義一覧画面が表示されます。
一般設定
一般設定画面が開くので、「新規作成」ボタンを押下します。
任意のタイトルとBtoBサービス申請時に発行されたクライアントID、シークレットIDを入力し、保存します。
保存した設定を再度開き、「連携の有効化」を押下します。
BtoBプラットフォーム 請求書へのログイン画面が表示されます。
ログインIDとパスワードを入力します。
アクセスの同意画面が表示されます。
「同意する」をクリックします。
連携の有効化が完了します。
バインダ設定
連携の有効化がされるとバインダ設定が可能になります。
バインダ設定タブから「新規作成」をクリックします。
定義タイトル、連携バインダ等を設定し、「保存」をクリックします。
注意事項
本連携では設定できる項目は最大限用意されていますが、設定の際は実際に利用する項目のみ入力してください。
※連携先のない不要な項目が設定されている場合も連携時にエラーとなります。
連携定義設定
「新規作成」をクリックして、次の部品のマッピングをします。
※「部品タイプ」、「長さ範囲」はBtoBプラットフォーム 請求書の仕様です。この仕様に合わせてない場合、連携時にエラーとなります。
※BtoBキーはSmartDBと連携した際にSmartDBの部品とマッピングされたBtoBプラットフォームの部品名です。
基本情報
| 項目 | 必須 項目 |
BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 任意のタイトル | - | - | 設定一覧に表示されるタイトルです。 | ||
| 設定するバインダ | 〇 | - | - | 事前準備で用意したバインダを選択します。 ※入力欄でバインダ名で検索し、検出されたバインダ名のリストから該当バインダを選択するとバインダIDが設定されます。 |
|
| 認証に利用するクライアント | 〇 | - | - | 一般設定でクライアント情報を複数登録している場合、こちらで選択します。 | |
| 請求書書 式設定管理番号 |
〇 | invoice_setting_mng_num | 文字列 | 10 | BtoBプラットフォーム 請求書から発行される管理番号 |
| 請求書タイトル | invoice_title | 文字列 | 12 | ||
| 請求書番 | inv_no | 文字列 | 10 | BtoBプラットフォーム 請求書側で管理される番号です。請求書発行時に自動で登録されます。 | |
| 件名 | inv_name | 文字列 | 40 | ||
| 担当（問い合わせ先） | contact | 文字列 | 30 | ||
| 備考 | remarks | 文字列 | 500 |
発行元
| 項目 | 必須 項目 |
BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 発行元管理番号 | publisher_mng_num | 文字列 | 10 |
発行先
| 項目 | 必須項目 | BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 発行先管理番号 | 〇 | customer_mng_num_buyer | 文字列 | 13 |
入金情報
| 項目 | 必須 項目 |
BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 振込先口座 管理番号 |
bank_mng_num | 配列 | 10 | 10件まで登録可能 管理番号は半角数字10文字以内 |
|
| 入金方法 | payment_method | 文字列 | 1 | 0:銀行振込 1:口座振替 2:現金 3:手形 4:クレジットカード 5:小切手 6:コンビニ決済 9:その他 |
|
| 入金期限 | pay_due_date | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する | |
| 締日 | close_date | 文字列 | 10 | 「yyyy-MM-dd (JST)」の形式で指定する | |
| 顧客コード1 | customer_code1 | 文字列 | 10 | ||
| 顧客コード2 | customer_code2 | 文字列 | 10 | ||
| EDI情報 | edi_info | 文字列 | 10 |
請求金額
| 項目 | 必須 項目 |
BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 請求金額タイトル | invoice_amount_title | 文字列 | 10 | ||
| おもての請求金額 | 〇 | inv_show_amount | 文字列 | 13 | |
| 前回請求金額 | prev_inv_amount | 文字列 | 13 | マイナス記号が出力される場合もある | |
| 入金額 | payment | 文字列 | 13 | マイナス記号が出力される場合もある | |
| 調整金額 | adjustment | 文字列 | 13 | マイナス記号が出力される場合もある | |
| 繰越金額 | carryover_new | 文字列 | 13 | マイナス記号が出力される場合もある | |
| 今回請求金額（税抜） | 〇 | inv_without_tax | 文字列 | 13 | マイナス記号が出力される場合もある |
| 今回消費税額 | 〇 | inv_tax | 文字列 | 13 | マイナス記号が出力される場合もある |
| 10%消費税額 | 〇 | inv_tax_tr10 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 10%請求金額（税込） | 〇 | inv_amount_tr10 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 10%請求金額（税抜） | 〇 | inv_without_tax_tr10 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 軽減8%消費税額 | 〇 | inv_tax_tr8_reduced | 文字列 | 13 | マイナス記号が出力される場合もある |
| 軽減8%請求金額（税込） | 〇 | iinv_amount_tr8_reduced | 文字列 | 13 | マイナス記号が出力される場合もある |
| 軽減8%請求金額（税抜） | 〇 | inv_without_tax_tr8_reduced | 文字列 | 13 | マイナス記号が出力される場合もある |
| 8%消費税額 | 〇 | inv_tax_tr8 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 8%請求金額（税込） | 〇 | inv_amount_tr8 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 8%請求金額（税抜） | 〇 | inv_without_tax_tr8 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 5%消費税額 | 〇 | inv_tax_tr5 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 5%請求金額（税込） | 〇 | inv_amount_tr5 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 5%請求金額（税抜） | 〇 | inv_without_tax_tr5 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 0%消費税額 | 〇 | inv_tax_tr0 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 0%請求金額（税込） | 〇 | inv_amount_tr0 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 0%請求金額（税抜） | 〇 | inv_without_tax_tr0 | 文字列 | 13 | マイナス記号が出力される場合もある |
| 非課税消費税額 | 〇 | inv_amount_free | 文字列 | 13 | マイナス記号が出力される場合もある |
| 非課税請求金額（税込） | 〇 | inv_without_tax_free | 文字列 | 13 | マイナス記号が出力される場合もある |
| 非課税請求金額（税抜） | 〇 | inv_tax_exemption | 文字列 | 13 | マイナス記号が出力される場合もある |
| 免税消費税額 | 〇 | inv_tax_exemption | 文字列 | 13 | マイナス記号が出力される場合もある |
| 免税消費税額（税込） | 〇 | inv_amount_exemption | 文字列 | 13 | マイナス記号が出力される場合もある |
| 免税消費税額（税抜） | 〇 | inv_without_tax_exemption | 文字列 | 13 | マイナス記号が出力される場合もある |
| 不課税消費税額 | 〇 | inv_tax_non | 文字列 | 13 | マイナス記号が出力される場合もある |
| 不課税消費税額（税込） | 〇 | inv_amount_non | 文字列 | 13 | マイナス記号が出力される場合もある |
| 不課税消費税額（税抜） | 〇 | inv_without_tax_non | 文字列 | 13 | マイナス記号が出力される場合もある |
※明細でこの税種が選択できる場合は必須です。
※税種別合計金額APIの端数処理の方法を選択できます。
おもての自由項目
| 項目 | 必須 項目 |
BtoBキー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| おもての自由項目1～3（文字） | iinv_free_txt1～3 | 文字列 | 8 | ||
| おもての自由項目1～7（数値） | inv_free_num1〜7 | 文字列 | 13 | マイナス記号、小数点は許可。 マイナス記号、小数点を除いて整数部13文字以下、小数部3文字以下で指定する。 |
明細の設定
明細は基本的に他の部品と同じくバインダ設定画面でマッピングしています。マッピングできないような特殊な作りをした明細の場合はマッピングせずに個別に部品キーを設定する必要があります。明細を個別に設定する場合は「個別に設定する」にチェックしてください。
個別設定する場合の設定方法には、リスト型部品を利用する方法と明細行を個別に設定する方法の2種類があります。
| 個別設定方法 | 説明 |
|---|---|
| リスト型部品を利用する | 税率ごとにリスト型部品を分ける方式です。 |
| 明細行を個別に設定する | 各明細行をレイアウトブロックで分ける方式です。 レイアウトブロックごとに編集、閲覧などの権限を分けることができます。 |
※個別に設定する場合は、下記「明細情報」および「合計対象外の明細情報」に設定される内容は無視されます。
※税種別合計金額のAPIの対象外となります。バインダ設定でマッピングせずに税率ごとに部品キーを設定する必要があります。
明細情報
| 項目 | 必須 項目 |
部品キー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 明細リストのブロックID | 〇 | invoice_amount_title | 明細に指定しているレイアウトブロックのID | ||
| 明細番号 | item_slip_no | 文字列 | 20 | ||
| 明細日付 | 〇 | item_slip_date | 文字列 | 10 | yyyy-MM-dd (JST)」の形式で指定する |
| 商品コード | item_prod_code | 文字列 | 48 | ||
| 明細項目 | item_name | 文字列 | 50 | ||
| 数量 | item_qty | 文字列 | 13.5 | ||
| 単価 | item_price | 文字列 | 13.5 | ||
| 単位 | item_unit | 文字列 | 10 | ||
| 金額 | 〇 | item_without_tax | 文字列 | 13 | |
| 消費税額 | 〇 | item_tax | 文字列 | 13 | |
| 請求金額 | 〇 | item_amount | 文字列 | 13 | |
| 部門コード | item_sec_code | 文字列 | 15 | ||
| 部門名 | item_sec_name | 文字列 | 50 | ||
| 備考 | detail_remarks | 文字列 | 50 | ||
| 明細の自由項目1～10（文字） | item_free_txt1〜10 | 文字列 | 20 | ||
| 明細の自由項目11（文字） | item_free_txt_l | 文字列 | 100 | ||
| 税区分 | 〇 | tax_type | 文字列 | 1 | 0:課税 1:非課税 2:免税 3:不課税 |
| 税率 | 〇 | tax_rate_sec | 文字列 | 3 | 課税の場合必須。 0:0% 5:5% 8:8% 10:10% |
| 軽減税率フラグ | 〇 | reduced_tax_flg | 文字列 | 1 | 「軽減税率」が選択された場合連携される |
合計対象外の明細情報
※合計対象外の明細情報の設定は省略できます。
| 項目 | 必須 項目 |
部品キー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 明細リストのブロックID | 〇 | invoice_amount_title | 明細に指定しているレイアウトブロックのID | ||
| 明細番号 | item_slip_no | 文字列 | 20 | ||
| 明細日付 | 〇 | item_slip_date | 文字列 | 10 | yyyy-MM-dd (JST)」の形式で指定する |
| 商品コード | item_prod_code | 文字列 | 48 | ||
| 明細項目 | item_name | 文字列 | 50 | ||
| 数量 | item_qty | 文字列 | 13.5 | ||
| 単価 | item_price | 文字列 | 13.5 | ||
| 単位 | item_unit | 文字列 | 10 | ||
| 金額 | 〇 | item_without_tax | 文字列 | 13 | |
| 消費税額 | 〇 | item_tax | 文字列 | 13 | |
| 請求金額 | 〇 | item_amount | 文字列 | 13 | |
| 部門コード | item_sec_code | 文字列 | 15 | ||
| 部門名 | item_sec_name | 文字列 | 50 | ||
| 備考 | detail_remarks | 文字列 | 50 | ||
| 明細の自由項目1～10（文字） | item_free_txt1〜10 | 文字列 | 20 | ||
| 明細の自由項目11（文字） | item_free_txt_l | 文字列 | 100 | ||
| 税区分 | 〇 | tax_type | 文字列 | 1 | 0:課税 1:非課税 2:免税 3:不課税 |
| 税率 | 〇 | tax_rate_sec | 文字列 | 3 | 課税の場合必須。 0:0% 5:5% 8:8% 10:10% |
| 軽減税率フラグ | 〇 | reduced_tax_flg | 文字列 | 1 | 「軽減税率」が選択された場合連携される |
オプション
| 項目 | 必須 項目 |
部品キー | 部品 タイプ |
長さ 範囲 |
説明 |
|---|---|---|---|---|---|
| 請求書郵送代行サービス利用区分 | inv_coop_post_use_type | 文字列 | 1 | 郵送代行オプションを利用している場合のみ設定可能。 0:発行先マスタ・お申し込み時の設定を適用する 1:郵送代行を利用しない 2:郵送代行を利用する |
|
| 自社印刷指定フラグ | private_print_flg | 文字列 | 20 | 発行済請求書一括印刷オプションを利用している場合のみ設定可能。 0:指定なし 1:指定あり |
発行ステータス
| 項目 | 必須 項目 |
説明 |
|---|---|---|
| ステータス | 発行ステータスを格納する部品 | |
| 成功時のステータス項目ID | 発行成功時にセットする項目ID | |
| 失敗時のステータス項目ID | 発行失敗時にセットする項目ID | |
| 失敗時のエラーメッセージ | 発行失敗時にエラーメッセージを格納する部品 |
その他
| 項目 | 必須項目 | 説明 |
|---|---|---|
| FAX送信フラグ |
必要な利用項目をすべて設定したら「保存」します。
Webhook用URLの取得
SmartDB連携オプションのBtoBプラットフォーム 請求書一覧画面から、上記で保存したバインダ設定を開きます。
バインダ設定編集画面からSmartDBプロセス定義、 BtoBプラットフォーム 請求書設定で入力するWebhook URL等を取得します。
各URLは次の設定で利用します。
| 項目 | 設定先 |
|---|---|
| 税種別合計金額の計算URL※ | martDBプロセス、合計値計算のための【通知ロボット】設定画面のWebhook URLに設定してください。 |
| 請求書発行URL | SmartDBプロセス、請求書発行のための【通知ロボット】設定画面のWebhook URLに設定してください。 |
※明細を個別設定している場合は利用できません。
業務プロセス定義の編集
事前準備で用意した業務プロセス定義（ BtoBプラットフォーム 請求書）をドラフト編集します。テンプレートのプロセス定義では、「【通知ロボット】合計値計算」、 「【通知ロボット】請求書発行」をそれぞれ選択します。
それぞれにSmartDB連携オプションで設定したバインダ設定に記載されているWebhook URLを、通知ロボットのURL（初期値では設定例が記載されています）に設定し、 通知ロボットの設定を適用します。
※税種別合計金額は必要に応じて設定してください。
業務プロセス定義を正式版として公開します。
利用手順
一般ユーザでログインし、上記で設定したバインダに文書を登録し、業務プロセスを開始します。
主なエラーメッセージ
連携がうまくいかず請求書の発行が失敗したときにエラーメッセージが出ます。
BtoBプラットフォーム 請求書の「部品タイプ」、「長さ範囲」の基準にあっていないことが主な原因です。
連携オプションのバインダ設定に記載されている（ ）内の項目に問題があるので設定内容を確認してください。
| 主なエラーメッセージ |
|---|
| 10%消費税額は整数13桁以内で入力してください。 (inv_tax_tr10) |
| 消費税額は整数13桁以内で入力してください。(item_tax) |
| 請求書書式情報が取得できません。 |
| 明細の自由項目1（文字）は半角20桁文字以内で入力してください。[1行目] (item_free_txt1) |
| 振込先口座を追加する場合、入金方法は「銀行振込」を入力してください。 (bank_mng_num,payment_method) |
| EDI情報もしくは、顧客コード1、顧客コード2のどちらかの登録しかできません。EDI情報を削除するか、顧客コード1、顧客コード2を削除してください。 (customer_code1,customer_code2,edi_info) |
| 各金額合計のいずれかを入力してください。, 請求書の保存方式が「適格請求書等保存方式」の場合、明細日付は必須です。明細日付を入力して下さい。 (item_slip_date) |