Create fund attributes
post
/fscmRestApi/resources/11.13.18.05/fedFundAttributes
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
Root Schema : schema
Type:
Show Source
object
-
ApportionmentCategory(required): string
Title:
Apportionment Category Code
Apportionment category of the fund attribute. -
AuthorityDuration: string
Title:
Authority Duration
Maximum Length:1
Authority duration code of the treasury account symbol. -
BorrowingSource: string
Title:
Borrowing Source Code
Borrowing source of the fund attribute. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category Code
Default Value:Discretionary
Budget enforcement code of the fund attribute. -
BudgetSubfunction: string
Title:
Budget Subfunction Code
Budget subfunction code of the fund attribute. -
CopyFund: string
Title:
Copy fund attributes to next year
Indicates whether the fund information of the fund attribute will be copied to the next year. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial Code
Default Value:Non-Custodial
Custodial or noncustodial code of the fund attribute. -
DefaultCollectionBetcCode: string
Title:
Default Collection BETC
Maximum Length:8
Default collection BETC code of the fund attribute. -
DefaultPaymentBetcCode: string
Title:
Default Payment BETC
Maximum Length:8
Default payment BETC code of the fund attribute. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite Authority
Default Value:Definite
Definite or indefinite authority of the fund attribute. -
DirectOrReimbursable(required): string
Title:
Direct or Reimbursable Code
Direct or reimbursable code of the fund attribute. -
FedAccountSymbolTitle: string
Title:
Federal Account Symbol
Federal account symbol title of the fund attribute. -
fedFundAttributeDFF: array
fedFundAttributeDFF
-
FundCode(required): string
Title:
Fund
Maximum Length:25
Fund code of the fund attribute. -
FundingDerivationType: string
Title:
Funding Derivation Type
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
FundStructureInstanceId: integer
(int64)
Title:
Fund Structure Instance ID
Fund structure instance identifier of the fund attribute. -
FundValueId: integer
(int64)
Title:
Fund Value ID
Unique identifier for the fund attribute. -
Ledger(required): string
Title:
Ledger
Ledger of the fund attribute. -
LedgerId(required): integer
(int64)
Title:
Ledger
The unique identifier of the federal ledger. -
NextYearFund: string
Title:
Next Year Fund
Maximum Length:25
Next year fund value of the fund attribute. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category Code
Default Value:Discretionary
Outlays BEA category of the fund attribute. -
RequisitionClosingMethod: string
Title:
Requisition Closing Method
Requisition closing method of the fund attribute. -
TreasuryAccountSymbol(required): string
Title:
Treasury Account Symbol
Treasury account symbol of the fund attribute. -
TreasuryAccountSymbolId(required): integer
(int64)
Title:
Treasury Account Symbol ID
Unique identifier of the treasury account symbol. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority Indicator
Maximum Length:255
Identifies the year of budget authority indicator associated with the account.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FundValueId: integer
(int64)
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.
Root Schema : fedFundAttributes-item-response
Type:
Show Source
object
-
ApportionmentCategory: string
Title:
Apportionment Category Code
Apportionment category of the fund attribute. -
AuthorityDuration: string
Title:
Authority Duration
Maximum Length:1
Authority duration code of the treasury account symbol. -
BorrowingSource: string
Title:
Borrowing Source Code
Borrowing source of the fund attribute. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category Code
Default Value:Discretionary
Budget enforcement code of the fund attribute. -
BudgetSubfunction: string
Title:
Budget Subfunction Code
Budget subfunction code of the fund attribute. -
CopyFund: string
Title:
Copy fund attributes to next year
Indicates whether the fund information of the fund attribute will be copied to the next year. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial Code
Default Value:Non-Custodial
Custodial or noncustodial code of the fund attribute. -
DefaultCollectionBetcCode: string
Title:
Default Collection BETC
Maximum Length:8
Default collection BETC code of the fund attribute. -
DefaultCollectionBetcName: string
Title:
Default Collection BETC Name
Read Only:true
Default collection BETC name of the fund attribute. -
DefaultPaymentBetcCode: string
Title:
Default Payment BETC
Maximum Length:8
Default payment BETC code of the fund attribute. -
DefaultPaymentBetcName: string
Title:
Default Payment BETC Name
Read Only:true
Default payment BETC name of the fund attribute. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite Authority
Default Value:Definite
Definite or indefinite authority of the fund attribute. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable Code
Direct or reimbursable code of the fund attribute. -
FedAccountSymbolTitle: string
Title:
Federal Account Symbol
Federal account symbol title of the fund attribute. -
fedFundAttributeDFF: array
fedFundAttributeDFF
-
FundCode: string
Title:
Fund
Maximum Length:25
Fund code of the fund attribute. -
FundingDerivationType: string
Title:
Funding Derivation Type
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
FundStructureInstanceId: integer
(int64)
Title:
Fund Structure Instance ID
Fund structure instance identifier of the fund attribute. -
FundValueId: integer
(int64)
Title:
Fund Value ID
Unique identifier for the fund attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
Ledger: string
Title:
Ledger
Ledger of the fund attribute. -
LedgerId: integer
(int64)
Title:
Ledger
The unique identifier of the federal ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextYearFund: string
Title:
Next Year Fund
Maximum Length:25
Next year fund value of the fund attribute. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category Code
Default Value:Discretionary
Outlays BEA category of the fund attribute. -
RequisitionClosingMethod: string
Title:
Requisition Closing Method
Requisition closing method of the fund attribute. -
TreasuryAccountSymbol: string
Title:
Treasury Account Symbol
Treasury account symbol of the fund attribute. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol ID
Unique identifier of the treasury account symbol. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority Indicator
Maximum Length:255
Identifies the year of budget authority indicator associated with the account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedFundAttributes-fedFundAttributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FundValueId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- fedFundAttributeDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFFParameters:
- FundValueId:
$request.path.FundValueId
- FundValueId:
Examples
The following example shows how to create a fund attribute by submitting a POST 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/fedFundAttributes
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "FundCode": "H075160118DB", "Ledger": "USFed1 US", "TreasuryAccountSymbol": "06918/210718", "ApportionmentCategory": "Quarterly Apportionment", "DirectOrReimbursable": "Direct", "BudgetEnforcementAct": "Discretionary", "OutlaysBeaCategory": "Discretionary", "CustodialOrNonCustodial": "Non-Custodial", "DefiniteOrIndefiniteAuthority": "Definite", "BorrowingSource": null, "BudgetSubfunction": null, "CopyFund": "No", "NextYearFund": null, "RequisitionClosingMethod": "Closing" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "FundValueId": 300100211882265, "Ledger": "USFed1 US", "LedgerId": 300100125495724, "FundStructureInstanceId": 17520, "TreasuryAccountSymbol": "06918/210718", "AuthorityDuration": "M", "TreasuryAccountSymbolId": 300100211711868, "FundCode": "H075160118DB", "FedAccountSymbolTitle": "Capital Assistance for Passenger Service", "ApportionmentCategory": "Quarterly Apportionment", "DirectOrReimbursable": "Direct", "BudgetEnforcementAct": "Discretionary", "OutlaysBeaCategory": "Discretionary", "CustodialOrNonCustodial": "Non-Custodial", "DefiniteOrIndefiniteAuthority": "Definite", "BorrowingSource": null, "BudgetSubfunction": null, "CopyFund": "No", "NextYearFund": null, "RequisitionClosingMethod": "Closing", "CreatedBy": "FEDERAL", "CreationDate": "2020-12-10T12:11:36.002+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateDate": "2020-12-10T12:11:37.363+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265", "name": "fedFundAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265", "name": "fedFundAttributes", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265/child/fedFundAttributeDFF", "name": "fedFundAttributeDFF", "kind": "collection" } ] }