REST API for Oracle Fusion Cloud Financials

Create setup options

post

/fscmRestApi/resources/11.13.18.05/fedSetupOptions

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: object

Show Source

AgencyAbbreviation: string

Title: PAM Agency Abbreviation

Maximum Length: 4

Agency abbreviation of the setup option.
BusinessUnit: string

Title: Business Unit

Maximum Length: 80

Business unit of the setup option.
ConfigOptionId: integer (int64)

Title: Configuration Option ID

Unique identifier of the setup option.
DefaultDiscountLostReason: string

Title: Default Discount Lost Reason

Maximum Length: 255

Default discount lost reason for the setup option.
DefaultInterestReason: string

Title: Default Interest Reason

Maximum Length: 255

Default interest reason for the setup option.
FederalEmployerNumber: integer (int64)

Title: Federal Employer ID Number

Federal employer ID for the setup option.
fedSetupOptionDFF: array fedSetupOptionDFF
PamInputSystemName: string

Title: PAM Input System

Maximum Length: 40

The name of the PAM input system associated with the setup option.
SAMDefaultBank: string

Title: SAM Default Bank

Maximum Length: 255

SAM default bank for the setup option.
SAMDefaultBranch: string

Title: SAM Default Bank Branch

Maximum Length: 255

SAM default branch for the setup option.

{
    "type":"object",
    "properties":{
        "FederalEmployerNumber":{
            "title":"Federal Employer ID Number",
            "type":"integer",
            "description":"Federal employer ID for the setup option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DefaultInterestReason":{
            "title":"Default Interest Reason",
            "maxLength":"255",
            "type":"string",
            "description":"Default interest reason for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "DefaultInterestReason1"
                ]
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"80",
            "type":"string",
            "description":"Business unit of the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId1",
                    "Name"
                ]
            }
        },
        "fedSetupOptionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedSetupOptions-fedSetupOptionDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "PamInputSystemName":{
            "title":"PAM Input System",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the PAM input system associated with the setup option.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AgencyAbbreviation":{
            "title":"PAM Agency Abbreviation",
            "maxLength":"4",
            "type":"string",
            "description":"Agency abbreviation of the setup option.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DefaultDiscountLostReason":{
            "title":"Default Discount Lost Reason",
            "maxLength":"255",
            "type":"string",
            "description":"Default discount lost reason for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1",
                    "DefaultDiscountLostReason1"
                ]
            }
        },
        "ConfigOptionId":{
            "title":"Configuration Option ID",
            "type":"integer",
            "description":"Unique identifier of the setup option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SAMDefaultBranch":{
            "title":"SAM Default Bank Branch",
            "maxLength":"255",
            "type":"string",
            "description":"SAM default branch for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BankBranchName",
                    "BankPartyId",
                    "SamDefaultBankId",
                    "BranchPartyId",
                    "SamDefaultBranchId"
                ]
            }
        },
        "SAMDefaultBank":{
            "title":"SAM Default Bank",
            "maxLength":"255",
            "type":"string",
            "description":"SAM default bank for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BankName",
                    "BankPartyId",
                    "SamDefaultBankId"
                ]
            }
        }
    }
}

Nested Schema : fedSetupOptionDFF

Type: array

Show Source

Array of: object fedSetupOptions-fedSetupOptionDFF-item-post-request

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

Nested Schema : fedSetupOptions-fedSetupOptionDFF-item-post-request

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 150
__FLEX_Context_DisplayValue: string

Title: Context Segment
ConfigOptionId: 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"
                }
            }
        },
        "ConfigOptionId":{
            "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"
                }
            }
        }
    }
}

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

Type: object

Show Source

AgencyAbbreviation: string

Title: PAM Agency Abbreviation

Maximum Length: 4

Agency abbreviation of the setup option.
BusinessUnit: string

Title: Business Unit

Maximum Length: 80

Business unit of the setup option.
ConfigOptionId: integer (int64)

Title: Configuration Option ID

Unique identifier of the setup option.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

User who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date when the record was created.
DefaultDiscountLostReason: string

Title: Default Discount Lost Reason

Maximum Length: 255

Default discount lost reason for the setup option.
DefaultInterestReason: string

Title: Default Interest Reason

Maximum Length: 255

Default interest reason for the setup option.
FederalEmployerNumber: integer (int64)

Title: Federal Employer ID Number

Federal employer ID for the setup option.
fedSetupOptionDFF: array fedSetupOptionDFF
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when the record was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

User who last updated the record.
LastUpdateLogin: string

Title: Last Update Login

Read Only: true

Maximum Length: 32

The session login associated to the user who last updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
PamInputSystemName: string

Title: PAM Input System

Maximum Length: 40

The name of the PAM input system associated with the setup option.
SAMDefaultBank: string

Title: SAM Default Bank

Maximum Length: 255

SAM default bank for the setup option.
SAMDefaultBranch: string

Title: SAM Default Bank Branch

Maximum Length: 255

SAM default branch for the setup option.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyAbbreviation":{
            "title":"PAM Agency Abbreviation",
            "maxLength":"4",
            "type":"string",
            "description":"Agency abbreviation of the setup option.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ConfigOptionId":{
            "title":"Configuration Option ID",
            "type":"integer",
            "description":"Unique identifier of the setup option.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SAMDefaultBank":{
            "title":"SAM Default Bank",
            "maxLength":"255",
            "type":"string",
            "description":"SAM default bank for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BankName",
                    "BankPartyId",
                    "SamDefaultBankId"
                ]
            },
            "x-queryable":true
        },
        "FederalEmployerNumber":{
            "title":"Federal Employer ID Number",
            "type":"integer",
            "description":"Federal employer ID for the setup option.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DefaultInterestReason":{
            "title":"Default Interest Reason",
            "maxLength":"255",
            "type":"string",
            "description":"Default interest reason for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "DefaultInterestReason1"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":"80",
            "type":"string",
            "description":"Business unit of the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BusinessUnitId1",
                    "Name"
                ]
            },
            "x-queryable":true
        },
        "fedSetupOptionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/fedSetupOptions-fedSetupOptionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PamInputSystemName":{
            "title":"PAM Input System",
            "maxLength":"40",
            "type":"string",
            "description":"The name of the PAM input system associated with the setup option.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DefaultDiscountLostReason":{
            "title":"Default Discount Lost Reason",
            "maxLength":"255",
            "type":"string",
            "description":"Default discount lost reason for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode1",
                    "Meaning1",
                    "DefaultDiscountLostReason1"
                ]
            },
            "x-queryable":true
        },
        "SAMDefaultBranch":{
            "title":"SAM Default Bank Branch",
            "maxLength":"255",
            "type":"string",
            "description":"SAM default branch for the setup option.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "BankBranchName",
                    "BankPartyId",
                    "SamDefaultBankId",
                    "BranchPartyId",
                    "SamDefaultBranchId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "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 record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : fedSetupOptionDFF

Type: array

Show Source

Array of: object fedSetupOptions-fedSetupOptionDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/fedSetupOptions-fedSetupOptionDFF-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 : fedSetupOptions-fedSetupOptionDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 150
__FLEX_Context_DisplayValue: string

Title: Context Segment
ConfigOptionId: 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
        },
        "ConfigOptionId":{
            "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"
    }
}

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

Links

fedSetupOptionDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF

Parameters:

ConfigOptionId: $request.path.ConfigOptionId

Examples

The following example shows how to create the federal setup options 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/fedSetupOptions

Example Request Payload

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

{
            "BusinessUnit": "FederalBusinessUnit",
            "FederalEmployerNumber": 888888888,
            "AgencyAbbreviation": "1234",
            "DefaultInterestReason": "Late",
            "DefaultDiscountLostReason": "Discount Lost"
}

Example Response Body

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

{
    "ConfigOptionId": 300100208866413,
    "BusinessUnit": "FederalBusinessUnit",
    "FederalEmployerNumber": 888888888,
    "AgencyAbbreviation": "1234",
    "DefaultInterestReason": "Late",
    "DefaultDiscountLostReason": "Discount Lost",
    "CreatedBy": "FEDERAL",
    "CreationDate": "2020-08-21T12:09:21+00:00",
    "LastUpdatedBy": "FEDERAL",
    "LastUpdateDate": "2020-08-21T12:09:21.215+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413",
            "name": "fedSetupOptions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413",
            "name": "fedSetupOptions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedSetupOptions/300100208866413/child/fedSetupOptionDFF",
            "name": "fedSetupOptionDFF",
            "kind": "collection"
        }
    ]
}