Codat Get Company Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-company",
"method": "GET",
"path": "/companies/{companyId}",
"summary": "Get company",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "Simple company",
"example": {
"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0",
"name": "Toft stores holdings",
"description": "",
"platform": "",
"redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0",
"dataConnections": [],
"created": "2022-11-10T10:45:18Z",
"createdByUserName": "Dan Tzabar",
"products": [
"spend-insights",
"lending",
"expenses-v1",
"commerce"
],
"referenceSubsidiaryCompanies": []
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Parent multi-entity company",
"example": {
"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0",
"name": "Toft stores",
"description": "",
"platform": "",
"redirect": "https://link.codat.io/company/ab12c58d-a678-4ebf-a159-ae99e1807bd0",
"dataConnections": [],
"created": "2022-11-10T10:45:18Z",
"createdByUserName": "Dan Tzabar",
"products": [
"spend-insights",
"lending",
"expenses-v1",
"commerce"
],
"referenceSubsidiaryCompanies": [
{
"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d",
"name": "Toft stores UK",
"links": {
"portal": "https://app.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/summary"
}
},
{
"id": "db94eddc-9212-4568-9b5c-3eab0e325913",
"name": "Toft stores US",
"links": {
"portal": "https://app.codat.io/companies/db94eddc-9212-4568-9b5c-3eab0e325913/summary"
}
}
]
}
},
{
"status": "200",
"contentType": "application/json",
"name": "Subsidiary multi-entity company",
"example": {
"id": "c8d3af58-7011-47ce-b3f2-89faf300ef6d",
"name": "Toft stores UK",
"description": "",
"platform": "",
"redirect": "https://link.codat.io/company/c8d3af58-7011-47ce-b3f2-89faf300ef6d",
"dataConnections": [
{
"id": "d5ab61b7-1ad0-46fd-9f9f-b6761047941e",
"integrationId": "cc750323-5a47-4f28-8d8e-30fbbf2ce137",
"integrationKey": "akxx",
"sourceId": "9815b998-024d-4415-a40b-89903b2cad6f",
"platformName": "Oracle NetSuite",
"linkUrl": "https://link-api.codat.io/companies/c8d3af58-7011-47ce-b3f2-89faf300ef6d/connections/d5ab61b7-1ad0-46fd-9f9f-b6761047941e/start",
"status": "Linked",
"lastSync": "2022-01-01T12:30:00.000Z",
"created": "2022-01-01T11:30:00Z",
"sourceType": "Accounting"
}
],
"created": "2022-11-10T10:45:18Z",
"createdByUserName": "Dan Tzabar",
"products": [
"spend-insights",
"lending",
"expenses-v1",
"commerce"
],
"referenceParentCompany": {
"id": "ab12c58d-a678-4ebf-a159-ae99e1807bd0",
"name": "Toft stores",
"links": {
"portal": "https://app.codat.io/companies/ab12c58d-a678-4ebf-a159-ae99e1807bd0/summary"
}
},
"referenceSubsidiaryCompanies": []
}
}
]
}