会社API

会社APIを使用して、会社データを作成、更新、またはクエリします。 

APIにアクセスするためのURLは次のとおりです。 https://<instance>.cso.coupahost.com/api/companies

詳細については、 「インテグレーションのベストプラクティス 」を参照してください。

アクション

要素

以下は会社APIで使用できる要素です

例

この例では、会社APIについてクエリを実行しました。URLにGETしました： 

https://<instance>.cso.coupahost.com/api/companies 

会社のGET応答

{
		"total": 7,
		"compannies": [
				{
						"id": "9219592888303484960",
						"state": "Active",
						"name": "! New Supplier (Spanish)"
				},
				{
						"id": "9219594398656586067",
						"state": "Active",
						"name": "! Simon Test Organization",
						"email": "simon@kepgames.com"
				},
				{
						"id": "9219592919623127484",
						"state": "Active",
						"name": "! SKF (test bidders)"
				},
				{
						"id": "9219592881350550871",
						"state": "Active",
						"name": "! Spanish bidder",
						"email": "heloisa.spanish@tradeext.com"
				},
				{
						"id": "9219592230193035378",
						"state": "Active",
						"name": "! TE",
						"email": "lorena@te.se",
						"duns-scac": "testing123456789",
						"keywords": "test"
				},
				{
						"id": "9219596145584379778",
						"state": "Active",
						"name": "! TE Test Company"
				},
				{
						"id": "9219592639285418804",
						"state": "Active",
						"name": "! TE Test Company 2",
						"phone-number": "123-234-3456",
						"email": "testcompany2+upg@coupa.com",
						"street": "street address1",
						"zip-code": "12345",
						"city": "valahalla",
						"country": "United States Minor Outlying Islands",
						"keywords": "Carrier"
				}
	 ]
}

作成/更新

以下では、Coupa APIを使用して会社でアクションを実行する方法について説明します。

作成

/api/companies

以下のペイロードは2つの会社を作成します。

Payload: 
{
		"companies": [
				{
						"state": "Active",
						"name": "Yes Heloisa",
						"duns-scac": "Shall be updated"
				},
				{
						"name": "TE Test Company 2",
						"phone-number": "123-234-3456",
						"email": "testcompany2+upg@coupa.com"
				}
		]
}

Response: 201
{
		"result": [
				{
						"type": "api.post.added",
						"description": "2 objects created."
				}
		],
		"added": 2,
		"companies": [
				{
						"id": "9220538753256092391"
				},
				{
						"id": "9220538753250662192"
				}
		]
}	 

更新

/api/companies

以下のペイロードは会社を更新します。 

To update one or more Company at a time: 
Payload:
{
		"companies": [
				{
						"id": "9219594319065198091",
						"state": "Active",
						"name": "! (TE) Heloisa",
						"duns-scac": "Shall be updated"
				},
				{
						"id": "9219596218212801426",
						"state": "Active",
						"name": "! (TE) Org only with bidders (Italian)",
						"duns-scac": "Shall be updated",
						"email": "testbidders_itl@coupa.com"
				},
				{
						"id": "9219596218212801429",
						"state": "Active",
						"name": "! (TE) Org with only bidders",
						"duns-scac": "Shall be updated",
						"keywords": "Bidders"
				}
		]
}

Response: 200 OK
{
		"result": [
				{
						"type": "api.put.updated",
						"description": "3 objects updated."
				}
		],
		"updated": 3
}

成功したリクエストは返り HTTP 200 Responseます。回答の本文には、作成された申請書が含まれます。失敗したリクエストは返 HTTP 400 Bad Requestされる。応答の本文には、XMLとしてフォーマットされた検証エラーが含まれます。