予算明細API (/budget lines)
予算明細APIを使用すると、アカウントに関連付けられている予算明細を作成および更新できます。
予算明細にアクセスするためのURLは次のとおりです。 https ://<instance>/api/budget lines
詳細については、統合のベストプラクティスを参照してください。
注:
- 静的な勘定科目表をベースとした予算期間を使用してこのAPIを送信する場合、含まれるセグメント値が既存の勘定科目からのものである必要があります。
- 動的な勘定科目表を使用してこのAPIを送信する場合、含まれるセグメント値は既存の勘定科目セグメントまたは検索値と一致する必要があります。 このAPIは勘定科目を直接作成しません。
アクション
予算明細APIでは以下の操作が可能です。
| 動詞 | パス | アクション | 説明 |
|---|---|---|---|
| PUT | /api/budget_lines /: id/adjust | adjust | 予算明細の予算明細調整を作成 |
| POST | /api/budget_lines | 作成 | 新規予算明細を作成 |
| GET | /api/budget_lines | インデックス | 予算明細を検索 |
| GET | /api/budget_lines /: id | 表示 | 予算明細を表示 |
| PUT | /api/budget_lines /: id | 更新 | 予算明細を更新 |
Elements
予算明細APIでは、次の要素を使用できます。
| 要素 | 説明 | 必須フィールド？ | 一意？ | 許容値 | Api_Inフィールド？ | Api_Outフィールド？ | データタイプ |
|---|---|---|---|---|---|---|---|
| 金額 | 金額 | yes | 小数 | ||||
| 作成日時 | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| created-by | 作成したユーザー | yes | ユーザー | ||||
| currency | 取引の通貨 | yes | yes | Currency | |||
| description | description | yes | yes | 文字列 | |||
| error-on-overrun | 申請書が予算を超過する場合は送信を阻止 | yes | yes | boolean | |||
| ID | Coupaの一意の識別子 | yes | 整数 | ||||
| notes | notes | yes | yes | テキスト | |||
| overrun-calculation | 超過計算 | yes | yes | 整数 | |||
| 所有者 | 予算所有者 | yes | yes | ユーザー | |||
| owner-is-approver | 所有者が承認者かどうか | yes | yes | 整数 | |||
| pending_requisitions_amount | 保留中の申請書によって消費された金額 | yes | 小数 | ||||
| period | これは予算明細のニックネームです。 ユーザーは、ユーザーインターフェイスを介してこのフィールドを表示および検索できます。 | yes | yes | yes | 期間 | ||
| 残 | 残 | yes | 小数 | ||||
| remaining-budget | 残りの予算 | yes | 小数 | ||||
| segment-1 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-10 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-11 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-12 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-13 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-14 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-15 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-16 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-17 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-18 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-19 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-2 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-20 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-3 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-4 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-5 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-6 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-7 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-8 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| segment-9 | オプションで、各セグメントを個別に指定します。これは、セグメントのいずれかにダッシュ「-」文字が含まれている場合に必要です。これにより、予算化セグメントコードが自動的に分割されなくなります | yes | yes | 文字列 | |||
| set-amount-from-xml | XMLによる金額設定 | yes | |||||
| updated-at | CoupaがYYY-MM-DDTHH:MM:SS+HH:MMZの形式で自動的に作成します | yes | datetime | ||||
| updated-by | 更新したユーザー | yes | ユーザー |
注:
- 大規模なデータセットの場合、パフォーマンスの最適化のために、常にいくつかのGET条件で結果を制限してください。
- POSTを使用して、既存の予算期間と既存の勘定科目区分(つまり、segment-1、segment-2など)の新しい予算明細を作成できます。 つまり、APIを使用して新しい予算期間を作成することはできません。
- 予算明細が作成され、勘定科目タイプ(つまり、勘定科目表)と特定の勘定科目に関連付けられると、この情報を変更することはできません。