Company API

Use the Company API's to create, update, or query the Company Data. 

The URL to access the API's is : https://<instance>.cso.coupahost.com/api/companies

See Integration Best Practices for more info.

Actions

Elements

These are the elements available for the Company API

Examples

In this example, we queried for a company API. We did a GET to the URL: 

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

Company GET Response

{
		"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"
				}
	 ]
}

Create/Update

The following describes how you can use the Coupa API to perform actions on Company.

Create

/api/companies

The below payload creates two Companies.

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"
				}
		]
}	 

Update

/api/companies

The below payload updates a Company(ies). 

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
}

Successful requests will return HTTP 200 Response. The body of the response will include the created requisition. Unsuccessful requests will return HTTP 400 Bad Request. The body of the response will include validation errors formatted as XML.