Jump to

• Request
• Response
• Examples

Create a rule

post

/fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• AbsorptionType(required): string
  Title: Absorption Type

  Maximum Length: 255
• AbsorptionTypeCode(required): string
  Title: Absorption Type

  Maximum Length: 3
• BasedOn: string
  Title: Based On

  Maximum Length: 30
• CategoryId: integer (int64)
  Title: Category ID
• CategoryName: string
  Title: Category Name

  Maximum Length: 2400
• CostBasis(required): string
  Title: Cost Basis

  Maximum Length: 255
• CostBasisCode(required): string
  Title: Cost Basis

  Maximum Length: 18
• CostBook(required): string
  Title: Cost Book

  Maximum Length: 30
• CostBookId(required): integer (int64)
  Title: Cost Book ID
• CostElement(required): string
  Title: Cost Element

  Maximum Length: 30
• CostElementId(required): integer (int64)
  Title: Cost Element ID
• CostOrganizationId(required): integer (int64)
  Title: Cost Organization ID
• CostOrganizationName(required): string
  Title: Cost Organization

  Maximum Length: 240
• ElementGroupId: integer (int64)
  Title: Element Group ID
• ExpensePool(required): string
  Title: Expense Pool

  Maximum Length: 30
• ExpensePoolId(required): integer (int64)
  Title: Expense Pool ID
• InventoryOrganizationCode: string
  Title: Inventory Organization

  Maximum Length: 18
• InventoryOrganizationId: integer (int64)
  Title: Inventory Organization ID
• Item: string
  Title: Item

  Maximum Length: 300
• ItemId: integer (int64)
  Title: Item ID
• OverheadRuleDetails: array OverheadRuleDetails
• ProcessedFlagCode: string
  Maximum Length: 1

  Default Value: N
• RuleName(required): string
  Title: Rule Name

  Maximum Length: 30
• TransactionFlow: string
  Title: Transaction Flow

  Maximum Length: 255
• TransactionFlowCode(required): string
  Title: Transaction Flow

  Maximum Length: 18
• TransactionGroup: string
  Title: Transaction Group

  Maximum Length: 255
• TransactionGroupId(required): integer (int64)
  Title: Transaction Group ID
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 255
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

{
    "required":[
        "AbsorptionType",
        "AbsorptionTypeCode",
        "CostBasis",
        "CostBasisCode",
        "CostBook",
        "CostBookId",
        "CostElement",
        "CostElementId",
        "CostOrganizationId",
        "CostOrganizationName",
        "ExpensePool",
        "ExpensePoolId",
        "RuleName",
        "TransactionFlowCode",
        "TransactionGroupId"
    ],
    "type":"object",
    "properties":{
        "AbsorptionType":{
            "title":"Absorption Type",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AbsorptionTypeCode":{
            "title":"Absorption Type",
            "maxLength":3,
            "type":"string",
            "nullable":false
        },
        "BasedOn":{
            "title":"Based On",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":2400,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBasis":{
            "title":"Cost Basis",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBasisCode":{
            "title":"Cost Basis",
            "maxLength":18,
            "type":"string",
            "nullable":false
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CostOrganizationName":{
            "title":"Cost Organization",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ElementGroupId":{
            "title":"Element Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryOrganizationCode":{
            "title":"Inventory Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "OverheadRuleDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/costAccountingOverheadRules-OverheadRuleDetails-item-post-request"
            }
        },
        "ProcessedFlagCode":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "default":"N"
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "TransactionFlow":{
            "title":"Transaction Flow",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionFlowCode":{
            "title":"Transaction Flow",
            "maxLength":18,
            "type":"string",
            "nullable":false
        },
        "TransactionGroup":{
            "title":"Transaction Group",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionGroupId":{
            "title":"Transaction Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : OverheadRuleDetails

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/costAccountingOverheadRules-OverheadRuleDetails-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date
• FromPeriod: string
  Title: From Period
• FromPeriodStatusCode: string
  Maximum Length: 80
• Rate: number
  Title: Rate
• StartDate: string (date)
  Title: Start Date
• ToPeriod: string
  Title: To Period
• ToPeriodStatusCode: string

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "FromPeriod":{
            "title":"From Period",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "FromPeriodStatusCode":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "format":"date",
            "nullable":false
        },
        "ToPeriod":{
            "title":"To Period",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "sortable":false
            }
        },
        "ToPeriodStatusCode":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

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

Type: object

Show Source

• AbsorptionType: string
  Title: Absorption Type

  Maximum Length: 255
• AbsorptionTypeCode: string
  Title: Absorption Type

  Maximum Length: 3
• BasedOn: string
  Title: Based On

  Maximum Length: 30
• CategoryId: integer (int64)
  Title: Category ID
• CategoryName: string
  Title: Category Name

  Maximum Length: 2400
• CostBasis: string
  Title: Cost Basis

  Maximum Length: 255
• CostBasisCode: string
  Title: Cost Basis

  Maximum Length: 18
• CostBook: string
  Title: Cost Book

  Maximum Length: 30
• CostBookId: integer (int64)
  Title: Cost Book ID
• CostElement: string
  Title: Cost Element

  Maximum Length: 30
• CostElementId: integer (int64)
  Title: Cost Element ID
• CostOrganizationId: integer (int64)
  Title: Cost Organization ID
• CostOrganizationName: string
  Title: Cost Organization

  Maximum Length: 240
• ElementGroupId: integer (int64)
  Title: Element Group ID
• ExpensePool: string
  Title: Expense Pool

  Maximum Length: 30
• ExpensePoolId: integer (int64)
  Title: Expense Pool ID
• InventoryOrganizationCode: string
  Title: Inventory Organization

  Maximum Length: 18
• InventoryOrganizationId: integer (int64)
  Title: Inventory Organization ID
• InventoryOrganizationName: string
  Read Only: true

  Maximum Length: 240
• IsCPRunning: string
  Read Only: true

  Maximum Length: 255
• IsRecordUpdatable: string
  Read Only: true

  Maximum Length: 255
• Item: string
  Title: Item

  Maximum Length: 300
• ItemId: integer (int64)
  Title: Item ID
• LastUpdateDate: string (date-time)
  Read Only: true
• LatestRevisionEndDate: string (date)
  Read Only: true
• LatestRevisionRate: number
  Read Only: true
• LatestRevisionStartDate: string (date)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OverheadRuleDetails: array OverheadRuleDetails
• PeriodicAverageFlag: boolean
  Read Only: true

  Maximum Length: 1
• ProcessedFlagCode: string
  Maximum Length: 1

  Default Value: N
• ProcessedFlagMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80
• RuleId: integer (int64)
  Title: Rule ID

  Read Only: true
• RuleName: string
  Title: Rule Name

  Maximum Length: 30
• StatusCode: string
  Read Only: true

  Maximum Length: 255
• TransactionFlow: string
  Title: Transaction Flow

  Maximum Length: 255
• TransactionFlowCode: string
  Title: Transaction Flow

  Maximum Length: 18
• TransactionGroup: string
  Title: Transaction Group

  Maximum Length: 255
• TransactionGroupId: integer (int64)
  Title: Transaction Group ID
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 255
• TransactionTypeId: integer (int64)
  Title: Transaction Type ID

{
    "type":"object",
    "properties":{
        "AbsorptionType":{
            "title":"Absorption Type",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AbsorptionTypeCode":{
            "title":"Absorption Type",
            "maxLength":3,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "BasedOn":{
            "title":"Based On",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":2400,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBasis":{
            "title":"Cost Basis",
            "maxLength":255,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBasisCode":{
            "title":"Cost Basis",
            "maxLength":18,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "CostBook":{
            "title":"Cost Book",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostBookId":{
            "title":"Cost Book ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostElement":{
            "title":"Cost Element",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CostElementId":{
            "title":"Cost Element ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrganizationId":{
            "title":"Cost Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostOrganizationName":{
            "title":"Cost Organization",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ElementGroupId":{
            "title":"Element Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpensePool":{
            "title":"Expense Pool",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpensePoolId":{
            "title":"Expense Pool ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrganizationCode":{
            "title":"Inventory Organization",
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryOrganizationId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryOrganizationName":{
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCPRunning":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IsRecordUpdatable":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestRevisionEndDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestRevisionRate":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestRevisionStartDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverheadRuleDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/costAccountingOverheadRules-OverheadRuleDetails-item-response"
            }
        },
        "PeriodicAverageFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessedFlagCode":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ProcessedFlagMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionFlow":{
            "title":"Transaction Flow",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionFlowCode":{
            "title":"Transaction Flow",
            "maxLength":18,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionGroup":{
            "title":"Transaction Group",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionGroupId":{
            "title":"Transaction Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: array

Show Source

• Array of: object costAccountingOverheadRules-OverheadRuleDetails-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/costAccountingOverheadRules-OverheadRuleDetails-item-response"
    }
}

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 : costAccountingOverheadRules-OverheadRuleDetails-item-response

Type: object

Show Source

• CostBook: string
  Read Only: true
• CostOrganizationName: string
  Read Only: true
• EndDate: string (date)
  Title: End Date
• FromPeriod: string
  Title: From Period
• FromPeriodStatus: string
  Read Only: true
• FromPeriodStatusCode: string
  Maximum Length: 80
• IsDetailUpdatable: string
  Read Only: true

  Maximum Length: 255
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessedFlagMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80
• Rate: number
  Title: Rate
• RevisionNumber: integer
  Title: Revision Number

  Read Only: true
• RuleDetailId: integer (int64)
  Title: Rule Detail ID

  Read Only: true
• RuleId: integer (int64)
  Title: Rule ID

  Read Only: true
• RuleName: string
  Read Only: true
• StartDate: string (date)
  Title: Start Date
• ToPeriod: string
  Title: To Period
• ToPeriodStatusCode: string

{
    "type":"object",
    "properties":{
        "CostBook":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostOrganizationName":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FromPeriod":{
            "title":"From Period",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "FromPeriodStatus":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "FromPeriodStatusCode":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "IsDetailUpdatable":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessedFlagMeaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionNumber":{
            "title":"Revision Number",
            "type":"integer",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleDetailId":{
            "title":"Rule Detail ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RuleName":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ToPeriod":{
            "title":"To Period",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ToPeriodStatusCode":{
            "type":"string",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

OverheadRuleDetails

Operation: /fscmRestApi/resources/11.13.18.05/costAccountingOverheadRules/{RuleId}/child/OverheadRuleDetails

Parameters:

• RuleId: $request.path.RuleId

Back to Top

Examples

This example describes how to create one cost accounting overhead rule.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
servername/fscmRestApi/resources/version/costAccountingOverheadRules"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "RuleName" : "Rule1",
  "CostOrganizationName" : "Seattle",
  "CostBook" : "Primary",
  "ExpensePool" : "Electrical Expense",
  "CostElement" : "Electricity",
  "TransactionGroup" : "Purchase order transactions",
  "TransactionType" : "Purchase Order Receipt",
  "TransactionFlow" : "Receipt",
  "CostBasis" : "Unit",
  "AbsorptionType" : "Include in inventory",
  "OverheadRuleDetails": [   {
   "StartDate": "2017-01-01",
   "Rate": 10
   }
  ]
}

Example 1 Response Body

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

{
  "RuleId" : 300100111253919,
  "RuleName" : "Rule1",
  "CostOrganizationName" : "Seattle",
  "CostOrganizationId" : 999993000015516,
  "CostBook" : "Primary",
  "CostBookId" : 300100003455478,
  "ExpensePool" : "Electrical Expense",
  "ExpensePoolId" : 300100089911214,
  "CostElement" : "Electricity",
  "CostElementId" : 300100089911236,
  "TransactionGroup" : "Purchase order transactions",
  "TransactionGroupId" : 5,
  "TransactionType" : "Purchase Order Receipt",
  "TransactionTypeId" : 18,
  "TransactionFlow" : "Receipt",
  "TransactionFlowCode" : "RECEIPT",
  "InventoryOrganizationCode" : null,
  "InventoryOrganizationId" : null,
  "CategoryName" : null,
  "CategoryId" : null,
  "Item" : null,
  "ItemId" : null,
  "CostBasis" : "Unit",
  "CostBasisCode" : "UNIT",
  "BasedOn" : null,
  "ElementGroupId" : null,
  "AbsorptionType" : "Include in inventory",
  "AbsorptionTypeCode" : "1",
  "OverheadRuleDetails" : [ {
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253920,
    "RevisionNumber" : 1,
    "StartDate" : "2017-01-01",
    "EndDate" : "4712-12-31",
    "Rate" : 10
 }
   ]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "RuleName" : "Rule1",
  "CostOrganizationName" : "Seattle",
  "CostBook" : "Primary",
  "ExpensePool" : "Electrical Expense",
  "CostElement" : "Electricity",
  "TransactionGroup" : "Purchase order transactions",
  "TransactionType" : "Purchase Order Receipt",
  "TransactionFlow" : "Receipt",
  "CostBasis" : "Unit",
  "AbsorptionType" : "Include in inventory",
  "OverheadRuleDetails": [   {
   "StartDate": "2017-01-01",
   "EndDate" : "2017-01-31",
   "Rate": 10
   }, {
   "StartDate": "2017-02-01",
   "Rate": 20
   }
  ]
}

Example 2 Response Body

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

{
  "RuleId" : 300100111253919,
  "RuleName" : "Rule1",
  "CostOrganizationName" : "Seattle",
  "CostOrganizationId" : 999993000015516,
  "CostBook" : "Primary",
  "CostBookId" : 300100003455478,
  "ExpensePool" : "Electrical Expense",
  "ExpensePoolId" : 300100089911214,
  "CostElement" : "Electricity",
  "CostElementId" : 300100089911236,
  "TransactionGroup" : "Purchase order transactions",
  "TransactionGroupId" : 5,
  "TransactionType" : "Purchase Order Receipt",
  "TransactionTypeId" : 18,
  "TransactionFlow" : "Receipt",
  "TransactionFlowCode" : "RECEIPT",
  "InventoryOrganizationCode" : null,
  "InventoryOrganizationId" : null,
  "CategoryName" : null,
  "CategoryId" : null,
  "Item" : null,
  "ItemId" : null,
  "CostBasis" : "Unit",
  "CostBasisCode" : "UNIT",
  "BasedOn" : null,
  "ElementGroupId" : null,
  "AbsorptionType" : "Include in inventory",
  "AbsorptionTypeCode" : "1",
  "OverheadRuleDetails" : [ {
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253920,
    "RevisionNumber" : 1,
    "StartDate" : "2017-01-01",
    "EndDate" : "2017-01-31",
    "Rate" : 10
 },{
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253921,
    "RevisionNumber" : 2,
    "StartDate" : "2017-02-01",
    "EndDate" : "4712-12-31",
    "Rate" : 20
 }
   ]
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
  "RuleName" : "Rule1",
  "CostOrganizationId" : 999993000015516,
  "CostBookId" : 300100003455478,
  "ExpensePoolId" : 300100089911214,
  "CostElementId" : 300100089911236,
  "TransactionGroupId" : 5,
  "TransactionTypeId" : 18,
  "TransactionFlowCode" : "RECEIPT",
  "CostBasisCode" : "UNIT",
  "AbsorptionTypeCode" : "1",
  "OverheadRuleDetails" : [ {
    "StartDate" : "2017-01-01",
    "Rate" : 10
 }
   ]
}

Example 3 Response Body

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

{
  "RuleId" : 300100111253919,
  "RuleName" : "Rule1",
  "CostOrganizationName" : "Seattle",
  "CostOrganizationId" : 999993000015516,
  "CostBook" : "Primary",
  "CostBookId" : 300100003455478,
  "ExpensePool" : "Electrical Expense",
  "ExpensePoolId" : 300100089911214,
  "CostElement" : "Electricity",
  "CostElementId" : 300100089911236,
  "TransactionGroup" : "Purchase order transactions",
  "TransactionGroupId" : 5,
  "TransactionType" : "Purchase Order Receipt",
  "TransactionTypeId" : 18,
  "TransactionFlow" : "Receipt",
  "TransactionFlowCode" : "RECEIPT",
  "InventoryOrganizationCode" : null,
  "InventoryOrganizationId" : null,
  "CategoryName" : null,
  "CategoryId" : null,
  "Item" : null,
  "ItemId" : null,
  "CostBasis" : "Unit",
  "CostBasisCode" : "UNIT",
  "BasedOn" : null,
  "ElementGroupId" : null,
  "AbsorptionType" : "Include in inventory",
  "AbsorptionTypeCode" : "1",
  "OverheadRuleDetails" : [ {
    "RuleId" : 300100111253919,
    "RuleDetailId" : 300100111253920,
    "RevisionNumber" : 1,
    "StartDate" : "2017-01-01",
    "EndDate" : "4712-12-31",
    "Rate" : 10
 }
   ]
}

Example 4 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
            "RuleName": "Demo Rule 1",
            "CostOrganizationName": "Auto1-CO",
            "CostBook": "PAC BOOK 1",
            "ExpensePool": "0554EP1",
            "CostElement": "ZCST-Waste-Asset",
            "TransactionGroup": "Inter organization transfers",
            "TransactionType": "Transfer Order Interorganization Receipt",
            "TransactionFlow": "Receipt",
            "InventoryOrganizationCode": "CSTAUTO1",
            "Item": "ZDQ-1000",
            "CostBasis": "Lot",
            "AbsorptionType": "Include in inventory",
            "OverheadRuleDetails": [   {
               "FromPeriod": "11-21",
               "Rate": 10
               }
              ]
 }

Example 4 Response Body

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

{
    "RuleId": 300100549680658,
    "RuleName": "Demo Rule 1",
    "CostOrganizationName": "Auto1-CO",
    "CostOrganizationId": 300100172982769,
    "CostBook": "PAC BOOK 1",
    "CostBookId": 300100549317205,
    "ExpensePool": "0554EP1",
    "ExpensePoolId": 300100137341514,
    "CostElement": "ZCST-Waste-Asset",
    "CostElementId": 100000010001022,
    "TransactionGroup": "Inter organization transfers",
    "TransactionGroupId": 2,
    "TransactionType": "Transfer Order Interorganization Receipt",
    "TransactionTypeId": 61,
    "TransactionFlow": "Receipt",
    "TransactionFlowCode": "RECEIPT",
    "InventoryOrganizationCode": "CSTAUTO1",
    "InventoryOrganizationId": 300100172909868,
    "CategoryName": null,
    "CategoryId": null,
    "Item": "ZDQ-1000",
    "ItemId": 300100059785342,
    "CostBasis": "Lot",
    "CostBasisCode": "LOT",
    "BasedOn": null,
    "ElementGroupId": null,
    "AbsorptionType": "Include in inventory",
    "AbsorptionTypeCode": "1",
    "PeriodicAverageFlag": true,
    "ProcessedFlagMeaning": null,
    "OverheadRuleDetails": [
        {
            "RuleId": 300100549680658,
            "RuleDetailId": 300100549680663,
            "RevisionNumber": 1,
            "StartDate": "2021-11-01",
            "EndDate": "4712-12-31",
            "Rate": 10,
            "FromPeriod": "11-21",
            "ToPeriod": null,
            "FromPeriodStatus": "Open",
            "RuleName": "Demo Rule 1",
            "CostOrganizationName": "Auto1-CO",
            "CostBook": "PAC BOOK 1",
            "ProcessedFlagMeaning": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/child/OverheadRuleDetails/300100549680663",
                    "name": "OverheadRuleDetails",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/child/OverheadRuleDetails/300100549680663",
                    "name": "OverheadRuleDetails",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658",
                    "name": "costAccountingOverheadRules",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658",
            "name": "costAccountingOverheadRules",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658",
            "name": "costAccountingOverheadRules",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CategoryLOV",
            "name": "CategoryLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CostDriverLOV",
            "name": "CostDriverLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CostElementLOV",
            "name": "CostElementLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/ExpensePoolLOV",
            "name": "ExpensePoolLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/TransactionTypeLOV",
            "name": "TransactionTypeLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/TransactionFlowLOV",
            "name": "TransactionFlowLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CostOrganizationLOV",
            "name": "CostOrganizationLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CostBookLOV",
            "name": "CostBookLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/TransactionGroupLOV",
            "name": "TransactionGroupLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/InventoryOrganizationLOV",
            "name": "InventoryOrganizationLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/ItemLOV",
            "name": "ItemLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/AbsorptionTypeLOV",
            "name": "AbsorptionTypeLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/lov/CostElementGroupLOV",
            "name": "CostElementGroupLOV",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://server/fscmRestApi/resources/version/costAccountingOverheadRules/300100549680658/child/OverheadRuleDetails",
            "name": "OverheadRuleDetails",
            "kind": "collection"
        }
    ]
}

Back to Top