Jump to

• Request
• Response
• Examples

Create a ledger option

post

/fscmRestApi/resources/11.13.18.05/fedLedgerOptions

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

• ChartOfAccountsId: integer (int64)
  Title: Structure Instance Number

  The unique identifier of the chart of accounts associated with the ledger option.
• DocumentNumberEntry: string
  Title: Document Number Entry

  Document number entry of the ledger option.
• DocumentNumberType: string
  Title: Document Number Type

  Document number type of the ledger option.
• FederalGroup: string
  Title: Federal Group Name

  Name of the federal group associated with the ledger option.
• fedLedgerOptionBudgetLevels: array Federal Ledger Option Budget Levels
  Title: Federal Ledger Option Budget Levels

  The ledger option budget levels resource is used to query, create, and update ledger option budget levels.
• fedLedgerOptionDFF: array fedLedgerOptionDFF
• LedgerName: string
  Title: Name

  Ledger name for the ledger option.
• LevelOptionId: integer (int64)
  Title: Level Option ID

  The unique identifier of the level option associated with the ledger option.
• USSGLTree: string
  Title: USSGL Tree

  USSGL tree of the ledger option.

{
    "type":"object",
    "properties":{
        "DocumentNumberEntry":{
            "title":"Document Number Entry",
            "type":"string",
            "description":"Document number entry of the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1"
                ]
            }
        },
        "USSGLTree":{
            "title":"USSGL Tree",
            "type":"string",
            "description":"USSGL tree of the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "AccountValueSetId",
                    "TreeName",
                    "UssglTreeCode"
                ]
            }
        },
        "LevelOptionId":{
            "title":"Level Option ID",
            "type":"integer",
            "description":"The unique identifier of the level option associated with the ledger option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "dependencies":[
                    "LedgerGroupId"
                ]
            }
        },
        "fedLedgerOptionBudgetLevels":{
            "title":"Federal Ledger Option Budget Levels",
            "type":"array",
            "description":"The ledger option budget levels resource is used to query, create, and update ledger option budget levels.",
            "items":{
                "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionBudgetLevels-item-post-request"
            }
        },
        "ChartOfAccountsId":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The unique identifier of the chart of accounts associated with the ledger option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_StructureID":"DefaultAccountCombinations",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.generalLedger.accounts.codeCombinations.model.view.FndStructuresVO",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "PAYLOADHINT":"Show",
                "fnd:FND_AUDIT_FK_WHEREATTR":"StructureInstanceNumber",
                "dependencies":[
                    "ChartOfAccountsId1"
                ]
            }
        },
        "fedLedgerOptionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "FederalGroup":{
            "title":"Federal Group Name",
            "type":"string",
            "description":"Name of the federal group associated with the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "ChartOfAccountsId",
                    "GroupName1",
                    "LedgerId",
                    "LedgerName"
                ]
            }
        },
        "LedgerName":{
            "title":"Name",
            "type":"string",
            "description":"Ledger name for the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LedgerId",
                    "Name"
                ]
            }
        },
        "DocumentNumberType":{
            "title":"Document Number Type",
            "type":"string",
            "description":"Document number type of the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LookupCode",
                    "Meaning"
                ]
            }
        }
    }
}

Nested Schema : Federal Ledger Option Budget Levels

Type: array

Title: Federal Ledger Option Budget Levels

The ledger option budget levels resource is used to query, create, and update ledger option budget levels.

Show Source

• Array of: object fedLedgerOptions-fedLedgerOptionBudgetLevels-item-post-request

{
    "title":"Federal Ledger Option Budget Levels",
    "type":"array",
    "description":"The ledger option budget levels resource is used to query, create, and update ledger option budget levels.",
    "items":{
        "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionBudgetLevels-item-post-request"
    }
}

Nested Schema : fedLedgerOptionDFF

Type: array

Show Source

• Array of: object fedLedgerOptions-fedLedgerOptionDFF-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : fedLedgerOptions-fedLedgerOptionBudgetLevels-item-post-request

Type: object

Show Source

• BudgetLevelAccount: string
  Title: Budget Level Account

  Maximum Length: 60

  Budget level account of the ledger option budget level.
• ControlSpending: string
  Title: Control Spending

  Maximum Length: 255

  Control Spending of the ledger option budget level.
• PriorLevelFunding: string
  Title: Prior Level Funding

  Maximum Length: 255

  Prior level funding of the ledger option budget level.

{
    "type":"object",
    "properties":{
        "ControlSpending":{
            "title":"Control Spending",
            "maxLength":"255",
            "type":"string",
            "description":"Control Spending of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BudgetLevelAccount":{
            "title":"Budget Level Account",
            "maxLength":"60",
            "type":"string",
            "description":"Budget level account of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PriorLevelFunding":{
            "title":"Prior Level Funding",
            "maxLength":"255",
            "type":"string",
            "description":"Prior level funding of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : fedLedgerOptions-fedLedgerOptionDFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• LevelOptionId: integer (int64)

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "LevelOptionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• AccountAttributeStatus: string
  Title: Account Attribute Status

  Read Only: true

  Maximum Length: 255

  Status of the account attribute associated with the ledger option.
• ChartOfAccountsId: integer (int64)
  Title: Structure Instance Number

  The unique identifier of the chart of accounts associated with the ledger option.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• DocumentNumberEntry: string
  Title: Document Number Entry

  Document number entry of the ledger option.
• DocumentNumberType: string
  Title: Document Number Type

  Document number type of the ledger option.
• FederalGroup: string
  Title: Federal Group Name

  Name of the federal group associated with the ledger option.
• fedLedgerOptionBudgetLevels: array Federal Ledger Option Budget Levels
  Title: Federal Ledger Option Budget Levels

  The ledger option budget levels resource is used to query, create, and update ledger option budget levels.
• fedLedgerOptionDFF: array fedLedgerOptionDFF
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  Date when the user last logged in.
• LedgerGroupId: integer (int64)
  Title: Federal Group ID

  Read Only: true

  The unique identifier of the ledger group associated with the ledger option.
• LedgerName: string
  Title: Name

  Ledger name for the ledger option.
• LevelOptionId: integer (int64)
  Title: Level Option ID

  The unique identifier of the level option associated with the ledger option.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• USSGLTree: string
  Title: USSGL Tree

  USSGL tree of the ledger option.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountAttributeStatus":{
            "title":"Account Attribute Status",
            "maxLength":"255",
            "type":"string",
            "description":"Status of the account attribute associated with the ledger option.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumberEntry":{
            "title":"Document Number Entry",
            "type":"string",
            "description":"Document number entry of the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "USSGLTree":{
            "title":"USSGL Tree",
            "type":"string",
            "description":"USSGL tree of the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "AccountValueSetId",
                    "TreeName",
                    "UssglTreeCode"
                ]
            },
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The unique identifier of the chart of accounts associated with the ledger option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_StructureID":"DefaultAccountCombinations",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.financials.generalLedger.accounts.codeCombinations.model.view.FndStructuresVO",
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "PAYLOADHINT":"Show",
                "fnd:FND_AUDIT_FK_WHEREATTR":"StructureInstanceNumber",
                "dependencies":[
                    "ChartOfAccountsId1"
                ]
            },
            "x-queryable":true
        },
        "fedLedgerOptionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LedgerGroupId":{
            "title":"Federal Group ID",
            "type":"integer",
            "description":"The unique identifier of the ledger group associated with the ledger option.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "FederalGroup":{
            "title":"Federal Group Name",
            "type":"string",
            "description":"Name of the federal group associated with the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "ChartOfAccountsId",
                    "GroupName1",
                    "LedgerId",
                    "LedgerName"
                ]
            },
            "x-queryable":true
        },
        "LevelOptionId":{
            "title":"Level Option ID",
            "type":"integer",
            "description":"The unique identifier of the level option associated with the ledger option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "dependencies":[
                    "LedgerGroupId"
                ]
            },
            "x-queryable":true
        },
        "fedLedgerOptionBudgetLevels":{
            "title":"Federal Ledger Option Budget Levels",
            "type":"array",
            "description":"The ledger option budget levels resource is used to query, create, and update ledger option budget levels.",
            "items":{
                "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerName":{
            "title":"Name",
            "type":"string",
            "description":"Ledger name for the ledger option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "LedgerId",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "DocumentNumberType":{
            "title":"Document Number Type",
            "type":"string",
            "description":"Document number type of the ledger option.",
            "nullable":true,
            "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 when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user last logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Federal Ledger Option Budget Levels

Type: array

Title: Federal Ledger Option Budget Levels

The ledger option budget levels resource is used to query, create, and update ledger option budget levels.

Show Source

• Array of: object fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response

{
    "title":"Federal Ledger Option Budget Levels",
    "type":"array",
    "description":"The ledger option budget levels resource is used to query, create, and update ledger option budget levels.",
    "items":{
        "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response"
    }
}

Nested Schema : fedLedgerOptionDFF

Type: array

Show Source

• Array of: object fedLedgerOptions-fedLedgerOptionDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedLedgerOptions-fedLedgerOptionDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response

Type: object

Show Source

• BudgetLevelAccount: string
  Title: Budget Level Account

  Maximum Length: 60

  Budget level account of the ledger option budget level.
• BudgetLevelId: integer (int64)
  Title: Budget Level ID

  Read Only: true

  The unique identifier of theBudget level associated with the ledger option budget level.
• BudgetLevelName: string
  Title: Budget Level

  Read Only: true

  Maximum Length: 30

  Name of the ledger option budget level.
• ControlSpending: string
  Title: Control Spending

  Maximum Length: 255

  Control Spending of the ledger option budget level.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 100

  Description of the ledger option budget level.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  Date when the user last logged in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriorLevelFunding: string
  Title: Prior Level Funding

  Maximum Length: 255

  Prior level funding of the ledger option budget level.
• SequenceNumber: integer (int64)
  Title: Budget Level Sequence

  Read Only: true

  Sequence number of the ledger option budget level.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ControlSpending":{
            "title":"Control Spending",
            "maxLength":"255",
            "type":"string",
            "description":"Control Spending of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"Description of the ledger option budget level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetLevelName":{
            "title":"Budget Level",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the ledger option budget level.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BudgetLevelAccount":{
            "title":"Budget Level Account",
            "maxLength":"60",
            "type":"string",
            "description":"Budget level account of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PriorLevelFunding":{
            "title":"Prior Level Funding",
            "maxLength":"255",
            "type":"string",
            "description":"Prior level funding of the ledger option budget level.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Budget Level Sequence",
            "type":"integer",
            "description":"Sequence number of the ledger option budget level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BudgetLevelId":{
            "title":"Budget Level ID",
            "type":"integer",
            "description":"The unique identifier of theBudget level associated with the ledger option budget level.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Date when the user last logged in.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Nested Schema : fedLedgerOptions-fedLedgerOptionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• LevelOptionId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "LevelOptionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

fedLedgerOptionBudgetLevels

Operation: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionBudgetLevels

Parameters:

• LevelOptionId: $request.path.LevelOptionId

The ledger option budget levels resource is used to query, create, and update ledger option budget levels.

fedLedgerOptionDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF

Parameters:

• LevelOptionId: $request.path.LevelOptionId

Back to Top

Examples

The following example shows how to create a ledger option 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/fedLedgerOptions

Example Request Body

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

{
    "LedgerName": "US Safety US",
    "FederalGroup": "Safety Group",
    "DocumentNumberEntry": "Automatic",
    "DocumentNumberType": "Numeric",
    "DefaultAccountCombination": "00-0-0-0-0-21200001-2019-2019-2019-0-0",
    "USSGLTree": "GL Account US Safety",
    "ClosingSegments": "Y-Y-Y-Y-Y-Y-Y-Y-Y-Y-Y"
}

Example Response Body

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

{
    "LevelOptionId": 300100543443163,
    "LedgerName": "US Safety US",
    "FederalGroup": "Safety Group",
    "LedgerGroupId": 300100543398854,
    "ChartOfAccountsId": 63551,
    "DocumentNumberEntry": "Automatic",
    "DocumentNumberType": "Numeric",
    "DefaultAccountCombination": "00-0-0-0-0-21200001-2019-2019-2019-0-0",
    "USSGLTree": "GL Account US Safety",
    "ClosingSegments": "Y-Y-Y-Y-Y-Y-Y-Y-Y-Y-Y",
    "CreatedBy": "FEDERAL",
    "CreationDate": "2021-07-13T15:53:07.004+00:00",
    "LastUpdateDate": "2021-07-13T15:53:10.929+00:00",
    "LastUpdatedBy": "FEDERAL",
    "LastUpdateLogin": "C5EC80990D48926EE053BB28F70AAA55",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163",
            "name": "fedLedgerOptions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163",
            "name": "fedLedgerOptions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163/child/fedLedgerOptionBudgetLevels",
            "name": "fedLedgerOptionBudgetLevels",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163/child/fedLedgerOptionDFF",
            "name": "fedLedgerOptionDFF",
            "kind": "collection"
        }
    ]
}

Back to Top