Integrate a Budget Item with an External Data Source

post

/primeapi/restapi/budgetItem/sync

Send a request to this endpoint to create or update an integrated a budget item. 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
Body ()
The unique identifier of budget item data in an external source.
Root Schema : ApiEntityExternallySourcedBudgetItem
Type: object
Show Source
  • The type of cost associated with the budget item.
  • The object has a code that matches the value of the {code} path parameter.
  • the cost category assigned to this budget item.
  • The name of the CBS Code.
  • The unique identifier of the project budget item.
  • The name of the budget item.
  • The suffix of a budget item code.
  • Hour
  • The system-generated identifier of a project budget.
  • The object has a code that matches the value of the {code} path parameter.
  • the project associated with this budget item.
  • The number of each budget item needed to complete the work.
  • The unique identifier of budget item data in an external source.
    Example: coarse
  • The Unit of Measure used for the budget item.
  • 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.
  • The user-specified identifier of a workspace.
  • Nested Schema : Hour
    Type: object
    Show Source
    Nested Schema : ApiEntityBudgetItemConfiguredFields
    Type: object
    Show Source
    Nested Schema : ApiEntityBudgetItemCost
    Type: object
    Show Source
    Nested Schema : costFlexMap
    Type: object
    Additional Properties Allowed
    Show Source
    An object containing cost fields in the form of key-value pairs.
    Nested Schema : otherFlexMap
    Type: object
    Additional Properties Allowed
    Show Source
    An object containing non-cost, non-text fields in the form of key-value pairs.
    Nested Schema : textFlexMap
    Type: object
    Additional Properties Allowed
    Show Source
    An object containing text fields in the form of key-value pairs.
    Nested Schema : additionalProperties
    Type: object
    Nested Schema : additionalProperties
    Type: object
    Nested Schema : additionalProperties
    Type: object
    Nested Schema : Cost
    Type: object

    Response

    Supported Media Types

    200 Response

    Successful Update Operation.
    Body ()
    Root Schema : ApiEntityERPSyncApiResponse
    Type: object
    Show Source

    201 Response

    Successful Create Operation.
    Body ()
    Root Schema : ApiEntityERPSyncApiResponse
    Type: object
    Show Source

    400 Response

    Invalid Input.