Create a Budget Change

post

/primeapi/restapi/budgetChange

Send a request to this endpoint to create a budget change. An application object will be created using the JSON data provided in the request body.

Request

Supported Media Types
Body ()
A budget change object.
Root Schema : ApiEntityBudgetChange
Type: object
Show Source
Nested Schema : TimezoneSensitiveDateTime
Type: object
Show Source
Nested Schema : ApiEntityBudgetChangeConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityBudgetChangeCost
Type: object
Show Source
Nested Schema : budgetTransactions
Type: array
List of all budget transactions for the budget change.
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
Nested Schema : ApiEntityBudgetChangeTransaction
Type: object
Show Source
Nested Schema : Hour
Type: object
Show Source
Nested Schema : ApiEntityBudgetTransactionConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityBudgetTransactionCost
Type: object
Show Source
Nested Schema : costFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured cost fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : otherFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured other fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : textFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured text fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object

Response

Supported Media Types

201 Response

The object was successfully created.
Body ()
Root Schema : ApiEntityBudgetChange
Type: object
Show Source
Nested Schema : TimezoneSensitiveDateTime
Type: object
Show Source
Nested Schema : ApiEntityBudgetChangeConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityBudgetChangeCost
Type: object
Show Source
Nested Schema : budgetTransactions
Type: array
List of all budget transactions for the budget change.
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
Nested Schema : ApiEntityBudgetChangeTransaction
Type: object
Show Source
Nested Schema : Hour
Type: object
Show Source
Nested Schema : ApiEntityBudgetTransactionConfiguredFields
Type: object
Show Source
Nested Schema : ApiEntityBudgetTransactionCost
Type: object
Show Source
Nested Schema : costFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured cost fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : otherFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured other fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : textFlexMap
Type: object
Additional Properties Allowed
Show Source
A list of all configured text fields and values assigned to the budget change in the form of key-value pairs.
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object

400 Response

Invalid input for the Budget Change service. Verify the request contains valid data, then resubmit the request.