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 CodeApportionment category of the fund attribute. -
AuthorityDuration: string
Title:
Authority DurationMaximum Length:1Authority duration code of the treasury account symbol. -
BorrowingSource: string
Title:
Borrowing Source CodeBorrowing source of the fund attribute. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category CodeDefault Value:DiscretionaryBudget enforcement code of the fund attribute. -
BudgetSubfunction: string
Title:
Budget Subfunction CodeBudget subfunction code of the fund attribute. -
CopyFund: string
Title:
Copy fund attributes to next yearIndicates whether the fund information of the fund attribute will be copied to the next year. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial CodeDefault Value:Non-CustodialCustodial or noncustodial code of the fund attribute. -
DefaultCollectionBetcCode: string
Title:
Default Collection BETCMaximum Length:8Default collection BETC code of the fund attribute. -
DefaultPaymentBetcCode: string
Title:
Default Payment BETCMaximum Length:8Default payment BETC code of the fund attribute. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite AuthorityDefault Value:DefiniteDefinite or indefinite authority of the fund attribute. -
DirectOrReimbursable(required): string
Title:
Direct or Reimbursable CodeDirect or reimbursable code of the fund attribute. -
FedAccountSymbolTitle: string
Title:
Federal Account SymbolFederal account symbol title of the fund attribute. -
fedFundAttributeDFF: array
fedFundAttributeDFF
-
FundCode(required): string
Title:
FundMaximum Length:25Fund code of the fund attribute. -
FundingDerivationType: string
Title:
Funding Derivation TypeType 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 IDFund structure instance identifier of the fund attribute. -
FundValueId: integer
(int64)
Title:
Fund Value IDUnique identifier for the fund attribute. -
Ledger(required): string
Title:
LedgerLedger of the fund attribute. -
LedgerId(required): integer
(int64)
Title:
LedgerThe unique identifier of the federal ledger. -
NextYearFund: string
Title:
Next Year FundMaximum Length:25Next year fund value of the fund attribute. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category CodeDefault Value:DiscretionaryOutlays BEA category of the fund attribute. -
RequisitionClosingMethod: string
Title:
Requisition Closing MethodRequisition closing method of the fund attribute. -
TreasuryAccountSymbol(required): string
Title:
Treasury Account SymbolTreasury account symbol of the fund attribute. -
TreasuryAccountSymbolId(required): integer
(int64)
Title:
Treasury Account Symbol IDUnique identifier of the treasury account symbol. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority IndicatorMaximum Length:255Identifies the year of budget authority indicator associated with the account.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum 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 CodeApportionment category of the fund attribute. -
AuthorityDuration: string
Title:
Authority DurationMaximum Length:1Authority duration code of the treasury account symbol. -
BorrowingSource: string
Title:
Borrowing Source CodeBorrowing source of the fund attribute. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category CodeDefault Value:DiscretionaryBudget enforcement code of the fund attribute. -
BudgetSubfunction: string
Title:
Budget Subfunction CodeBudget subfunction code of the fund attribute. -
CopyFund: string
Title:
Copy fund attributes to next yearIndicates whether the fund information of the fund attribute will be copied to the next year. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the record was created. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial CodeDefault Value:Non-CustodialCustodial or noncustodial code of the fund attribute. -
DefaultCollectionBetcCode: string
Title:
Default Collection BETCMaximum Length:8Default collection BETC code of the fund attribute. -
DefaultCollectionBetcName: string
Title:
Default Collection BETC NameRead Only:trueDefault collection BETC name of the fund attribute. -
DefaultPaymentBetcCode: string
Title:
Default Payment BETCMaximum Length:8Default payment BETC code of the fund attribute. -
DefaultPaymentBetcName: string
Title:
Default Payment BETC NameRead Only:trueDefault payment BETC name of the fund attribute. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite AuthorityDefault Value:DefiniteDefinite or indefinite authority of the fund attribute. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable CodeDirect or reimbursable code of the fund attribute. -
FedAccountSymbolTitle: string
Title:
Federal Account SymbolFederal account symbol title of the fund attribute. -
fedFundAttributeDFF: array
fedFundAttributeDFF
-
FundCode: string
Title:
FundMaximum Length:25Fund code of the fund attribute. -
FundingDerivationType: string
Title:
Funding Derivation TypeType 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 IDFund structure instance identifier of the fund attribute. -
FundValueId: integer
(int64)
Title:
Fund Value IDUnique identifier for the fund attribute. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
Ledger: string
Title:
LedgerLedger of the fund attribute. -
LedgerId: integer
(int64)
Title:
LedgerThe unique identifier of the federal ledger. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NextYearFund: string
Title:
Next Year FundMaximum Length:25Next year fund value of the fund attribute. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category CodeDefault Value:DiscretionaryOutlays BEA category of the fund attribute. -
RequisitionClosingMethod: string
Title:
Requisition Closing MethodRequisition closing method of the fund attribute. -
TreasuryAccountSymbol: string
Title:
Treasury Account SymbolTreasury account symbol of the fund attribute. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol IDUnique identifier of the treasury account symbol. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority IndicatorMaximum Length:255Identifies the year of budget authority indicator associated with the account.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : fedFundAttributes-fedFundAttributeDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
FundValueId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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"
}
]
}