• Dernière modification le: 10 July 2019

Exemples d'appels API des lignes budgétaires

Obtenir les options de requête de ligne budgétaire

Voici d'autres exemples d'utilisation de l'API de ligne de budget pour interroger et obtenir le jeu de résultats souhaité.

Cette requête renverra toutes les lignes budgétaires avec un nom de période budgétaire déjà défini

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

Cette requête renverra toutes les lignes de budget pour le responsable du budget avec le nom de famille "Carlton" et que ce responsable fait également partie du processus d'approbation avec toutes les demandes affectant ses budgets.

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

Cette requête renvoie toutes les lignes budgétaires appartenant à l'ensemble de comptes nommé Plan comptable et où la période comptable est ouverte.

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

LIGNE DE BUDGET GET

Dans cet exemple, nous avons recherché un enregistrement de ligne budgétaire unique avec l'ID

Nous avons accédé à l'URL :

https://<instance url>/api/budget_lines/3
ou
https://<instance url>/api/budget_lines?id=3

Voici la réponse correspondant aux critères de recherche :

<?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>

 Ligne budgétaire créée

Dans cet exemple, nous créons une ligne budgétaire pour une période existante et comptabilisons un montant de 50000. Nous n'utilisons aucun ID système Coupa pour les objets de référence.

Nous l'avons publié sur l'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>

Mettre à jour les lignes budgétaires - Mise à jour complète

Dans ces exemples, nous mettons à jour différentes informations sur l'enregistrement de ligne budgétaire.

Nous avons effectué un PUT vers l'URL : https://<instance>.coupahost.com/api/budget_lines/<budget line id>

Par exemple, pour mettre à jour le responsable du budget pour l'ID de ligne budgétaire 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>

 Mettre à jour les lignes budgétaires - simple mise à jour

Dans ces exemples, nous mettons à jour un attribut unique sur l'enregistrement de ligne budgétaire.

Nous avons effectué un PUT vers l'URL :  https://<instance url>/api/budget_lines/<budget line id>

Par exemple, pour mettre à jour le montant alloué à cette ligne budgétaire à 7500 avec l'ID de ligne budgétaire 616

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

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

 

Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.

Articles associés


API Coupa Core

Notre API RESTful fournit un accès fiable pour lire, modifier ou intégrer vos données à la plateforme Coupa.

Démarrez avec l'API

Informations générales sur l'utilisation de l'API Coupa et quand vous devez envisager d'utiliser CSV.

Transition vers OAuth 2.0 et OIDC

Coupa désapprouve les API Keys héritées et nécessite l'utilisation d'OAuth 2.0 / OIDC. À partir de R34, aucune nouvelle clé API ne sera émise et les clés API ne seront plus prises en charge avec R35.

Ressources

Nous avons organisé nos points de terminaison API par type d'objet : données de référence, données transactionnelles et ressources partagées.