Get a journal header
get
/fscmRestApi/resources/11.13.18.05/publicSectorJournalHeaders/{JeHeaderId}
Request
Path Parameters
-
JeHeaderId(required): integer(int64)
The unique identifier of a journal. Mandatory system-generated number.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorJournalHeaders-item-response
Type:
Show Source
object
-
AccountingDate: string
(date-time)
Title:
Accounting Date
The accounting date for the journal. Mandatory system maintained date. The date is usually inherited from the transaction, but can be a later date if the transaction date falls on a closed accounting period. -
AccountingEventId: string
Title:
Accounting Event
Maximum Length:30
Accounting Event identifier associated with this journal. Accounting Event points to the type of transactions that the journal is created for. -
AccountingRuleGroup: string
Title:
Accounting Rule Group
Maximum Length:50
Accounting Rule Group, if any, associated with this journal. -
AccountingRuleId: string
Title:
Accounting Rule
Maximum Length:50
Accounting Rule identifier associated with this journal. Accounting Rule decides how accounting entries are allocated from certain type of transactions. -
AdjustmentJournal: string
Maximum Length:
1
Adjustment Journal indicator. Mandatory Yes No flag. -
AgencyId: integer
(int32)
Agency identifier associated with this journal. Mandatory, as each journal must be under one Agency.
-
BatchRequestId: string
Title:
Batch Request
Maximum Length:30
Batch request ID that created or updated this journal. -
ErpBatchId: string
Maximum Length:
30
Batch request ID for transmitting into ERP. -
EventId: integer
(int64)
Accounting Event identifier associated with this journal.
-
EventLineId: integer
(int64)
Accounting Event identifier associated with this journal.
-
JeHeaderId: integer
(int64)
Title:
Journal ID
The unique identifier of a journal. Mandatory system-generated number. -
JeHeaderStatus: string
Title:
Journal Status
Maximum Length:1
Current status of this journal. Mandatory system-maintained value. -
JournalDescription: string
Title:
Description
Maximum Length:500
User entered description for a journal. -
LedgerId: string
Title:
Ledger
Maximum Length:30
Ledger this journal in intended for. Mandatory system-maintained value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TotalLines: integer
(int32)
Total detail lines in this journal. Mandatory system-generated count of total lines in a journal.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.