Jump to

• Request
• Response

Get all journal headers

get

/fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • simpleSearchFinder: Find the journal with the specified Accounting Event ID, Accounting Rule ID, Accounting Rule Group ID, or Batch Request ID. Finder Variables:
    • value; string; Accounting Event ID or Accounting Rule ID or Accounting Rule Group ID or Batch Request ID.
  • PrimaryKey: Finds the journal that matches the primary key criteria specified. Finder Variables:
    • JeHeaderId; integer; The unique identifier of the journal header.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorJournalHeaders

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorJournalHeaders-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorJournalHeaders-item

{
    "items":{
        "$ref":"#/definitions/publicSectorJournalHeaders-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorJournalHeaders-item

Type: object

Show Source

• AccountingDate(optional): string(date-time)
  Title: Accounting Date

  The date the associated accounting transaction took place. Normally inherited from the transaction but can modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.
• AccountingEventId(optional): string
  Title: Accounting Event

  Maximum Length: 30

  The unique identifier of the accounting event associated with the journal. Identifies a specific type of transaction for which accounting journals are required. Mandatory system-maintained value.
• AccountingRuleGroup(optional): string
  Title: Accounting Rule Group

  Maximum Length: 50

  Accounting Rule Group, if any, associated with this journal. Inherited from the accounting rule.
• AccountingRuleId(optional): string
  Title: Accounting Rule

  Maximum Length: 50

  The unique identifier of the accounting rule associated with the journal. Describes how accounting journal entries are to be created for a specific type of transaction. Mandatory system-maintained value.
• AdjustmentJournal(optional): string
  Maximum Length: 1

  Indicates whether the journal is an adjustment journal. N (No) is currently the only accepted value.
• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with the journal. Value is mandatory and is set programmatically based on the user's login.
• BatchRequestId(optional): string
  Title: Batch Request

  Maximum Length: 30

  Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process.
• ErpBatchId(optional): string
  Maximum Length: 30

  Currently not used.
• EventLineId(optional): integer(int64)
  The unique identifier for the accounting transaction (event line). Inherited from the transaction.
• JeHeaderId(optional): integer(int64)
  Title: Journal ID

  The unique identifier of the journal. Value is mandatory and is system-generated when the journal is created.
• JeHeaderStatus(optional): string
  Title: Journal Status

  Maximum Length: 1

  Current status of this journal. Mandatory system-maintained value. Accepted values are C (Created), E (Error), V (Valid) and S (exported to file).
• JournalDescription(optional): string
  Maximum Length: 500

  User entered description for the journal.
• LedgerId(optional): string
  Title: Ledger

  Maximum Length: 30

  The unique identifier of the ledger the journal is associated with. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value.
• links(optional): array Items
  Title: Items

  Link Relations
• TotalLines(optional): integer(int32)
  Total detail lines in this journal. Mandatory system-generated count of total lines in the journal.

{
    "properties":{
        "AccountingDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the associated accounting transaction took place. Normally inherited from the transaction but can modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.",
            "title":"Accounting Date"
        },
        "AccountingEventId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the accounting event associated with the journal. Identifies a specific type of transaction for which accounting journals are required. Mandatory system-maintained value.",
            "title":"Accounting Event"
        },
        "AccountingRuleGroup":{
            "maxLength":50,
            "type":"string",
            "description":"Accounting Rule Group, if any, associated with this journal. Inherited from the accounting rule.",
            "title":"Accounting Rule Group"
        },
        "AccountingRuleId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the accounting rule associated with the journal. Describes how accounting journal entries are to be created for a specific type of transaction. Mandatory system-maintained value.",
            "title":"Accounting Rule"
        },
        "AdjustmentJournal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the journal is an adjustment journal. N (No) is currently the only accepted value."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the journal. Value is mandatory and is set programmatically based on the user's login."
        },
        "BatchRequestId":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process.",
            "title":"Batch Request"
        },
        "ErpBatchId":{
            "maxLength":30,
            "type":"string",
            "description":"Currently not used."
        },
        "EventLineId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the accounting transaction (event line). Inherited from the transaction."
        },
        "JeHeaderId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the journal. Value is mandatory and is system-generated when the journal is created.",
            "title":"Journal ID"
        },
        "JeHeaderStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Current status of this journal. Mandatory system-maintained value. Accepted values are C (Created), E (Error), V (Valid) and S (exported to file).",
            "title":"Journal Status"
        },
        "JournalDescription":{
            "maxLength":500,
            "type":"string",
            "description":"User entered description for the journal."
        },
        "LedgerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the ledger the journal is associated with. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value.",
            "title":"Ledger"
        },
        "TotalLines":{
            "format":"int32",
            "type":"integer",
            "description":"Total detail lines in this journal. Mandatory system-generated count of total lines in the journal."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top