Jump to

• Request
• Response
• Examples

Create USSGL accounts

post

/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts

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

• Account(required): string
  Title: Account

  Maximum Length: 6

  A six-digit number used to identify a specific U.S. Standard General Ledger account. The U.S. Standard General Ledger account must be in the U.S. Standard General Ledger chart of accounts.
• AccountDescription(required): string
  Title: Description

  Maximum Length: 240

  Description of the U.S. Standard General Ledger account.
• AccountId: integer (int64)
  Unique identifier for the U.S. Standard General Ledger account.
• AccountType: string
  Title: Budget Spending Type

  Maximum Length: 80

  Identifies whether a U.S. Standard General Ledger account is commitment, obligation, or expenditure account.
• DataActReporting: string
  Title: DATA Act Reporting

  Maximum Length: 80

  Identifies a U.S. Standard General Ledger account as Data Act reportable.
• Enabled: string
  Title: Enabled

  Maximum Length: 80

  Indicates whether an account is active or inactive.
• fedUSSGLAccountDFF: array Federal USSGL Accounts Descriptive Flexfields
  Title: Federal USSGL Accounts Descriptive Flexfields

  The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.
• NormalBalance: string
  Title: Normal Balance

  Maximum Length: 80

  Identifies the normal balance of a U.S. Standard General Ledger account as a debit or credit.

{
    "required":[
        "Account",
        "AccountDescription"
    ],
    "type":"object",
    "properties":{
        "AccountDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the U.S. Standard General Ledger account.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Account":{
            "title":"Account",
            "maxLength":6,
            "type":"string",
            "description":"A six-digit number used to identify a specific U.S. Standard General Ledger account. The U.S. Standard General Ledger account must be in the U.S. Standard General Ledger chart of accounts.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AccountId":{
            "type":"integer",
            "description":"Unique identifier for the U.S. Standard General Ledger account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "NormalBalance":{
            "title":"Normal Balance",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the normal balance of a U.S. Standard General Ledger account as a debit or credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "NaturalAcctBalanceCode"
                ]
            }
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether an account is active or inactive.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActiveFlag",
                    "LookupCode3",
                    "Meaning3"
                ]
            }
        },
        "fedUSSGLAccountDFF":{
            "title":"Federal USSGL Accounts Descriptive Flexfields",
            "type":"array",
            "description":"The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.",
            "items":{
                "$ref":"#/components/schemas/fedUSSGLAccounts-fedUSSGLAccountDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "DataActReporting":{
            "title":"DATA Act Reporting",
            "maxLength":80,
            "type":"string",
            "description":"Identifies a U.S. Standard General Ledger account as Data Act reportable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DataActReportingCode",
                    "LookupCode2",
                    "Meaning2"
                ]
            }
        },
        "AccountType":{
            "title":"Budget Spending Type",
            "maxLength":80,
            "type":"string",
            "description":"Identifies whether a U.S. Standard General Ledger account is commitment, obligation, or expenditure account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetSpendingTypeCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            }
        }
    }
}

Nested Schema : Federal USSGL Accounts Descriptive Flexfields

Type: array

Title: Federal USSGL Accounts Descriptive Flexfields

The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.

Show Source

• Array of: object schema

{
    "title":"Federal USSGL Accounts Descriptive Flexfields",
    "type":"array",
    "description":"The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.",
    "items":{
        "$ref":"#/components/schemas/fedUSSGLAccounts-fedUSSGLAccountDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Descriptive flexfield context.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Descriptive flexfield context display value.
• UssglAccountId: integer (int64)
  Unique identifier for the U.S. Standard General Ledger account.

{
    "type":"object",
    "properties":{
        "UssglAccountId":{
            "type":"integer",
            "description":"Unique identifier for the U.S. Standard General Ledger account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Descriptive flexfield context display value.",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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(required):
  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(required):
  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 : fedUSSGLAccounts-item-response

Type: object

Show Source

• Account: string
  Title: Account

  Maximum Length: 6

  A six-digit number used to identify a specific U.S. Standard General Ledger account. The U.S. Standard General Ledger account must be in the U.S. Standard General Ledger chart of accounts.
• AccountDescription: string
  Title: Description

  Maximum Length: 240

  Description of the U.S. Standard General Ledger account.
• AccountId: integer (int64)
  Unique identifier for the U.S. Standard General Ledger account.
• AccountType: string
  Title: Budget Spending Type

  Maximum Length: 80

  Identifies whether a U.S. Standard General Ledger account is commitment, obligation, or expenditure account.
• 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.
• DataActReporting: string
  Title: DATA Act Reporting

  Maximum Length: 80

  Identifies a U.S. Standard General Ledger account as Data Act reportable.
• Enabled: string
  Title: Enabled

  Maximum Length: 80

  Indicates whether an account is active or inactive.
• fedUSSGLAccountDFF: array Federal USSGL Accounts Descriptive Flexfields
  Title: Federal USSGL Accounts Descriptive Flexfields

  The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.
• 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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NormalBalance: string
  Title: Normal Balance

  Maximum Length: 80

  Identifies the normal balance of a U.S. Standard General Ledger account as a debit or credit.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the U.S. Standard General Ledger account.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Account":{
            "title":"Account",
            "maxLength":6,
            "type":"string",
            "description":"A six-digit number used to identify a specific U.S. Standard General Ledger account. The U.S. Standard General Ledger account must be in the U.S. Standard General Ledger chart of accounts.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountId":{
            "type":"integer",
            "description":"Unique identifier for the U.S. Standard General Ledger account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "NormalBalance":{
            "title":"Normal Balance",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the normal balance of a U.S. Standard General Ledger account as a debit or credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LookupCode",
                    "Meaning",
                    "NaturalAcctBalanceCode"
                ]
            },
            "x-queryable":true
        },
        "Enabled":{
            "title":"Enabled",
            "maxLength":80,
            "type":"string",
            "description":"Indicates whether an account is active or inactive.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActiveFlag",
                    "LookupCode3",
                    "Meaning3"
                ]
            },
            "x-queryable":true
        },
        "AccountType":{
            "title":"Budget Spending Type",
            "maxLength":80,
            "type":"string",
            "description":"Identifies whether a U.S. Standard General Ledger account is commitment, obligation, or expenditure account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "BudgetSpendingTypeCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "fedUSSGLAccountDFF":{
            "title":"Federal USSGL Accounts Descriptive Flexfields",
            "type":"array",
            "description":"The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.",
            "items":{
                "$ref":"#/components/schemas/fedUSSGLAccounts-fedUSSGLAccountDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DataActReporting":{
            "title":"DATA Act Reporting",
            "maxLength":80,
            "type":"string",
            "description":"Identifies a U.S. Standard General Ledger account as Data Act reportable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DataActReportingCode",
                    "LookupCode2",
                    "Meaning2"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Federal USSGL Accounts Descriptive Flexfields

Type: array

Title: Federal USSGL Accounts Descriptive Flexfields

The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.

Show Source

• Array of: object fedUSSGLAccounts-fedUSSGLAccountDFF-item-response

{
    "title":"Federal USSGL Accounts Descriptive Flexfields",
    "type":"array",
    "description":"The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.",
    "items":{
        "$ref":"#/components/schemas/fedUSSGLAccounts-fedUSSGLAccountDFF-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 : fedUSSGLAccounts-fedUSSGLAccountDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context

  Maximum Length: 150

  Descriptive flexfield context.
• __FLEX_Context_DisplayValue: string
  Title: Context

  Descriptive flexfield context display value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UssglAccountId: integer (int64)
  Unique identifier for the U.S. Standard General Ledger account.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UssglAccountId":{
            "type":"integer",
            "description":"Unique identifier for the U.S. Standard General Ledger account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context",
            "type":"string",
            "description":"Descriptive flexfield context display value.",
            "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
        },
        "__FLEX_Context":{
            "title":"Context",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":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

fedUSSGLAccountDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF

Parameters:

• AccountId: $request.path.AccountId

The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.

Back to Top

Examples

The following example shows how to create a USSGL account 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/fedUSSGLAccounts

Example Request Payload

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

{
	"Account": "929999",
    "AccountDescription": "USSGL test",
    "NormalBalance": "Debit SGL account type",
    "AccountType": "Obligations",
    "DataActReporting": "A Appropriations, B Object Program, C Award",
    "Enabled": "Yes"
}

Example Response Body

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

{
    "AccountId": 300100181825407,
    "Account": "929999",
    "AccountDescription": "USSGL test",
    "NormalBalance": "Debit SGL account type",
    "AccountType": "Obligations",
    "DataActReporting": "A Appropriations, B Object Program, C Award",
    "Enabled": "Yes",
    "CreatedBy": "FIN_USER1",
    "CreationDate": "2019-11-24T22:22:26.002+00:00",
    "LastUpdatedBy": "FIN_USER1",
    "LastUpdateDate": "2019-11-24T22:22:26.111+00:00",
    "LastUpdateLogin": "982665196B8168D8E053A732C40A0B08",
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407",
            "name": "fedUSSGLAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407",
            "name": "fedUSSGLAccounts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300100181825407/child/fedUSSGLAccountDFF",
            "name": "fedUSSGLAccountDFF",
            "kind": "collection"
        }
    ]
}

Back to Top