Skip to content

Company User Master Data Api (1.0)

Download OpenAPI description
OpenAPISpecification.json
Languages
Servers

https://ws-cumd.traceone.com/

Companies

Operations

Search Companies by Ids

Request

Search Companies by Ids

Security
Bearer
Body
companyIdsArray of strings(uuid)required

Max 1000 ids

curl -i -X POST \
  https://ws-cumd.traceone.com/api/companies/collections \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "companyIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Success

Bodyapplication/jsonArray [
companyPostCodestring
companyAddressstring
companyCountryIdstring(uuid)
companyIdstring(uuid)
seCompanyIdstring(uuid)
companyLegalNamestring
companyDisplayNamestring
companyAddress1string
companyAddress2string
companyPostalCodestring
companyCitystring
companyCountrystring
companyLogoUrlstring
companyActivityIdinteger(int32)
companyStatusstring
applicationTypeIdsArray of integers(int32)
companyStatestring
companyPhonestring
companyFaxstring
companyEmailstring
companyIdentifiersArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.IdentifierCode)
companyCategoriesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.Category)
companyRevenuestring
companyCurrencystring
companySizestring
companyCreationDatestring(date-time)
companyProductionCapacitystring
companyDeliveryAddress1string
companyDeliveryAddress2string
companyDeliveryPostalCodestring
companyDeliveryCitystring
companyDeliveryCountrystring
companyDeliveryStatestring
seExternalCodestring
companyTypestring
registeredOwnerCompanyIdstring(uuid)
testCompanyboolean
createdAtstring(date-time)
modifiedAtstring(date-time)
lastStatusUpdatedDatestring(date-time)
targetSuspendDatestring(date-time)
emergencyPhonesArray of strings
registeredCapitalstring
legalStatusCodestring
]
Response
application/json
[
  {
    "companyPostCode": "string",
    "companyAddress": "string",
    "companyCountryId": "78e253f1-6440-46fe-bbed-ebb50557d66c",
    "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
    "seCompanyId": "68ac9e5e-be05-4814-907a-889be2cb1304",
    "companyLegalName": "string",
    "companyDisplayName": "string",
    "companyAddress1": "string",
    "companyAddress2": "string",
    "companyPostalCode": "string",
    "companyCity": "string",
    "companyCountry": "string",
    "companyLogoUrl": "string",
    "companyActivityId": 0,
    "companyStatus": "string",
    "applicationTypeIds": [ … ],
    "companyState": "string",
    "companyPhone": "string",
    "companyFax": "string",
    "companyEmail": "string",
    "companyIdentifiers": [ … ],
    "companyCategories": [ … ],
    "companyRevenue": "string",
    "companyCurrency": "string",
    "companySize": "string",
    "companyCreationDate": "2019-08-24T14:15:22Z",
    "companyProductionCapacity": "string",
    "companyDeliveryAddress1": "string",
    "companyDeliveryAddress2": "string",
    "companyDeliveryPostalCode": "string",
    "companyDeliveryCity": "string",
    "companyDeliveryCountry": "string",
    "companyDeliveryState": "string",
    "seExternalCode": "string",
    "companyType": "string",
    "registeredOwnerCompanyId": "03fd83a5-6547-4a2e-b3b0-ec77d1c691ce",
    "testCompany": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "modifiedAt": "2019-08-24T14:15:22Z",
    "lastStatusUpdatedDate": "2019-08-24T14:15:22Z",
    "targetSuspendDate": "2019-08-24T14:15:22Z",
    "emergencyPhones": [ … ],
    "registeredCapital": "string",
    "legalStatusCode": "string"
  }
]

Search Companies by filters

Request

Search Companies by filters. <br />It will return related companies only. Only Service token can request companies data without relation. <br />If a retailer has a SFM model, it will return companies with Active contracts only.

Security
Bearer
Query
CompanyLegalNamestring
CompanyDisplayNamestring
CompanyAddress1string
CompanyAddress2string
CompanyPostalCodestring
CompanyCitystring
CompanyDunsstring
CompanyCountrystring
CompanyActivityIdinteger(int32)
TestCompanyboolean
IsTraceOneboolean
IsEnabledboolean
IsDisabledboolean
IsSuspendedboolean
HasADunsboolean
RelatedOwnerCompanyIdstring(uuid)

If RelatedOwnerCompanyId is completed, RelatedAssociatedCompanyId must remain empty. (Otherwise, result will always be empty.)

RelatedAssociatedCompanyIdstring(uuid)

If RelatedAssociatedCompanyId is completed, RelatedOwnerCompanyId must remain empty. (Otherwise, result will always be empty.)

IncludePrivateboolean

Set to True to include Private Companies in the result. False by default.

SearchTextstring

Search in company display name, legal name, postal code, city, state, external name and external identifier.

SearchNamestring

Search in company display name, external name and external identifier.

CompanyTypestring
IsCompanyRelationStatusEnabledboolean
OnlyWithoutContactsboolean
ContactUserIdstring(uuid)
ContactResponsibilityIdstring(uuid)
RelatedCategoryIdstring(uuid)
RelatedCategoryItemIdstring(uuid)
Skipinteger(int32)
Takeinteger(int32)

Max 1000 records are allowed. Default value is 100.

Body
companyIdsArray of strings(uuid)
applicationTypeIdsArray of integers(int32)
curl -i -X POST \
  'https://ws-cumd.traceone.com/api/companies/filters?CompanyLegalName=string&CompanyDisplayName=string&CompanyAddress1=string&CompanyAddress2=string&CompanyPostalCode=string&CompanyCity=string&CompanyDuns=string&CompanyCountry=string&CompanyActivityId=0&TestCompany=true&IsTraceOne=true&IsEnabled=true&IsDisabled=true&IsSuspended=true&HasADuns=true&RelatedOwnerCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RelatedAssociatedCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&IncludePrivate=true&SearchText=string&SearchName=string&CompanyType=string&IsCompanyRelationStatusEnabled=true&OnlyWithoutContacts=true&ContactUserId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ContactResponsibilityId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RelatedCategoryId=497f6eca-6276-4993-bfeb-53cbbbba6f08&RelatedCategoryItemId=497f6eca-6276-4993-bfeb-53cbbbba6f08&Skip=0&Take=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "companyIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "applicationTypeIds": [
      0
    ]
  }'

Responses

Success

Bodyapplication/json
companiesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.Queries.GetCompaniesByFiltersQuery_CompanyViewModel)
skipAndTakeQueryStatsobject(TraceOne.ApiPlatform.MessagesSharedWithClients.Optional.SkipAndTakeQueryStats)
Response
application/json
{
  "companies": [
    { … }
  ],
  "skipAndTakeQueryStats": {
    "totalCount": 0,
    "currentCount": 0
  }
}

Get detail of a Company

Request

Get detail of a Company. CompanyDuns data is available only for Company Admin

Security
Bearer
Path
idstring(uuid)required
curl -i -X GET \
  'https://ws-cumd.traceone.com/api/companies/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
companyDunsstring
mainContactUserIdstring(uuid)
mainContactUserNamestring
mainContactUserEmailstring
mainContactUserPhonestring
companyGroupIdstring(uuid)
companyIdstring(uuid)
seCompanyIdstring(uuid)
companyLegalNamestring
companyDisplayNamestring
companyAddress1string
companyAddress2string
companyPostalCodestring
companyCitystring
companyCountrystring
companyLogoUrlstring
companyActivityIdinteger(int32)
companyStatusstring
applicationTypeIdsArray of integers(int32)
companyStatestring
companyPhonestring
companyFaxstring
companyEmailstring
companyIdentifiersArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.IdentifierCode)
companyCategoriesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.Category)
companyRevenuestring
companyCurrencystring
companySizestring
companyCreationDatestring(date-time)
companyProductionCapacitystring
companyDeliveryAddress1string
companyDeliveryAddress2string
companyDeliveryPostalCodestring
companyDeliveryCitystring
companyDeliveryCountrystring
companyDeliveryStatestring
seExternalCodestring
companyTypestring
registeredOwnerCompanyIdstring(uuid)
testCompanyboolean
createdAtstring(date-time)
modifiedAtstring(date-time)
lastStatusUpdatedDatestring(date-time)
targetSuspendDatestring(date-time)
emergencyPhonesArray of strings
registeredCapitalstring
legalStatusCodestring
Response
application/json
{
  "companyDuns": "string",
  "mainContactUserId": "090138b7-9fd0-4bb1-bbaf-8c06df869f05",
  "mainContactUserName": "string",
  "mainContactUserEmail": "string",
  "mainContactUserPhone": "string",
  "companyGroupId": "590561a3-d0b2-4aa6-828c-aba739aba55a",
  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  "seCompanyId": "68ac9e5e-be05-4814-907a-889be2cb1304",
  "companyLegalName": "string",
  "companyDisplayName": "string",
  "companyAddress1": "string",
  "companyAddress2": "string",
  "companyPostalCode": "string",
  "companyCity": "string",
  "companyCountry": "string",
  "companyLogoUrl": "string",
  "companyActivityId": 0,
  "companyStatus": "string",
  "applicationTypeIds": [
    0
  ],
  "companyState": "string",
  "companyPhone": "string",
  "companyFax": "string",
  "companyEmail": "string",
  "companyIdentifiers": [
    { … }
  ],
  "companyCategories": [
    { … }
  ],
  "companyRevenue": "string",
  "companyCurrency": "string",
  "companySize": "string",
  "companyCreationDate": "2019-08-24T14:15:22Z",
  "companyProductionCapacity": "string",
  "companyDeliveryAddress1": "string",
  "companyDeliveryAddress2": "string",
  "companyDeliveryPostalCode": "string",
  "companyDeliveryCity": "string",
  "companyDeliveryCountry": "string",
  "companyDeliveryState": "string",
  "seExternalCode": "string",
  "companyType": "string",
  "registeredOwnerCompanyId": "03fd83a5-6547-4a2e-b3b0-ec77d1c691ce",
  "testCompany": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "lastStatusUpdatedDate": "2019-08-24T14:15:22Z",
  "targetSuspendDate": "2019-08-24T14:15:22Z",
  "emergencyPhones": [
    "string"
  ],
  "registeredCapital": "string",
  "legalStatusCode": "string"
}

Search a Company by User Id

Request

Search a Company by User Id

Security
Bearer
Path
userIdstring(uuid)required
curl -i -X GET \
  'https://ws-cumd.traceone.com/api/users/{userId}/company' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
idstring(uuid)
companyIdstring(uuid)
seCompanyIdstring(uuid)
companyLegalNamestring
companyDisplayNamestring
companyAddress1string
companyAddress2string
companyPostalCodestring
companyCitystring
companyCountrystring
companyLogoUrlstring
companyActivityIdinteger(int32)
companyStatusstring
applicationTypeIdsArray of integers(int32)
companyStatestring
companyPhonestring
companyFaxstring
companyEmailstring
companyIdentifiersArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.IdentifierCode)
companyCategoriesArray of objects(TraceOne.Api.CompanyUserMasterData.Default.Messages.ViewModels.Category)
companyRevenuestring
companyCurrencystring
companySizestring
companyCreationDatestring(date-time)
companyProductionCapacitystring
companyDeliveryAddress1string
companyDeliveryAddress2string
companyDeliveryPostalCodestring
companyDeliveryCitystring
companyDeliveryCountrystring
companyDeliveryStatestring
seExternalCodestring
companyTypestring
registeredOwnerCompanyIdstring(uuid)
testCompanyboolean
createdAtstring(date-time)
modifiedAtstring(date-time)
lastStatusUpdatedDatestring(date-time)
targetSuspendDatestring(date-time)
emergencyPhonesArray of strings
registeredCapitalstring
legalStatusCodestring
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  "seCompanyId": "68ac9e5e-be05-4814-907a-889be2cb1304",
  "companyLegalName": "string",
  "companyDisplayName": "string",
  "companyAddress1": "string",
  "companyAddress2": "string",
  "companyPostalCode": "string",
  "companyCity": "string",
  "companyCountry": "string",
  "companyLogoUrl": "string",
  "companyActivityId": 0,
  "companyStatus": "string",
  "applicationTypeIds": [
    0
  ],
  "companyState": "string",
  "companyPhone": "string",
  "companyFax": "string",
  "companyEmail": "string",
  "companyIdentifiers": [
    { … }
  ],
  "companyCategories": [
    { … }
  ],
  "companyRevenue": "string",
  "companyCurrency": "string",
  "companySize": "string",
  "companyCreationDate": "2019-08-24T14:15:22Z",
  "companyProductionCapacity": "string",
  "companyDeliveryAddress1": "string",
  "companyDeliveryAddress2": "string",
  "companyDeliveryPostalCode": "string",
  "companyDeliveryCity": "string",
  "companyDeliveryCountry": "string",
  "companyDeliveryState": "string",
  "seExternalCode": "string",
  "companyType": "string",
  "registeredOwnerCompanyId": "03fd83a5-6547-4a2e-b3b0-ec77d1c691ce",
  "testCompany": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "modifiedAt": "2019-08-24T14:15:22Z",
  "lastStatusUpdatedDate": "2019-08-24T14:15:22Z",
  "targetSuspendDate": "2019-08-24T14:15:22Z",
  "emergencyPhones": [
    "string"
  ],
  "registeredCapital": "string",
  "legalStatusCode": "string"
}

Users

Operations

Registrations

Operations

Company Relations

Operations