Jump to

• Request
• Response
• Examples

Create and perform budgetary control validation on a budget entry transaction

post

/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApprovalComments: string
  Maximum Length: 2000

  Approval comments from the approver for the budget entry transaction.
• ApprovedBy: string
  Maximum Length: 64

  Person who approved the budget entry transaction.
• ApprovedDate: string (date-time)
  Date and time when the budget entry transaction was approved.
• AttachmentURL: string
  Maximum Length: 4000

  Supporting document attached at the budget entry transaction header level.
• AttributeCategory: string
  Maximum Length: 15

  Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield.
• AttributeChar1: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar10: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar2: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar3: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar4: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar5: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar6: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar7: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar8: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar9: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• BatchFatalErrorMessage: string
  Maximum Length: 2000

  The message of an unexpected error.
• BatchFundsAction: string
  Maximum Length: 30

  Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.
• BatchResultCode: string
  Maximum Length: 30

  The budgetary control status code for the batch, such as success or failed.
• BudgetAmountsMode: string
  Maximum Length: 30

  Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances.
• BudgetTransactionPayload: string (byte)
  Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.
• BudgetTransactionType: string
  Maximum Length: 30

  Indicates whether the budget entry transaction is an initial budget or a budget adjustment.
• JustificationText: string
  Maximum Length: 1000

  Justification provided at the budget entry transaction header level by the budget preparer for the budget approver.
• ProcessId: integer (int64)
  The budgetary control process identifier.
• RevisionDescription: string
  Maximum Length: 255

  Description for the budget entry transaction.
• SourceBudget: string
  Maximum Length: 100

  Source control budget name of the budget entry transaction line.
• TransactionNumber: string
  Maximum Length: 500

  Budget entry transaction number from Enterprise Performance Management.

{
    "type":"object",
    "properties":{
        "TransactionNumber":{
            "maxLength":"500",
            "type":"string",
            "description":"Budget entry transaction number from Enterprise Performance Management.",
            "nullable":false
        },
        "AttributeCategory":{
            "maxLength":"15",
            "type":"string",
            "description":"Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar8":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar9":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "ApprovalComments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Approval comments from the approver for the budget entry transaction.",
            "nullable":true
        },
        "AttributeChar6":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar7":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar4":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "BudgetTransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the budget entry transaction is an initial budget or a budget adjustment.",
            "nullable":false
        },
        "AttributeChar5":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "JustificationText":{
            "maxLength":"1000",
            "type":"string",
            "description":"Justification provided at the budget entry transaction header level by the budget preparer for the budget approver.",
            "nullable":true
        },
        "AttributeChar2":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar3":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "RevisionDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description for the budget entry transaction.",
            "nullable":true
        },
        "SourceBudget":{
            "maxLength":"100",
            "type":"string",
            "description":"Source control budget name of the budget entry transaction line.",
            "nullable":false
        },
        "AttachmentURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"Supporting document attached at the budget entry transaction header level.",
            "nullable":true
        },
        "BudgetAmountsMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances.",
            "nullable":false
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date and time when the budget entry transaction was approved.",
            "format":"date-time",
            "nullable":true
        },
        "BudgetTransactionPayload":{
            "type":"string",
            "description":"Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "BatchFundsAction":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.",
            "nullable":false
        },
        "AttributeChar10":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "BatchFatalErrorMessage":{
            "maxLength":"2000",
            "type":"string",
            "description":"The message of an unexpected error.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "BatchResultCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The budgetary control status code for the batch, such as success or failed.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AttributeChar1":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "ApprovedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who approved the budget entry transaction.",
            "nullable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"The budgetary control process identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : budgetaryControlBudgetTransactions-item-response

Type: object

Show Source

• ApprovalComments: string
  Maximum Length: 2000

  Approval comments from the approver for the budget entry transaction.
• ApprovedBy: string
  Maximum Length: 64

  Person who approved the budget entry transaction.
• ApprovedDate: string (date-time)
  Date and time when the budget entry transaction was approved.
• AttachmentURL: string
  Maximum Length: 4000

  Supporting document attached at the budget entry transaction header level.
• AttributeCategory: string
  Maximum Length: 15

  Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield.
• AttributeChar1: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar10: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar2: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar3: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar4: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar5: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar6: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar7: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar8: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• AttributeChar9: string
  Maximum Length: 255

  Segment for the Budget Line Descriptions descriptive flexfield.
• BatchFatalErrorMessage: string
  Maximum Length: 2000

  The message of an unexpected error.
• BatchFundsAction: string
  Maximum Length: 30

  Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.
• BatchResultCode: string
  Maximum Length: 30

  The budgetary control status code for the batch, such as success or failed.
• BudgetAmountsMode: string
  Maximum Length: 30

  Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances.
• BudgetTransactionPayload: string (byte)
  Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.
• BudgetTransactionType: string
  Maximum Length: 30

  Indicates whether the budget entry transaction is an initial budget or a budget adjustment.
• JustificationText: string
  Maximum Length: 1000

  Justification provided at the budget entry transaction header level by the budget preparer for the budget approver.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessId: integer (int64)
  The budgetary control process identifier.
• RevisionDescription: string
  Maximum Length: 255

  Description for the budget entry transaction.
• SourceBudget: string
  Maximum Length: 100

  Source control budget name of the budget entry transaction line.
• TransactionNumber: string
  Maximum Length: 500

  Budget entry transaction number from Enterprise Performance Management.

{
    "type":"object",
    "properties":{
        "TransactionNumber":{
            "maxLength":"500",
            "type":"string",
            "description":"Budget entry transaction number from Enterprise Performance Management.",
            "nullable":false
        },
        "AttributeCategory":{
            "maxLength":"15",
            "type":"string",
            "description":"Descriptive flexfield context name for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar8":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar9":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "ApprovalComments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Approval comments from the approver for the budget entry transaction.",
            "nullable":true
        },
        "AttributeChar6":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar7":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar4":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "BudgetTransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the budget entry transaction is an initial budget or a budget adjustment.",
            "nullable":false
        },
        "AttributeChar5":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "JustificationText":{
            "maxLength":"1000",
            "type":"string",
            "description":"Justification provided at the budget entry transaction header level by the budget preparer for the budget approver.",
            "nullable":true
        },
        "AttributeChar2":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "AttributeChar3":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "RevisionDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description for the budget entry transaction.",
            "nullable":true
        },
        "SourceBudget":{
            "maxLength":"100",
            "type":"string",
            "description":"Source control budget name of the budget entry transaction line.",
            "nullable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachmentURL":{
            "maxLength":"4000",
            "type":"string",
            "description":"Supporting document attached at the budget entry transaction header level.",
            "nullable":true
        },
        "BudgetAmountsMode":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the amounts from the budget entry transactions should overwrite or be added to the existing budget balances.",
            "nullable":false
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date and time when the budget entry transaction was approved.",
            "format":"date-time",
            "nullable":true
        },
        "BudgetTransactionPayload":{
            "type":"string",
            "description":"Main content of a budget entry transaction line, such as its budget account, budget period, and budget amount, encoded in JSON format.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "BatchFundsAction":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.",
            "nullable":false
        },
        "AttributeChar10":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "BatchFatalErrorMessage":{
            "maxLength":"2000",
            "type":"string",
            "description":"The message of an unexpected error.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "BatchResultCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The budgetary control status code for the batch, such as success or failed.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AttributeChar1":{
            "maxLength":"255",
            "type":"string",
            "description":"Segment for the Budget Line Descriptions descriptive flexfield.",
            "nullable":true
        },
        "ApprovedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Person who approved the budget entry transaction.",
            "nullable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"The budgetary control process identifier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to create and perform budgetary control validation on a budget entry transaction by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "SourceBudget":"EPM1",
    "TransactionNumber":"Transaction01",
    "BudgetTransactionType":"INITIALIZE_BUDGET",
    "BatchFundsAction":"RESERVE",
    "ApprovalComments":"Sample",
    "ApprovedDate":"2020-03-18",
    "ApprovedBy":"Approver",
    "RevisionDescription":"Sample Description",
    "AttachmentURL":"Demo Url",
    "JustificationText":"Demo Transaction",
    "AttributeCategory":"Attr cat",
    "BudgetAmountsMode":"INCREMENT",
"BudgetTransactionPayload":"eyJMaW5lcyI6IFt7IkxpbmVOdW1iZXIiOiIxIiwiQW1vdW50IjoiMTAwMCIsIkN1cnJlbmN5Q29kZSI6IlVTRCIsIlBlcmlvZE5hbWUiOiJKYW4tMDYiLCJTZWdtZW50MSI6IjAwMTQiLCJTZWdtZW50MiI6IjEyMTAiLCJTZWdtZW50MyI6IjgxMjEiLCJTZWdtZW50NCI6IjAxMDAiLCJTZWdtZW50NSI6IjAwMDAwMCIsIlNlZ21lbnQ2IjoiMTEwMCJ9LHsiTGluZU51bWJlciI6IjIiLCJBbW91bnQiOiIxMDAwIiwiQ3VycmVuY3lDb2RlIjoiVVNEIiwiUGVyaW9kTmFtZSI6IkZlYi0wNiIsIlNlZ21lbnQxIjoiMDAxNCIsIlNlZ21lbnQyIjoiMTIxMCIsIlNlZ21lbnQzIjoiODEyMSIsIlNlZ21lbnQ0IjoiMDEwMCIsIlNlZ21lbnQ1IjoiMDAwMDAwIiwiU2VnbWVudDYiOiIxMTAwIn1dfQ=="
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "SourceBudget": "EPM1",
    "TransactionNumber": "Transaction01",
    "BudgetTransactionType": "INITIALIZE_BUDGET",
    "BudgetAmountsMode": "INCREMENT",
    "BatchFundsAction": "RESERVE",
    "AttributeCategory": "Attr cat",
    "AttributeChar1": null,
    "AttributeChar2": null,
    "AttributeChar3": null,
    "AttributeChar4": null,
    "AttributeChar5": null,
    "AttributeChar6": null,
    "AttributeChar7": null,
    "AttributeChar8": null,
    "AttributeChar9": null,
    "AttributeChar10": null,
    "ApprovalComments": "Sample",
    "ApprovedDate": "2020-03-18T00:00:00+00:00",
    "ApprovedBy": "Approver",
    "RevisionDescription": "Sample Description",
    "AttachmentURL": "Demo Url",
    "JustificationText": "Demo Transaction",
    "BatchFatalErrorMessage": null,
    "ProcessId": 100101241358338,
    "BatchResultCode": "SUCCESS",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/300100565517202",
            "name": "budgetaryControlBudgetTransactions",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/300100565517202",
            "name": "budgetaryControlBudgetTransactions",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/300100565517202/enclosure/BudgetTransactionPayload",
            "name": "BudgetTransactionPayload",
            "kind": "other"
        }
    ]
}

Back to Top