Batch Integrate Project Actuals Data with an External Data Source
post
/primeapi/restapi/projectActuals/syncBatch
Send a request to this endpoint to create or update one or more integrated project actuals data. 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 project actual data in an external source.S
Root Schema : List<ApiEntityExternallySourcedProjectActuals>
Type:
array
Title:
Show Source
List<ApiEntityExternallySourcedProjectActuals>
Nested Schema : ApiEntityExternallySourcedProjectActuals
Type:
Show Source
object
-
approvedByUserId(optional):
integer(int64)
Read Only:
true
The username of the user who approved the item. -
approvedDate(optional):
string(date-time)
Read Only:
true
The date that the actual was approved. -
companyName(optional):
string
The name of a company.
-
companySourceId(optional):
string
The unique identifier of company data in an external source.
-
confirmedByEmailAddress(optional):
string
Indicates whether or not the project actual has been confirmed via email.
-
currencyCode(optional):
string
The user-specified identifier of a currency.
-
currencyId(optional):
integer(int64)
Read Only:
true
The currency associated with the actual. -
description(optional):
string
Allowed Values:
[ "Length[1-4000]" ]
Details about the actual. -
effectiveDate(optional):
string(date-time)
The date the actual is effective.
-
fixedExchangeRate(optional):
number
Read Only:
true
The exchange rate used to convert the Total Amount value from the record currency to the base currency. -
itemPrefix(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The auto numbering prefix of a code. -
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
projectActualCode:
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for an actual. -
projectActualConfiguredFields(optional):
object ApiEntityProjectActualsConfiguredFields
-
projectActualId(optional):
integer(int64)
The unique identifier of project actual data.
-
projectActualName:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the actual. -
projectActualsCost(optional):
object ApiEntityProjectActualsCost
-
projectCode(optional):
string
The user-specified identifier of a project.
-
projectCompanyId(optional):
integer(int64)
The name of the company associated with the actual.
-
projectId:
integer(int64)
The unique identifier for the project.
-
projectSourceId(optional):
string
The unique identifier of project data in an external source.
-
sourceId(optional):
string
The unique identifier of project actual data in an external source.Example:
coarse
-
status(optional):
string
Read Only:
true
Allowed Values:[ "PENDING", "CONFIRMED" ]
That status of the actual. Valid values are Pending and Confirmed. -
totalHours(optional):
object Hour
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
withdrawByUserId(optional):
integer(int64)
Read Only:
true
The username of the user who withdrew confirmation of the project actual. -
withdrawConfirmedByEmailAddress(optional):
string
Indicates whether or not the actual withdrawl has been confirmed via email.
-
withdrawDate(optional):
string(date-time)
Read Only:
true
The date that confirmation of the project actual was withdrawn. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
Nested Schema : ApiEntityProjectActualsConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a project actual.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a project actual.
-
projectActualId(optional):
integer(int64)
The unique identifier of project actual data.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a project actual.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityProjectActualsCost
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
projectActualId(optional):
integer(int64)
-
projectActuals(optional):
object ApiEntityProjectActuals
-
totalAmount(optional):
object Cost
-
totalAmountProject(optional):
object Cost
-
totalAmountProjectActuals(optional):
object Cost
-
totalAmountWithCbs(optional):
object Cost
-
totalAmountWithCbsProject(optional):
object Cost
-
totalAmountWithCbsProjectActuals(optional):
object Cost
-
totalAmountWorkspace1(optional):
object Cost
-
totalAmountWorkspace2(optional):
object Cost
-
totalAmountWorkspace3(optional):
object Cost
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a project actual.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a project actual.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a project actual.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : ApiEntityProjectActuals
Type:
Show Source
object
-
approvedByUserId(optional):
integer(int64)
Read Only:
true
The username of the user who approved the item. -
approvedDate(optional):
string(date-time)
Read Only:
true
The date that the actual was approved. -
currencyId(optional):
integer(int64)
Read Only:
true
The currency associated with the actual. -
description(optional):
string
Allowed Values:
[ "Length[1-4000]" ]
Details about the actual. -
effectiveDate(optional):
string(date-time)
The date the actual is effective.
-
fixedExchangeRate(optional):
number
Read Only:
true
The exchange rate used to convert the Total Amount value from the record currency to the base currency. -
itemPrefix(optional):
string
Allowed Values:
[ "Length[1-60]" ]
The auto numbering prefix of a code. -
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
projectActualCode:
string
Allowed Values:
[ "Length[1-60]" ]
The unique identifier for an actual. -
projectActualConfiguredFields(optional):
object ApiEntityProjectActualsConfiguredFields
-
projectActualId(optional):
integer(int64)
The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
-
projectActualName:
string
Allowed Values:
[ "Length[1-255]" ]
The name of the actual. -
projectActualsCost(optional):
object ApiEntityProjectActualsCost
-
projectCompanyId(optional):
integer(int64)
The name of the company associated with the actual.
-
projectId:
integer(int64)
The unique identifier for the project.
-
sourceId(optional):
string
The unique identifier of project actual data in an external source.Example:
coarse
-
status(optional):
string
Read Only:
true
Allowed Values:[ "PENDING", "CONFIRMED" ]
That status of the actual. Valid values are Pending and Confirmed. -
totalHours(optional):
object Hour
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
withdrawByUserId(optional):
integer(int64)
Read Only:
true
The username of the user who withdrew confirmation of the project actual. -
withdrawDate(optional):
string(date-time)
Read Only:
true
The date that confirmation of the project actual was withdrawn.
Nested Schema : Cost
Type:
object
Response
Supported Media Types
- application/json
207 Response
The object was sucessfully integrated.
Nested Schema : ApiEntityERPSyncApiResponse
Type:
Show Source
object
-
link(optional):
string(url)
Read Only:
true
-
message(optional):
string
-
primaryKey(optional):
integer(int64)
-
primaryKeyName(optional):
string
-
primaryKeyValue(optional):
integer(int64)
-
sourceId(optional):
string
-
statusCode(optional):
integer(int32)
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
400 Response
Invalid Input.