Jump to

• Request
• Response
• Examples

Create a federal level control budget

post

/fscmRestApi/resources/11.13.18.05/fedLevelControlBudgets

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• BudgetLevel: string
  Title: Budget Level Name

  Budget level of the control budget.
• ControlBudget: string
  Title: Control Budget

  The name of the control budget.
• Enabled: string
  Title: Enabled

  Default Value: Yes

  Indicates whether the control budget is available for use with the specified budget level.
• LedgerName: string
  Title: Ledger Name

  The name of the ledger associated with the control budget.
• LevelControlBudgetId: integer (int64)
  Title: Control Budget ID

  The unique identifier for the budget level associated with the control budget.
• ParentControlBudget: string
  Title: Parent Control Budget

  The name of the parent control budget.

{
    "type":"object",
    "properties":{
        "BudgetLevel":{
            "title":"Budget Level Name",
            "type":"string",
            "description":"Budget level of the control budget.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ControlBudget":{
            "title":"Control Budget",
            "type":"string",
            "description":"The name of the control budget.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "CBName",
                    "ControlBudgetId1",
                    "SourceBudget1",
                    "SourceBudgetSystemCode",
                    "StatusCode"
                ]
            }
        },
        "Enabled":{
            "title":"Enabled",
            "type":"string",
            "description":"Indicates whether the control budget is available for use with the specified budget level.",
            "nullable":true,
            "default":"Yes",
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            }
        },
        "LedgerName":{
            "title":"Ledger Name",
            "type":"string",
            "description":"The name of the ledger associated with the control budget.",
            "nullable":false
        },
        "LevelControlBudgetId":{
            "title":"Control Budget ID",
            "type":"integer",
            "description":"The unique identifier for the budget level associated with the control budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ParentControlBudget":{
            "title":"Parent Control Budget",
            "type":"string",
            "description":"The name of the parent control budget.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "ParentCBName",
                    "ControlBudgetId2"
                ]
            }
        }
    }
}

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 : fedLevelControlBudgets-item-response

Type: object

Show Source

• BudgetLevel: string
  Title: Budget Level Name

  Budget level of the control budget.
• ControlBudget: string
  Title: Control Budget

  The name of the control budget.
• ControlBudgetStatus: string
  Title: Control Budget Status

  Read Only: true

  The current state of a control budget that controls whether it can be used to enforce budgetary control and validate transactions.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time of the creation of the row.
• Enabled: string
  Title: Enabled

  Default Value: Yes

  Indicates whether the control budget is available for use with the specified budget level.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time of the last update of the row.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the row.
• LedgerName: string
  Title: Ledger Name

  The name of the ledger associated with the control budget.
• LevelControlBudgetId: integer (int64)
  Title: Control Budget ID

  The unique identifier for the budget level associated with the control budget.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentControlBudget: string
  Title: Parent Control Budget

  The name of the parent control budget.
• SourceBudget: string
  Title: Source Budget

  Read Only: true

  The originating budget version or data set that provides the authorized funding amounts used for budgetary control and funds checking.
• SourceBudgetType: string
  Title: Source Budget Type

  Read Only: true

  The classification that identifies the kind of budget data being used as the funding source for a control budget.

{
    "type":"object",
    "properties":{
        "BudgetLevel":{
            "title":"Budget Level Name",
            "type":"string",
            "description":"Budget level of the control budget.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ControlBudget":{
            "title":"Control Budget",
            "type":"string",
            "description":"The name of the control budget.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "CBName",
                    "ControlBudgetId1",
                    "SourceBudget1",
                    "SourceBudgetSystemCode",
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "ControlBudgetStatus":{
            "title":"Control Budget Status",
            "type":"string",
            "description":"The current state of a control budget that controls whether it can be used to enforce budgetary control and validate transactions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "type":"string",
            "description":"Indicates whether the control budget is available for use with the specified budget level.",
            "nullable":true,
            "default":"Yes",
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LedgerName":{
            "title":"Ledger Name",
            "type":"string",
            "description":"The name of the ledger associated with the control budget.",
            "nullable":false,
            "x-queryable":true
        },
        "LevelControlBudgetId":{
            "title":"Control Budget ID",
            "type":"integer",
            "description":"The unique identifier for the budget level associated with the control budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ParentControlBudget":{
            "title":"Parent Control Budget",
            "type":"string",
            "description":"The name of the parent control budget.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "ParentCBName",
                    "ControlBudgetId2"
                ]
            },
            "x-queryable":true
        },
        "SourceBudget":{
            "title":"Source Budget",
            "type":"string",
            "description":"The originating budget version or data set that provides the authorized funding amounts used for budgetary control and funds checking.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "SourceBudgetType":{
            "title":"Source Budget Type",
            "type":"string",
            "description":"The classification that identifies the kind of budget data being used as the funding source for a control budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "SourceBudgetSystemCode"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 a a federal level control budget by submitting a POST request on the REST resource using cURL.

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

Request Body Example

The following shows an example of the request body in JSON format.

{
	"LedgerName": "USFed1 US",
	"ControlBudget": "XCC CB 2",
	"ParentControlBudget": "XCC CB 1",
	"BudgetLevel": "Allowance",
	"Enabled": "Yes"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "LevelControlBudgetId": "300100660796605",
    "LedgerName": "USFed1 US",
    "ControlBudget": "XCC CB 2",
    "ParentControlBudget": "XCC CB 1",
    "BudgetLevel": "Allowance",
    "SourceBudgetType": "EPM Financials module",
    "SourceBudget": "XCC CB 2",
    "ControlBudgetStatus": "In use",
    "Enabled": "Yes",
    "LastUpdateDate": "2026-08-28T15:55:54.411+00:00",
    "CreatedBy": "username",
    "CreationDate": "2026-08-28T15:55:54.002+00:00",
    "LastUpdatedBy": "username",
    "LastUpdateLogin": "58FF0FB27FF91EEFE063A125060A6D79",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLevelControlBudgets/300100660796605",
            "name": "300100660796605",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        {
                "rel": "canonical",
                "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLevelControlBudgets/300100660796605",
                "name": "fedLevelControlBudgets",
                "kind": "item"
        }	
    ]
}

Back to Top