• 最終編集日時: 10 July 2019

予算品目APIコールの例

予算品目クエリオプションを取得

予算品目APIを使用して、必要な結果セットをクエリして取得する方法の例を以下に示します。

このクエリは、すでに定義されている予算期間名を持つすべての予算品目を返します

https://<instance>.coupa.com/api/budget_lines?period[name]=Q3 FY09

このクエリは、姓が「Carlton」で、この所有者が自分の予算に影響を与えるすべての申請書の承認プロセスの一部でもある予算所有者のすべての予算品目を返します。

https://<instance>.coupahost.com/api/budget_lines?owner[lastname]=Carlton&owner_is_approver=true

このクエリは、勘定科目表という名前の勘定科目セットに属し、会計期間が開いているすべての予算品目を返します。

https://<instance>.coupahost.com/api/budget_lines?period[account-type][name]=chart+of+accounts&period[is_open]=true

予算品目を取得

この例では、以下のIDを持つ単一の予算品目レコードについてクエリを実行しました

URLにGETしました:

https://<instance url>/api/budget_lines/3
または
https://<instance url>/api/budget_lines?id=3

検索条件に一致する回答は次のとおりです。

<?xml version="1.0" encoding="UTF-8"?>
<budget-line>
	 <id type="integer">577</id>
	 <created-at type="datetime">2009-05-04T18:00:58-07:00</created-at>
	 <updated-at type="datetime">2014-04-29T09:55:19-07:00</updated-at>
	 <notes />
	 <description>New IT Equipment Purchased for Company</description>
	 <amount type="decimal">128000.00</amount>
	 <remaining type="decimal">66883.00</remaining>
	 <owner-is-approver nil="true" />
	 <segment-1>HQ</segment-1>
	 <segment-2>Development</segment-2>
	 <segment-3>Assets</segment-3>
	 <segment-4 nil="true" />
	 <segment-5 nil="true" />
	 <segment-6 nil="true" />
	 <segment-7 nil="true" />
	 <segment-8 nil="true" />
	 <segment-9 nil="true" />
	 <segment-10 nil="true" />
	 <segment-11 nil="true" />
	 <segment-12 nil="true" />
	 <segment-13 nil="true" />
	 <segment-14 nil="true" />
	 <segment-15 nil="true" />
	 <segment-16 nil="true" />
	 <segment-17 nil="true" />
	 <segment-18 nil="true" />
	 <segment-19 nil="true" />
	 <segment-20 nil="true" />
	 <error-on-overrun type="boolean">true</error-on-overrun>
	 <period>
			<id type="integer">2</id>
			<created-at type="datetime">2008-10-28T11:27:45-07:00</created-at>
			<updated-at type="datetime">2011-06-07T11:24:05-07:00</updated-at>
			<start-date type="datetime">2009-01-01T00:00:00-08:00</start-date>
			<end-date type="datetime">2009-03-31T01:00:00-07:00</end-date>
			<is-open type="boolean">false</is-open>
			<created-by>
				 <id type="integer">1</id>
				 <login>coupasupport</login>
				 <email>upgrade@coupa.com</email>
				 <employee-number nil="true" />
				 <firstname>Coupa</firstname>
				 <lastname>Support</lastname>
				 <salesforce-id nil="true" />
				 <mycustom-userfield />
			</created-by>
			<updated-by>
				 <id type="integer">1</id>
				 <login>coupasupport</login>
				 <email>upgrade@coupa.com</email>
				 <employee-number nil="true" />
				 <firstname>Coupa</firstname>
				 <lastname>Support</lastname>
				 <salesforce-id nil="true" />
				 <mycustom-userfield />
			</updated-by>
			<segment-1 type="boolean">true</segment-1>
			<segment-2 type="boolean">true</segment-2>
			<segment-3 type="boolean">true</segment-3>
			<segment-4 nil="true" />
			<segment-5 nil="true" />
			<segment-6 nil="true" />
			<segment-7 nil="true" />
			<segment-8 nil="true" />
			<segment-9 nil="true" />
			<segment-10 nil="true" />
			<segment-11 nil="true" />
			<segment-12 nil="true" />
			<segment-13 nil="true" />
			<segment-14 nil="true" />
			<segment-15 nil="true" />
			<segment-16 nil="true" />
			<segment-17 nil="true" />
			<segment-18 nil="true" />
			<segment-19 nil="true" />
			<segment-20 nil="true" />
			<name>Q1 FY09</name>
			<account-type>
				 <id type="integer">1</id>
				 <created-at type="datetime">2008-10-27T13:10:01-07:00</created-at>
				 <updated-at type="datetime">2014-03-17T14:59:59-07:00</updated-at>
				 <name>Ace Corporate</name>
				 <active type="boolean">true</active>
				 <currency>
						<id type="integer">1</id>
						<code>USD</code>
				 </currency>
				 <primary-contact>
						<id type="integer">14</id>
						<created-at type="datetime">2008-10-27T13:10:01-07:00</created-at>
						<updated-at type="datetime">2012-01-18T11:01:36-08:00</updated-at>
						<email>upgrade@coupa.com</email>
						<name-prefix nil="true" />
						<name-suffix nil="true" />
						<name-additional nil="true" />
						<name-given>Jill</name-given>
						<name-family>Harker</name-family>
						<name-fullname nil="true" />
						<notes nil="true" />
						<created-by>
							 <id type="integer">1</id>
							 <login>coupasupport</login>
							 <email>upgrade@coupa.com</email>
							 <employee-number nil="true" />
							 <firstname>Coupa</firstname>
							 <lastname>Support</lastname>
							 <salesforce-id nil="true" />
							 <mycustom-userfield />
						</created-by>
						<updated-by>
							 <id type="integer">1</id>
							 <login>coupasupport</login>
							 <email>upgrade@coupa.com</email>
							 <employee-number nil="true" />
							 <firstname>Coupa</firstname>
							 <lastname>Support</lastname>
							 <salesforce-id nil="true" />
							 <mycustom-userfield />
						</updated-by>
				 </primary-contact>
				 <primary-address>
						<id type="integer">17</id>
						<created-at type="datetime">2008-10-27T13:10:01-07:00</created-at>
						<updated-at type="datetime">2012-01-18T11:01:36-08:00</updated-at>
						<name nil="true" />
						<street1>28 Nevada Blvd</street1>
						<street2 />
						<city>Laughlin</city>
						<state>NV</state>
						<postal-code>94301</postal-code>
						<attention nil="true" />
						<active type="boolean">true</active>
						<business-group-name nil="true" />
						<country>
							 <id type="integer">223</id>
							 <code>US</code>
							 <name>United States</name>
						</country>
						<created-by>
							 <id type="integer">1</id>
							 <login>coupasupport</login>
							 <email>upgrade@coupa.com</email>
							 <employee-number nil="true" />
							 <firstname>Coupa</firstname>
							 <lastname>Support</lastname>
							 <salesforce-id nil="true" />
							 <mycustom-userfield />
						</created-by>
						<updated-by>
							 <id type="integer">1</id>
							 <login>coupasupport</login>
							 <email>upgrade@coupa.com</email>
							 <employee-number nil="true" />
							 <firstname>Coupa</firstname>
							 <lastname>Support</lastname>
							 <salesforce-id nil="true" />
							 <mycustom-userfield />
						</updated-by>
				 </primary-address>
				 <created-by>
						<id type="integer">1</id>
						<login>coupasupport</login>
						<email>upgrade@coupa.com</email>
						<employee-number nil="true" />
						<firstname>Coupa</firstname>
						<lastname>Support</lastname>
						<salesforce-id nil="true" />
						<mycustom-userfield />
				 </created-by>
				 <updated-by>
						<id type="integer">69</id>
						<login>coupasupport+rohitdemo@coupa.com</login>
						<email>coupasupport+rohitdemo@coupa.com</email>
						<employee-number nil="true" />
						<firstname>Integration</firstname>
						<lastname>User</lastname>
						<salesforce-id nil="true" />
						<mycustom-userfield />
				 </updated-by>
			</account-type>
	 </period>
	 <owner>
			<id type="integer">73</id>
			<login>tri</login>
			<email>trishanth.vallurupalli@coupa.com</email>
			<employee-number />
			<firstname>Trishanth</firstname>
			<lastname>Vallurupalli</lastname>
			<salesforce-id nil="true" />
			<mycustom-userfield />
	 </owner>
	 <currency>
			<id type="integer">1</id>
			<code>USD</code>
	 </currency>
	 <created-by>
			<id type="integer">1</id>
			<login>coupasupport</login>
			<email>upgrade@coupa.com</email>
			<employee-number nil="true" />
			<firstname>Coupa</firstname>
			<lastname>Support</lastname>
			<salesforce-id nil="true" />
			<mycustom-userfield />
	 </created-by>
	 <updated-by>
			<id type="integer">69</id>
			<login>coupasupport+rohitdemo@coupa.com</login>
			<email>coupasupport+rohitdemo@coupa.com</email>
			<employee-number nil="true" />
			<firstname>Integration</firstname>
			<lastname>User</lastname>
			<salesforce-id nil="true" />
			<mycustom-userfield />
	 </updated-by>
</budget-line>

 予算品目作成

この例では、既存の期間の予算品目を作成し、金額を計上してい50000す。参照オブジェクトにCoupaシステムIDは使用していません。

URLに投稿しました: https://<instance>.coupahost.com/api/budget_lines.

<?xml version="1.0" encoding="UTF-8"?>
<budget_lines>
	 <segment_1>San_Francisco</segment_1>
	 <segment_2>Marketing</segment_2>
	 <segment_3>Office_Supplies</segment_3>
	 <description>budget for Mary</description>
	 <period>
			<name>Q2 2012</name>
	 </period>
	 <amount>50000</amount>
	 <owner>
			<firstname>Mary (Manager)</firstname>
			<lastname>Snow</lastname>
			<login>msnow</login>
	 </owner>
</budget_lines>

予算品目の更新 – 完全な更新

これらの例では、予算品目レコードのさまざまな情報を更新しています。

URLにPUTを行いました: https://<instance>.coupahost.com/api/budget_lines/<budget line id>

たとえば、予算品目ID 616の予算所有者を更新するには次を実行します。

URL: https://<instance>.coupahost.com/api/budget_lines/616

<?xml version="1.0" encoding="UTF-8"?>
<budget_lines>
	 <notes>Carlton is the budget owner</notes>
	 <description>this is for budget period Q2 - 2010</description>
	 <owner>
			<login>mcarlton</login>
	 </owner>
</budget_lines>

 予算品目の更新 – 単純更新

これらの例では、予算品目レコードの単一の属性を更新しています。

URLにPUTを行いました:  https://<instance url>/api/budget_lines/<budget line id>

たとえば、この予算品目に割り当てられた金額を予算品目ID 616で7500に更新するには、次の操作を行います

URL:    https://<instance url>/api/budget_lines/616

<?xml version="1.0" encoding="UTF-8"?>
<budget_lines>
	 <amount>7500</amount>
</budget_lines>

 

このページに表示されている一部、または全ての内容は、機械翻訳によるものです。ご了承ください。

  • Inhalt