Jump to

• Request
• Response
• Examples

Update a federal attribute supplemental rule

patch

/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}

Request

Path Parameters

• SupplRuleHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• fedAttributeSupplementalRuleLines: array Federal Attribute Supplemental Rule Lines
  Title: Federal Attribute Supplemental Rule Lines

  The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.
• TreasuryAccountSymbol: string
  Title: Treasury Account Symbol

  Maximum Length: 255

  Treasury account symbol associated with the federal attribute supplemental rule

{
    "type":"object",
    "properties":{
        "TreasuryAccountSymbol":{
            "title":"Treasury Account Symbol",
            "maxLength":"255",
            "type":"string",
            "description":"Treasury account symbol associated with the federal attribute supplemental rule",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId"
                ]
            }
        },
        "fedAttributeSupplementalRuleLines":{
            "title":"Federal Attribute Supplemental Rule Lines",
            "type":"array",
            "description":"The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-patch-request"
            }
        }
    }
}

Nested Schema : Federal Attribute Supplemental Rule Lines

Type: array

Title: Federal Attribute Supplemental Rule Lines

The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.

Show Source

• Array of: object schema

{
    "title":"Federal Attribute Supplemental Rule Lines",
    "type":"array",
    "description":"The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Allocate: string
  Title: Allocate

  Maximum Length: 255

  Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.
• fedAttributeSupplementalRuleAllocations: array Federal Attribute Supplemental Rule Allocations
  Title: Federal Attribute Supplemental Rule Allocations

  The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.
• fedAttributeSupplementalRuleExceptionMessages: array Federal Attribute Supplemental Rule Exception Messages
  Title: Federal Attribute Supplemental Rule Exception Messages

  The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.
• fedAttributeSupplementalRuleFilters: array Federal Attribute Supplemental Rule Line Filters
  Title: Federal Attribute Supplemental Rule Line Filters

  The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.
• FromPeriod: string
  Title: From Period

  Maximum Length: 15

  Name of the starting period associated with the federal supplemental rule line.
• ReportingCodeValue: string
  Title: Reporting Code

  Maximum Length: 255

  Reporting code value of the federal attribute supplemental rule line.
• ToPeriod: string
  Title: To Period

  Maximum Length: 15

  Name of the ending period associated with the federal account attribute line.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 255

  Validation status of the federal attribute supplemental rule line.

{
    "type":"object",
    "properties":{
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":"255",
            "type":"string",
            "description":"Validation status of the federal attribute supplemental rule line.",
            "nullable":true
        },
        "ToPeriod":{
            "title":"To Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the ending period associated with the federal account attribute line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ReportingCodeValue":{
            "title":"Reporting Code",
            "maxLength":"255",
            "type":"string",
            "description":"Reporting code value of the federal attribute supplemental rule line.",
            "nullable":true
        },
        "FromPeriod":{
            "title":"From Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the starting period associated with the federal supplemental rule line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "fedAttributeSupplementalRuleExceptionMessages":{
            "title":"Federal Attribute Supplemental Rule Exception Messages",
            "type":"array",
            "description":"The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-patch-request"
            }
        },
        "fedAttributeSupplementalRuleAllocations":{
            "title":"Federal Attribute Supplemental Rule Allocations",
            "type":"array",
            "description":"The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-patch-request"
            }
        },
        "fedAttributeSupplementalRuleFilters":{
            "title":"Federal Attribute Supplemental Rule Line Filters",
            "type":"array",
            "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-patch-request"
            }
        },
        "Allocate":{
            "title":"Allocate",
            "maxLength":"255",
            "type":"string",
            "description":"Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.",
            "nullable":true
        }
    }
}

Nested Schema : Federal Attribute Supplemental Rule Allocations

Type: array

Title: Federal Attribute Supplemental Rule Allocations

The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-patch-request

{
    "title":"Federal Attribute Supplemental Rule Allocations",
    "type":"array",
    "description":"The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-patch-request"
    }
}

Nested Schema : Federal Attribute Supplemental Rule Exception Messages

Type: array

Title: Federal Attribute Supplemental Rule Exception Messages

The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-patch-request

{
    "title":"Federal Attribute Supplemental Rule Exception Messages",
    "type":"array",
    "description":"The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-patch-request"
    }
}

Nested Schema : Federal Attribute Supplemental Rule Line Filters

Type: array

Title: Federal Attribute Supplemental Rule Line Filters

The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-patch-request

{
    "title":"Federal Attribute Supplemental Rule Line Filters",
    "type":"array",
    "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-patch-request"
    }
}

Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-patch-request

Type: object

Show Source

• Percentage: number
  Title: Percentage

  Percentage associated with the federal attribute supplemental rule allocation.
• ReportingCodeValue: string
  Title: Reporting Code

  Maximum Length: 255

  Value associated with the federal attribute supplemental rule allocation.

{
    "type":"object",
    "properties":{
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage associated with the federal attribute supplemental rule allocation.",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":"5"
            }
        },
        "ReportingCodeValue":{
            "title":"Reporting Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value associated with the federal attribute supplemental rule allocation.",
            "nullable":true
        }
    }
}

Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-patch-request

Type: object

Show Source

• AccountingSegment: string
  Title: Accounting Segment

  Maximum Length: 255

  Accounting segment of the federal attribute supplemental rule filter.
• HighValue: string
  Title: High Value

  Maximum Length: 25

  High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.
• LowValue: string
  Title: Low Value

  Maximum Length: 25

  Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator of the federal attribute supplemental rule filter.
• Value: string
  Title: Value

  Maximum Length: 25

  Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.

{
    "type":"object",
    "properties":{
        "Operator":{
            "title":"Operator",
            "maxLength":"255",
            "type":"string",
            "description":"Operator of the federal attribute supplemental rule filter.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorLookupCode",
                    "OperatorMeaning"
                ]
            }
        },
        "Value":{
            "title":"Value",
            "maxLength":"25",
            "type":"string",
            "description":"Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            }
        },
        "HighValue":{
            "title":"High Value",
            "maxLength":"25",
            "type":"string",
            "description":"High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            }
        },
        "AccountingSegment":{
            "title":"Accounting Segment",
            "maxLength":"255",
            "type":"string",
            "description":"Accounting segment of the federal attribute supplemental rule filter.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "LowValue":{
            "title":"Low Value",
            "maxLength":"25",
            "type":"string",
            "description":"Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• 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.
• fedAttributeSupplementalRuleLines: array Federal Attribute Supplemental Rule Lines
  Title: Federal Attribute Supplemental Rule Lines

  The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.
• FederalAttributeName: string
  Title: Federal Attribute Name

  Maximum Length: 150

  Name of the attribute associated with the federal attribute supplemental rule.
• 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.
• LedgerName: string
  Title: Ledger Name

  Maximum Length: 30

  Name of the ledger associated with the federal attribute supplemental rule
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SupplRuleHeaderId: integer (int64)
  Title: Supplemental Rule Header ID

  The unique identifier of the federal attribute supplemental rule.
• TreasuryAccountSymbol: string
  Title: Treasury Account Symbol

  Maximum Length: 255

  Treasury account symbol associated with the federal attribute supplemental rule

{
    "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":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "fedAttributeSupplementalRuleLines":{
            "title":"Federal Attribute Supplemental Rule Lines",
            "type":"array",
            "description":"The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FederalAttributeName":{
            "title":"Federal Attribute Name",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the attribute associated with the federal attribute supplemental rule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId"
                ]
            },
            "x-queryable":true
        },
        "TreasuryAccountSymbol":{
            "title":"Treasury Account Symbol",
            "maxLength":"255",
            "type":"string",
            "description":"Treasury account symbol associated with the federal attribute supplemental rule",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LedgerId"
                ]
            },
            "x-queryable":true
        },
        "SupplRuleHeaderId":{
            "title":"Supplemental Rule Header ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LedgerName":{
            "title":"Ledger Name",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the ledger associated with the federal attribute supplemental rule",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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":true
        }
    }
}

Nested Schema : Federal Attribute Supplemental Rule Lines

Type: array

Title: Federal Attribute Supplemental Rule Lines

The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-response

{
    "title":"Federal Attribute Supplemental Rule Lines",
    "type":"array",
    "description":"The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-response"
    }
}

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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-response

Type: object

Show Source

• Allocate: string
  Title: Allocate

  Maximum Length: 255

  Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.
• 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: 255

  A brief description of the reporting code associated with the federal supplemental rule line.
• fedAttributeSupplementalRuleAllocations: array Federal Attribute Supplemental Rule Allocations
  Title: Federal Attribute Supplemental Rule Allocations

  The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.
• fedAttributeSupplementalRuleExceptionMessages: array Federal Attribute Supplemental Rule Exception Messages
  Title: Federal Attribute Supplemental Rule Exception Messages

  The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.
• fedAttributeSupplementalRuleFilters: array Federal Attribute Supplemental Rule Line Filters
  Title: Federal Attribute Supplemental Rule Line Filters

  The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.
• FromPeriod: string
  Title: From Period

  Maximum Length: 15

  Name of the starting period associated with the federal supplemental rule line.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReportingCodeValue: string
  Title: Reporting Code

  Maximum Length: 255

  Reporting code value of the federal attribute supplemental rule line.
• SupplRuleLineId: integer (int64)
  Title: Supplemental Rule Line ID

  The unique identifier of the federal attribute supplemental rule line.
• ToPeriod: string
  Title: To Period

  Maximum Length: 15

  Name of the ending period associated with the federal account attribute line.
• ValidationStatus: string
  Title: Validation Status

  Maximum Length: 255

  Validation status of the federal attribute supplemental rule line.

{
    "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":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ToPeriod":{
            "title":"To Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the ending period associated with the federal account attribute line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"A brief description of the reporting code associated with the federal supplemental rule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplRuleLineId":{
            "title":"Supplemental Rule Line ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FromPeriod":{
            "title":"From Period",
            "maxLength":"15",
            "type":"string",
            "description":"Name of the starting period associated with the federal supplemental rule line.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ValidationStatus":{
            "title":"Validation Status",
            "maxLength":"255",
            "type":"string",
            "description":"Validation status of the federal attribute supplemental rule line.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportingCodeValue":{
            "title":"Reporting Code",
            "maxLength":"255",
            "type":"string",
            "description":"Reporting code value of the federal attribute supplemental rule line.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "fedAttributeSupplementalRuleExceptionMessages":{
            "title":"Federal Attribute Supplemental Rule Exception Messages",
            "type":"array",
            "description":"The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response"
            }
        },
        "fedAttributeSupplementalRuleAllocations":{
            "title":"Federal Attribute Supplemental Rule Allocations",
            "type":"array",
            "description":"The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-response"
            }
        },
        "fedAttributeSupplementalRuleFilters":{
            "title":"Federal Attribute Supplemental Rule Line Filters",
            "type":"array",
            "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
            "items":{
                "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response"
            }
        },
        "Allocate":{
            "title":"Allocate",
            "maxLength":"255",
            "type":"string",
            "description":"Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes.",
            "nullable":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":true
        }
    }
}

Nested Schema : Federal Attribute Supplemental Rule Allocations

Type: array

Title: Federal Attribute Supplemental Rule Allocations

The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-response

{
    "title":"Federal Attribute Supplemental Rule Allocations",
    "type":"array",
    "description":"The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-response"
    }
}

Nested Schema : Federal Attribute Supplemental Rule Exception Messages

Type: array

Title: Federal Attribute Supplemental Rule Exception Messages

The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response

{
    "title":"Federal Attribute Supplemental Rule Exception Messages",
    "type":"array",
    "description":"The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response"
    }
}

Nested Schema : Federal Attribute Supplemental Rule Line Filters

Type: array

Title: Federal Attribute Supplemental Rule Line Filters

The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.

Show Source

• Array of: object fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response

{
    "title":"Federal Attribute Supplemental Rule Line Filters",
    "type":"array",
    "description":"The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.",
    "items":{
        "$ref":"#/components/schemas/fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response"
    }
}

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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-response

Type: object

Show Source

• 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: 255

  Description of the federal attribute supplemental rule allocation.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Percentage: number
  Title: Percentage

  Percentage associated with the federal attribute supplemental rule allocation.
• ReportingCodeValue: string
  Title: Reporting Code

  Maximum Length: 255

  Value associated with the federal attribute supplemental rule allocation.
• SupplRuleAllocationId: integer (int64)
  Title: Supplemental Rule Allocation ID

  The unique identifier of the federal attribute supplemental rule allocation.

{
    "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":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the federal attribute supplemental rule allocation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ReportingCode"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percentage",
            "type":"number",
            "description":"Percentage associated with the federal attribute supplemental rule allocation.",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":"5"
            },
            "x-queryable":true
        },
        "SupplRuleAllocationId":{
            "title":"Supplemental Rule Allocation ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule allocation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReportingCodeValue":{
            "title":"Reporting Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value associated with the federal attribute supplemental rule allocation.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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":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."
        }
    }
}

Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response

Type: object

Show Source

• Code: string
  Title: Exception Code

  Maximum Length: 30

  Code of the federal attribute supplemental rule exception message.
• 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: Exception Text

  Maximum Length: 4000

  Description of the federal attribute supplemental rule exception message.
• ExceptionUniqueId: integer (int64)
  Title: Exception Unique Id

  The unique identifier of the federal attribute supplemental rule exception message.
• JobId: integer (int64)
  Title: Job Id

  The unique identifier of the job associated with the federal attribute supplemental rule exception message.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentTableUniqueId: integer
  Title: Parent Table Unique Id

  The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.
• ProcessName: string
  Title: Process Name

  Maximum Length: 150

  Name of the process associated with the federal attribute supplemental rule exception message.

{
    "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ParentTableUniqueId":{
            "title":"Parent Table Unique Id",
            "type":"integer",
            "description":"The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProcessName":{
            "title":"Process Name",
            "maxLength":"150",
            "type":"string",
            "description":"Name of the process associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Exception Text",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ExceptionUniqueId":{
            "title":"Exception Unique Id",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Code":{
            "title":"Exception Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job Id",
            "type":"integer",
            "description":"The unique identifier of the job associated with the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "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-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response

Type: object

Show Source

• AccountingSegment: string
  Title: Accounting Segment

  Maximum Length: 255

  Accounting segment of the federal attribute supplemental rule filter.
• 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.
• HighValue: string
  Title: High Value

  Maximum Length: 25

  High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.
• 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 date when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowValue: string
  Title: Low Value

  Maximum Length: 25

  Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator of the federal attribute supplemental rule filter.
• SupplRuleFilterId: integer (int64)
  Title: Supplemental Rule Filter ID

  The unique identifier of the federal attribute supplemental rule filter.
• Value: string
  Title: Value

  Maximum Length: 25

  Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":"255",
            "type":"string",
            "description":"Operator of the federal attribute supplemental rule filter.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OperatorLookupCode",
                    "OperatorMeaning"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HighValue":{
            "title":"High Value",
            "maxLength":"25",
            "type":"string",
            "description":"High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplRuleFilterId":{
            "title":"Supplemental Rule Filter ID",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule filter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Value":{
            "title":"Value",
            "maxLength":"25",
            "type":"string",
            "description":"Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccountingSegment":{
            "title":"Accounting Segment",
            "maxLength":"255",
            "type":"string",
            "description":"Accounting segment of the federal attribute supplemental rule filter.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            },
            "x-queryable":true
        },
        "LowValue":{
            "title":"Low Value",
            "maxLength":"25",
            "type":"string",
            "description":"Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "OperatorCode",
                    "ValuesetId"
                ]
            },
            "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":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

fedAttributeSupplementalRuleLines

Operation: /fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines

Parameters:

• SupplRuleHeaderId: $request.path.SupplRuleHeaderId

The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.

Back to Top

Examples

The following example shows how to update a federal attribute supplemental rule by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}

Request Body Example

The following shows an example of the request body in JSON format.

{
  "TreasuryAccountSymbol": "75180118"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "SupplRuleHeaderId": "300100588674432",
    "LedgerName": "USFed1 US",
    "FederalAttributeName": "Apportionment Category Code",
    "TreasuryAccountSymbol": "75180118",
    "CreationDate": "2024-03-11T11:29:01+00:00",
    "CreatedBy": "username",
    "LastUpdatedBy": "username",
    "LastUpdateDate": "2024-03-12T08:49:07+00:00",
    "@context": {
        "key": "300100588674432",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432",
                "name": "fedAttributeSupplementalRules",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432",
                "name": "fedAttributeSupplementalRules",
                "kind": "item"
            },
            {
                "rel": "child",
                "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines",
                "name": "fedAttributeSupplementalRuleLines",
                "kind": "collection"
            }
        ]
    }
}

Back to Top