Platform ID Company GET
GET /api/account/{account}/accounting/{platform}/{id}/company
Gets company data.
URL Parameters
account* | Account | |
---|---|---|
platform* | Connection Platform | |
id* | Connection ID |
Responses
200 OK
id | string | |
---|---|---|
timeZone | string | |
name | string | |
lineOfBusiness | string | |
legalName | string | |
taxNumber | string | |
companyNumber | string | |
country | string | |
addresses | array[object] | |
addressLine1 | string | |
addressLine2 | string | |
addressLine3 | string | |
addressLine4 | string | |
city | string | |
region | string | |
postalCode | string | |
country | string | |
phones | array[object] | |
type | string | |
countryCode | string | |
areaCode | string | |
phoneNumber | string | |
createdDate | string | |
syncMetadata | object |
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
Example Success Response
{
"id": "string",
"timeZone": "string",
"name": "string",
"lineOfBusiness": "string",
"legalName": "string",
"taxNumber": "string",
"companyNumber": "string",
"country": "string",
"addresses": [
{
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string"
}
],
"phones": [
{
"type": "string",
"countryCode": "string",
"areaCode": "string",
"phoneNumber": "string"
}
],
"createdDate": "string",
"syncMetadata": null
}