Update a journal header
patch
/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.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BatchRequestId: string
Title:
Batch Request
Maximum Length:30
Batch request ID that created or updated this journal. -
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.
Response
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.