Jump to

• Request
• Response

Update an accounting hub application

patch

/fscmRestApi/resources/11.13.18.05/accountingHubApplications/{ApplicationId}

Request

Path Parameters

• ApplicationId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowReversalsFlag: boolean
  Title: Support transaction reversal

  Maximum Length: 1

  Default Value: false

  Indicates whether transaction reversal is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• ApplicationDescription: string
  Maximum Length: 256

  A brief description of the accounting hub application.
• AutomaticallyDeleteInvalidTransactionsFlag: boolean
  Title: Automatically delete invalid transactions

  Maximum Length: 1

  Default Value: false

  Indicates whether automatic deletion of invalid transactions is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• MaintainSupportingReferenceBalancesFlag: boolean
  Title: Maintain Supporting Reference Balances

  Maximum Length: 1

  Default Value: true

  Indicates whether the maintain supporting reference option is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• ProcessCategories: array Process Categories
  Title: Process Categories

  A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.
• TransferToPeoplesoft: string
  Title: Transfer To

  Maximum Length: 1

  Indicates the general ledger application to which subledger accounting entries for the accounting hub application are transferred. Valid values are Y for Transfer to Oracle PeopleSoft General Ledger, N for Transfer to Oracle Fusion General Ledger, and E for Transfer to Oracle E-Business Suite General Ledger.
• ValuationMethodFlag: boolean
  Title: Support multiple valuation methods

  Maximum Length: 1

  Default Value: false

  Indicates whether the valuation method is enabled for the accounting hub application. Valid values are Y for Yes and N for No

{
    "type":"object",
    "properties":{
        "AllowReversalsFlag":{
            "title":"Support transaction reversal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether transaction reversal is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":false
        },
        "ApplicationDescription":{
            "maxLength":256,
            "type":"string",
            "description":"A brief description of the accounting hub application.",
            "nullable":true
        },
        "AutomaticallyDeleteInvalidTransactionsFlag":{
            "title":"Automatically delete invalid transactions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automatic deletion of invalid transactions is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":false
        },
        "MaintainSupportingReferenceBalancesFlag":{
            "title":"Maintain Supporting Reference Balances",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the maintain supporting reference option is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":true
        },
        "ProcessCategories":{
            "title":"Process Categories",
            "type":"array",
            "description":"A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-item-patch-request"
            }
        },
        "TransferToPeoplesoft":{
            "title":"Transfer To",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the general ledger application to which subledger accounting entries for the accounting hub application are transferred. Valid values are Y for Transfer to Oracle PeopleSoft General Ledger, N for Transfer to Oracle Fusion General Ledger, and E for Transfer to Oracle E-Business Suite General Ledger.",
            "nullable":true
        },
        "ValuationMethodFlag":{
            "title":"Support multiple valuation methods",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the valuation method is enabled for the accounting hub application. Valid values are Y for Yes and N for No",
            "nullable":false,
            "default":false
        }
    }
}

Nested Schema : Process Categories

Type: array

Title: Process Categories

A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-item-patch-request

{
    "title":"Process Categories",
    "type":"array",
    "description":"A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-item-patch-request"
    }
}

Nested Schema : accountingHubApplications-ProcessCategories-item-patch-request

Type: object

Show Source

• EventClasses: array Event Classes
  Title: Event Classes

  An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.
• ProcessCategoryDescription: string
  Title: Description

  Maximum Length: 240

  A brief description of the process category.
• ProcessCategoryName: string
  Title: Name

  Maximum Length: 80

  Name of the process category.

{
    "type":"object",
    "properties":{
        "EventClasses":{
            "title":"Event Classes",
            "type":"array",
            "description":"An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-item-patch-request"
            }
        },
        "ProcessCategoryDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the process category.",
            "nullable":true
        },
        "ProcessCategoryName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the process category.",
            "nullable":false
        }
    }
}

Nested Schema : Event Classes

Type: array

Title: Event Classes

An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-EventClasses-item-patch-request

{
    "title":"Event Classes",
    "type":"array",
    "description":"An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-item-patch-request"
    }
}

Nested Schema : accountingHubApplications-ProcessCategories-EventClasses-item-patch-request

Type: object

Show Source

• CalculateAccountedAmountsFlag: boolean
  Title: Calculate accounted amounts

  Maximum Length: 1

  Default Value: true

  Indicates whether the accounting program calculates accounted amounts for the event class. Valid values are Y for Yes and N for No.
• CalculateGainLossAmountsFlag: boolean
  Title: Calculate gain or loss amounts

  Maximum Length: 1

  Default Value: true

  Indicates whether the accounting program calculates gain or loss amounts for the event class. Valid values are Y for Yes and N for No.
• DefaultUserJournalCategoryName: string
  User journal category name associated with the event class.
• EventClassDescription: string
  Title: Description

  Maximum Length: 255

  A brief description of the event class.
• EventClassName: string
  Title: Name

  Name of the event class.
• EventTypes: array Event Types
  Title: Event Types

  An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.
• GroupSourceDataOnImportFlag: boolean
  Maximum Length: 1

  Indicates whether the group source data on import option is enabled for the event class. Valid values are Y for Yes and N for No.
• UserTransactionIdentifiers: array User Transaction Identifiers
  Title: User Transaction Identifiers

  A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.

{
    "type":"object",
    "properties":{
        "CalculateAccountedAmountsFlag":{
            "title":"Calculate accounted amounts",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the accounting program calculates accounted amounts for the event class. Valid values are Y for Yes and N for No.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"XLA_YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"602"
            }
        },
        "CalculateGainLossAmountsFlag":{
            "title":"Calculate gain or loss amounts",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the accounting program calculates gain or loss amounts for the event class. Valid values are Y for Yes and N for No.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"XLA_YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"602"
            }
        },
        "DefaultUserJournalCategoryName":{
            "type":"string",
            "description":"User journal category name associated with the event class.",
            "nullable":true,
            "x-queryable":false
        },
        "EventClassDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the event class.",
            "nullable":true,
            "x-queryable":false
        },
        "EventClassName":{
            "title":"Name",
            "type":"string",
            "description":"Name of the event class.",
            "nullable":false,
            "x-queryable":false
        },
        "EventTypes":{
            "title":"Event Types",
            "type":"array",
            "description":"An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-EventTypes-item-patch-request"
            }
        },
        "GroupSourceDataOnImportFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the group source data on import option is enabled for the event class. Valid values are Y for Yes and N for No.",
            "nullable":true
        },
        "UserTransactionIdentifiers":{
            "title":"User Transaction Identifiers",
            "type":"array",
            "description":"A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-patch-request"
            }
        }
    }
}

Nested Schema : Event Types

Type: array

Title: Event Types

An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.

Show Source

• Array of: object schema

{
    "title":"Event Types",
    "type":"array",
    "description":"An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-EventTypes-item-patch-request"
    }
}

Nested Schema : User Transaction Identifiers

Type: array

Title: User Transaction Identifiers

A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.

Show Source

• Array of: object schema

{
    "title":"User Transaction Identifiers",
    "type":"array",
    "description":"A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• EventTypeDescription: string
  Title: Description

  Maximum Length: 240

  A brief description of the event type.
• EventTypeName: string
  Title: Name

  Maximum Length: 80

  Name of the event type.

{
    "type":"object",
    "properties":{
        "EventTypeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the event type.",
            "nullable":true
        },
        "EventTypeName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the event type.",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ColumnName: string
  Title: View Column

  Maximum Length: 30

  Table or view column name in which the user transaction identifier is stored.
• ColumnTitle: string
  Title: Identifier

  Maximum Length: 80

  Name of the user transaction identifier.

{
    "type":"object",
    "properties":{
        "ColumnName":{
            "title":"View Column",
            "maxLength":30,
            "type":"string",
            "description":"Table or view column name in which the user transaction identifier is stored.",
            "nullable":false
        },
        "ColumnTitle":{
            "title":"Identifier",
            "maxLength":80,
            "type":"string",
            "description":"Name of the user transaction identifier.",
            "nullable":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 : accountingHubApplications-item-response

Type: object

Show Source

• AllowReversalsFlag: boolean
  Title: Support transaction reversal

  Maximum Length: 1

  Default Value: false

  Indicates whether transaction reversal is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• ApplicationDescription: string
  Maximum Length: 256

  A brief description of the accounting hub application.
• ApplicationId: integer (int64)
  The unique identifier of the accounting hub application.
• ApplicationName: string
  Maximum Length: 4000

  Name of the accounting hub application.
• ApplicationShortName: string
  Title: Short Name

  Maximum Length: 4000

  Short name of the accounting hub application.
• AutomaticallyDeleteInvalidTransactionsFlag: boolean
  Title: Automatically delete invalid transactions

  Maximum Length: 1

  Default Value: false

  Indicates whether automatic deletion of invalid transactions is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaintainSupportingReferenceBalancesFlag: boolean
  Title: Maintain Supporting Reference Balances

  Maximum Length: 1

  Default Value: true

  Indicates whether the maintain supporting reference option is enabled for the accounting hub application. Valid values are Y for Yes and N for No.
• ProcessCategories: array Process Categories
  Title: Process Categories

  A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.
• TransferToPeoplesoft: string
  Title: Transfer To

  Maximum Length: 1

  Indicates the general ledger application to which subledger accounting entries for the accounting hub application are transferred. Valid values are Y for Transfer to Oracle PeopleSoft General Ledger, N for Transfer to Oracle Fusion General Ledger, and E for Transfer to Oracle E-Business Suite General Ledger.
• ValuationMethodFlag: boolean
  Title: Support multiple valuation methods

  Maximum Length: 1

  Default Value: false

  Indicates whether the valuation method is enabled for the accounting hub application. Valid values are Y for Yes and N for No

{
    "type":"object",
    "properties":{
        "AllowReversalsFlag":{
            "title":"Support transaction reversal",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether transaction reversal is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ApplicationDescription":{
            "maxLength":256,
            "type":"string",
            "description":"A brief description of the accounting hub application.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the accounting hub application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplicationName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the accounting hub application.",
            "nullable":false,
            "x-queryable":true
        },
        "ApplicationShortName":{
            "title":"Short Name",
            "maxLength":4000,
            "type":"string",
            "description":"Short name of the accounting hub application.",
            "nullable":false,
            "x-queryable":true
        },
        "AutomaticallyDeleteInvalidTransactionsFlag":{
            "title":"Automatically delete invalid transactions",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether automatic deletion of invalid transactions is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MaintainSupportingReferenceBalancesFlag":{
            "title":"Maintain Supporting Reference Balances",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the maintain supporting reference option is enabled for the accounting hub application. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "ProcessCategories":{
            "title":"Process Categories",
            "type":"array",
            "description":"A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-item-response"
            }
        },
        "TransferToPeoplesoft":{
            "title":"Transfer To",
            "maxLength":1,
            "type":"string",
            "description":"Indicates the general ledger application to which subledger accounting entries for the accounting hub application are transferred. Valid values are Y for Transfer to Oracle PeopleSoft General Ledger, N for Transfer to Oracle Fusion General Ledger, and E for Transfer to Oracle E-Business Suite General Ledger.",
            "nullable":true,
            "x-queryable":true
        },
        "ValuationMethodFlag":{
            "title":"Support multiple valuation methods",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the valuation method is enabled for the accounting hub application. Valid values are Y for Yes and N for No",
            "nullable":false,
            "default":false,
            "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 : Process Categories

Type: array

Title: Process Categories

A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-item-response

{
    "title":"Process Categories",
    "type":"array",
    "description":"A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-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 : accountingHubApplications-ProcessCategories-item-response

Type: object

Show Source

• ApplicationId: integer (int64)
  The unique identifier of the subledger application.
• EventClasses: array Event Classes
  Title: Event Classes

  An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessCategoryCode: string
  Title: Short Name

  Maximum Length: 30

  Short name of the process category.
• ProcessCategoryDescription: string
  Title: Description

  Maximum Length: 240

  A brief description of the process category.
• ProcessCategoryName: string
  Title: Name

  Maximum Length: 80

  Name of the process category.

{
    "type":"object",
    "properties":{
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the subledger application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventClasses":{
            "title":"Event Classes",
            "type":"array",
            "description":"An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-item-response"
            }
        },
        "ProcessCategoryCode":{
            "title":"Short Name",
            "maxLength":30,
            "type":"string",
            "description":"Short name of the process category.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessCategoryDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the process category.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessCategoryName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the process category.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Event Classes

Type: array

Title: Event Classes

An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-EventClasses-item-response

{
    "title":"Event Classes",
    "type":"array",
    "description":"An event class represents a categorization of related business events in the external source system. An event class groups related event types originating from similar business processes or sharing common accounting rules for subledger accounting.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-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 : accountingHubApplications-ProcessCategories-EventClasses-item-response

Type: object

Show Source

• ApplicationId: integer (int64)
  The unique identifier of the accounting hub application associated with the event class.
• CalculateAccountedAmountsFlag: boolean
  Title: Calculate accounted amounts

  Maximum Length: 1

  Default Value: true

  Indicates whether the accounting program calculates accounted amounts for the event class. Valid values are Y for Yes and N for No.
• CalculateGainLossAmountsFlag: boolean
  Title: Calculate gain or loss amounts

  Maximum Length: 1

  Default Value: true

  Indicates whether the accounting program calculates gain or loss amounts for the event class. Valid values are Y for Yes and N for No.
• DefaultUserJournalCategoryName: string
  User journal category name associated with the event class.
• EventClassCode: string
  Title: Event Class

  Maximum Length: 30

  Short name of the event class.
• EventClassDescription: string
  Title: Description

  Maximum Length: 255

  A brief description of the event class.
• EventClassName: string
  Title: Name

  Name of the event class.
• EventTypes: array Event Types
  Title: Event Types

  An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.
• GroupSourceDataOnImportFlag: boolean
  Maximum Length: 1

  Indicates whether the group source data on import option is enabled for the event class. Valid values are Y for Yes and N for No.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UserTransactionIdentifiers: array User Transaction Identifiers
  Title: User Transaction Identifiers

  A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.

{
    "type":"object",
    "properties":{
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the accounting hub application associated with the event class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateAccountedAmountsFlag":{
            "title":"Calculate accounted amounts",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the accounting program calculates accounted amounts for the event class. Valid values are Y for Yes and N for No.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"XLA_YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"602"
            },
            "x-queryable":true
        },
        "CalculateGainLossAmountsFlag":{
            "title":"Calculate gain or loss amounts",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the accounting program calculates gain or loss amounts for the event class. Valid values are Y for Yes and N for No.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"XLA_YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"602"
            },
            "x-queryable":true
        },
        "DefaultUserJournalCategoryName":{
            "type":"string",
            "description":"User journal category name associated with the event class.",
            "nullable":true,
            "x-queryable":false
        },
        "EventClassCode":{
            "title":"Event Class",
            "maxLength":30,
            "type":"string",
            "description":"Short name of the event class.",
            "nullable":false,
            "x-queryable":true
        },
        "EventClassDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"A brief description of the event class.",
            "nullable":true,
            "x-queryable":false
        },
        "EventClassName":{
            "title":"Name",
            "type":"string",
            "description":"Name of the event class.",
            "nullable":false,
            "x-queryable":false
        },
        "EventTypes":{
            "title":"Event Types",
            "type":"array",
            "description":"An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-EventTypes-item-response"
            }
        },
        "GroupSourceDataOnImportFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the group source data on import option is enabled for the event class. Valid values are Y for Yes and N for No.",
            "nullable":true,
            "x-queryable":true
        },
        "UserTransactionIdentifiers":{
            "title":"User Transaction Identifiers",
            "type":"array",
            "description":"A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.",
            "items":{
                "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Event Types

Type: array

Title: Event Types

An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-EventClasses-EventTypes-item-response

{
    "title":"Event Types",
    "type":"array",
    "description":"An event type represents a specific business event on a transaction that results in an accounting impact. Event types classify accounting events by their fiscal or operational purpose and align them with the appropriate subledger accounting treatment.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-EventTypes-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 : User Transaction Identifiers

Type: array

Title: User Transaction Identifiers

A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.

Show Source

• Array of: object accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-response

{
    "title":"User Transaction Identifiers",
    "type":"array",
    "description":"A user transaction identifier is an optional business friendly identifier for external transactions associated with an event class. User transaction identifiers appear on accounting reports and inquiry pages to trace accounting entries back to their source.",
    "items":{
        "$ref":"#/components/schemas/accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-response"
    }
}

Nested Schema : accountingHubApplications-ProcessCategories-EventClasses-EventTypes-item-response

Type: object

Show Source

• ApplicationId: integer (int64)
  The unique identifier of the accounting hub application associated with the event type.
• EventTypeCode: string
  Title: Short Name

  Maximum Length: 30

  Short name of the event type.
• EventTypeDescription: string
  Title: Description

  Maximum Length: 240

  A brief description of the event type.
• EventTypeName: string
  Title: Name

  Maximum Length: 80

  Name of the event type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the accounting hub application associated with the event type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventTypeCode":{
            "title":"Short Name",
            "maxLength":30,
            "type":"string",
            "description":"Short name of the event type.",
            "nullable":true,
            "x-queryable":true
        },
        "EventTypeDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the event type.",
            "nullable":true,
            "x-queryable":true
        },
        "EventTypeName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the event type.",
            "nullable":false,
            "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 : accountingHubApplications-ProcessCategories-EventClasses-UserTransactionIdentifiers-item-response

Type: object

Show Source

• ApplicationId: integer (int64)
  The unique identifier of the accounting hub application associated with the user transaction identifier.
• ColumnName: string
  Title: View Column

  Maximum Length: 30

  Table or view column name in which the user transaction identifier is stored.
• ColumnTitle: string
  Title: Identifier

  Maximum Length: 80

  Name of the user transaction identifier.
• EventMappingId: integer (int64)
  Read Only: true

  The unique identifier of the event class transaction identifier mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the accounting hub application associated with the user transaction identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ColumnName":{
            "title":"View Column",
            "maxLength":30,
            "type":"string",
            "description":"Table or view column name in which the user transaction identifier is stored.",
            "nullable":false,
            "x-queryable":true
        },
        "ColumnTitle":{
            "title":"Identifier",
            "maxLength":80,
            "type":"string",
            "description":"Name of the user transaction identifier.",
            "nullable":false,
            "x-queryable":true
        },
        "EventMappingId":{
            "type":"integer",
            "description":"The unique identifier of the event class transaction identifier mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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"
    }
}

Links

ProcessCategories

Operation: /fscmRestApi/resources/11.13.18.05/accountingHubApplications/{ApplicationId}/child/ProcessCategories

Parameters:

• ApplicationId: $request.path.ApplicationId

A process category groups related event classes within an accounting hub application that may be processed for accounting together or separately based on timing and workload requirements. Process categories help organize related business events into smaller data sets during accounting processing to support operational requirements.

Back to Top