Batch Integrate Companies with an External Data Source
post
/primeapi/restapi/company/syncBatch
Send a request to this endpoint to create or update one or more integrated companies. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.
Request
Supported Media Types
- application/json
The unique identifier of company data in an external source.S
Root Schema : List<ApiEntityExternallySourcedCompany>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedCompany>
Nested Schema : ApiEntityExternallySourcedCompany
Type:
Show Source
object
-
addressLine1:
string
The first line of the address of a location.
This might be the building number and street address. -
addressLine2:
string
The second line of the address of a location.
This might be a neighborhood or town. -
cityName:
string
The city name for a location.
-
code:
string
The unique identifier for the company.
-
companyCode:
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for the company. -
companyConfiguredFields:
object ApiEntityCompanyConfiguredFields
-
companyId:
integer(int64)
The system-generated identifier of a company.
-
companyName:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the company. -
countryCode:
string
The country for a location.
-
description:
string
Allowed Values:
[ "Length[1-4000]" ]
Additional information about the company. -
fax:
string
Allowed Values:
[ "Length[1-32]" ]
The fax number for the company. -
isTenantOwned:
boolean
Default Value:
false
Indicates whether or not the company is an application tenant. -
latitude:
number(double)
The latitude of a company.
-
link:
string(uri)
Read Only:
true
-
locationName:
string
A name for the location that your users will understand and recognize.
-
longitude:
number(double)
The geographical coordinate for the longitude of the location.
The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service. -
otherPhone:
string
Allowed Values:
[ "Length[1-32]" ]
An alternate phone number for a company. -
phone:
string
Allowed Values:
[ "Length[1-32]" ]
The phone number for the company. -
postalCode:
string
The postal code, post code, or zip code of a location.
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace company. -
sourceId:
string
The unique identifer of company data in an external source.Example:
coarse
-
sourceSiteId:
string
The unique identifier of a company site in an external source.
-
stateCode:
string
A unique identifier for the state or province.
-
stateName:
string
The state, region, or province of a location.
-
status:
string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The status of the company. Valid values are Active and Inactive. -
type:
string
Allowed Values:
[ "OWNER", "VENDOR", "RESELLER", "DESIGN_CONSULTANT", "SUB_CONTRACTOR", "SUPPLIER" ]
The type of company. Valid values are Owner, Vendor, Reseller, Design Consultant, Sub Contractor, and Supplier. -
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date. -
url:
string
Allowed Values:
[ "Length[1-255]" ]
The website of the company. -
workspaceCode:
string
-
workspaceId:
integer(int64)
The workspace that the company was created in. All changes to the company must be made in the owning workspace.
Nested Schema : ApiEntityCompanyConfiguredFields
Type:
Show Source
object
-
companyId:
integer(int64)
-
costFlexMap:
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a company.
-
link:
string(uri)
Read Only:
true
-
otherFlexMap:
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a company.
-
textFlexMap:
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a company.
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a company.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a company.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a company.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
207 Response
Successful Sync Operation.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object
-
link:
string(uri)
Read Only:
true
-
message:
string
-
primaryKey:
integer(int64)
-
primaryKeyName:
string
-
primaryKeyValue:
integer(int64)
-
sourceId:
string
-
statusCode:
integer(int32)
-
uniqueName:
string
-
updateDate:
string(date-time)
Read Only:
true
The date on which the object was last updated. This parameter is not included in POST request responses. Use this parameter filter objects returned from GET requests by a particular modification date.
400 Response
Invalid Input.