AP 請求書 API 開発者ガイド

この開発者ガイドでは、AP Invoice API for 買掛金請求書処理 でデフォルトで提供されていないカスタム請求書フィールドを定義する方法について説明します。また、ペイロードとして cXML を使用する場合の認証を設定する手順も記載されています。

要求本文のカスタム請求書フィールドを定義できます。次のフローを使用して、カスタムフィールドを追加し、ターゲットテーブルにマッピングして、ペイロードで使用できるようにフォーマットします。

1. 請求書インポートのカスタムフィールドを追加
2. ソーステーブルとターゲットテーブルの間でカスタムフィールドをマッピングする
3. カスタムフィールドをペイロードソース形式にマップする

ソースシステム認証情報 [sn_spend_intg_source_system_credential] テーブルで cXML ペイロードの認証情報を定義します。手順については、「cXML ペイロードでの認証用の認証情報の設定」を参照してください。

関連項目：

• Accounts Payable Invoice Processing
• AP 請求書 API

請求書インポートのカスタムフィールドを追加

AP 請求書 API で使用する請求書、請求書明細行、請求書税明細行のカスタムフィールドを追加するには、次の手順に従います。

始める前に

• 必要なロール：admin
• アプリケーションスコープ：

手順

1. 次のように移動する。 All (すべて) > システム定義 > テーブル.
2. 次のいずれかの請求書インポートテーブルを選択します。
   • 請求書のインポート [sn_spend_intg_imp_invoice]
   • 請求書項目インポート [sn_spend_intg_imp_invoice_line]
   • 請求書税項目インポート [sn_spend_intg_imp_invoice_tax_line]
3. [ テーブルの列 ] タブで、[ 新規] を選択します。
4. [タイプ] メニューからフィールド値に関連付けられたタイプ (整数など) を選択します。
   注:

   有効なタイプのリストについては、「 Field types reference」を参照してください。
5. [列ラベル] フィールドにわかりやすい名前を入力します。
   ラベルを含むテキストは、[ 列名 ] フィールドに自動的に入力されます。
6. [保存] または [送信] を選択します。
7. 同じ名前とタイプの列を請求書 [sn_shop_invoice] テーブルに追加します。
   注:

   列とフィールドの詳細については、「 Exploring field administration」を参照してください。
8. ソーステーブルとターゲットテーブルの間でフィールドをマッピングします。

ソーステーブルとターゲットテーブルの間でカスタムフィールドをマッピングする

AP 請求書 API のソーステーブルとターゲットテーブルの間でカスタムフィールドをマッピングするには、次の手順に従います。

始める前に

• 必要なロール：admin
• アプリケーションスコープ：

ソーステーブルからターゲットテーブルに新しいフィールドをマッピングするためのテーブル列を作成します。請求書インポートのカスタムフィールドを追加の手順を使用します。

手順

1. 次のように移動する。 All (すべて) > システムインポートセット > 変換マップ.
2. 請求書インポートテーブル変換マップを開きます。
3. [フィールド マップ] タブの [新規] をクリックします。
4. [ソースフィールド] メニューからカスタムフィールドの名前を選択します。
5. [ターゲットフィールド] メニューからカスタムフィールドの名前を選択します。
6. [保存] または [送信] を選択します。
7. カスタムフィールドをペイロードソース形式にマップする.

カスタムフィールドをペイロードソース形式にマップする

AP 請求書 API の JSON、cXML、または XML のペイロードエントリにカスタムフィールドをマッピングするには、次の手順に従います。

始める前に

• 必要なロール：admin
• アプリケーションスコープ：
• 請求書インポートのカスタムフィールドを追加
• ソーステーブルとターゲットテーブルの間でカスタムフィールドをマッピングする

手順

1. 次のように移動する。 All (すべて) > 調達統合 > サプライヤー > 請求書統合フィールドマッピング.
2. [New (新規)] を選択します。
3. ソースシステムの名前を [ソースシステム ] フィールドに追加します。
   • このフィールドマッピングをすべてのソースシステムに適用する場合は、「 デフォルト」と入力します。
   • マッピングが特定のソースシステムに固有である場合、この値は API で受信したソースシステムヘッダーパラメーターの値と一致する必要があります。
     注:

     残りのフィールドマッピングはすべて、このソースシステム専用に設定する必要があります。
4. [ソース形式] 選択リスト (cXML または JSON) から、マッピングを作成するソースシステムの形式を選択します。
5. [ソースフィールド] フィールドに、ペイロードエントリの名前 (JSON プロパティ) またはパス (cXML/XML 属性または要素) を指定します。
   請求書統合フィールドマッピング [sn_spend_intg_invoice_intg_field_mapping] テーブルで、cXML および XML パスの設定例を確認できます。
6. フィールドを cXML ペイロードの要素属性として定義する場合は、属性の名前を追加します。それ以外の場合は、フィールドを空のままにします。
7. 関連 テーブル リストから、カスタムフィールドを含むターゲットテーブルの名前を選択します。
8. [ターゲットフィールド] リストからカスタムフィールドの名前を選択します。
9. [保存] または [送信] を選択します。
   マップされたフィールドが請求書統合フィールドマッピング [sn_spend_intg_invoice_intg_field_mapping] テーブルに追加されます。

cXML ペイロードでの認証用の認証情報の設定

sn_spend_intg/ap_invoice/cxml エンドポイントは、ソースシステム認証情報 [sn_spend_intg_source_system_credential] テーブルに格納されている認証情報を使用してペイロードで認証されます。

始める前に

必要なロール：admin

請求書統合フィールドマッピング [sn_spend_intg_invoice_intg_field_mapping] テーブルにリストされているペイロードソースシステムを特定します。

「AP 請求書 – POST sn_spend_intg/ap_invoice/cxml」も参照してください。

手順

1. 次のように移動する。 All (すべて) > 調達統合 > ソースシステムの認証情報.
2. [New (新規)] を選択します。
3. [ ソースシステム ] フィールドに、請求書統合フィールドマッピング [sn_spend_intg_invoice_intg_field_mapping] テーブルにリストされているソースシステムの名前を追加します。
   ソースシステム名は、ソースシステムヘッダーパラメーターと一致する必要があります。
4. フェッチするユーザー名を [ ユーザー名 ] フィールドに追加します。
   この値は 、/cXML/Header/To/Credential [@domain='NetworkID']/Identity 要素で使用します。
5. 文字、数字、および特殊文字の強力な組み合わせを [パスワード ] フィールドに追加します。
   この値は 、/cXML/Header/Sender/Credential [@domain='NetworkID']/SharedSecret 要素で使用します。
6. [Submit (送信)] を選択します。