Jump to

• Request
• Response

Update a journal line

patch

/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails/{publicSectorJournalLineDetailsUniqID}

Request

Path Parameters

• publicSectorJournalLineDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Journal Line Details resource and used to uniquely identify an instance of Journal Line Details. The client should not generate the hash key value. Instead, the client should query on the Journal Line Details collection resource in order to navigate to a specific instance of Journal Line Details to get the hash key.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccountId: string
  Title: Account

  Maximum Length: 30

  The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule.
• DivisionId: string
  Title: Division

  Maximum Length: 30

  The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule.
• FunctionId: string
  Title: Function

  Maximum Length: 30

  The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.
• FundId: string
  Title: Fund

  Maximum Length: 30

  The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
• JeLineStatus: string
  Title: Line Status

  Maximum Length: 1

  Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid).
• ObjectVersionNumber: integer (int32)
  Tracks the number of updates to the journal line. Mandatory system-maintained value.
• ProgramId: string
  Title: Program

  Maximum Length: 30

  A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.

{
    "type":"object",
    "properties":{
        "FunctionId":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true
        },
        "AccountId":{
            "title":"Account",
            "maxLength":"30",
            "type":"string",
            "description":"The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Tracks the number of updates to the journal line. Mandatory system-maintained value.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "FundId":{
            "title":"Fund",
            "maxLength":"30",
            "type":"string",
            "description":"The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.",
            "nullable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true
        },
        "ProgramId":{
            "title":"Program",
            "maxLength":"30",
            "type":"string",
            "description":"A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true
        },
        "DivisionId":{
            "title":"Division",
            "maxLength":"30",
            "type":"string",
            "description":"The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true
        },
        "JeLineStatus":{
            "title":"Line Status",
            "maxLength":"1",
            "type":"string",
            "description":"Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid).",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AccountedCr: number
  Entered credit amount stated in the base currency of the ledger. Currently equal to entered credit amount.
• AccountedDr: number
  Entered debit amount stated in the base currency of the ledger. Currently equal to entered debit amount.
• AccountId: string
  Title: Account

  Maximum Length: 30

  The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
• AccountingDate: string (date-time)
  The date the associated accounting transaction took place. Normally inherited from the transaction, but can be modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.
• AccountingEventId: string
  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.
• AccountingRuleId: string
  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.
• AgencyId: 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.
• BaseCurrency: string
  Maximum Length: 3

  The currency that the accounted debit or accounted credit amount is stated in. Value is mandatory and is inherited from the ledger associated with the journal.
• BatchRequestId: string
  Maximum Length: 30

  Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The currency that the entered debit or entered credit amount is stated in. Value is mandatory and is inherited from the accounting transaction.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule.
• DivisionId: string
  Title: Division

  Maximum Length: 30

  The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule.
• EnteredCr: number
  Title: Credit Amount

  Entered credit amount that is calculated for the line by the system based on the associated accounting rule.
• EnteredDr: number
  Title: Debit Amount

  Entered debit amount that is calculated for the line by the system based on the associated accounting rule.
• FunctionId: string
  Title: Function

  Maximum Length: 30

  The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.
• FundId: string
  Title: Fund

  Maximum Length: 30

  The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
• JeLineId: integer (int64)
  Title: Journal Line ID

  The unique identifier of the journal line. Mandatory system-generated number.
• JeLineStatus: string
  Title: Line Status

  Maximum Length: 1

  Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid).
• JournalSumLineId: integer (int64)
  Currently not used. Set to 1.
• LedgerId: string
  Maximum Length: 30

  The unique identifier of the ledger associated with the journal. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value.
• LineNumber: integer (int32)
  Title: Line Number

  System-generated line number, starting from 1, within a journal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Tracks the number of updates to the journal line. Mandatory system-maintained value.
• ProgramId: string
  Title: Program

  Maximum Length: 30

  A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.

{
    "type":"object",
    "properties":{
        "FunctionId":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "maxLength":"30",
            "type":"string",
            "description":"The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "JournalSumLineId":{
            "type":"integer",
            "description":"Currently not used. Set to 1.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LedgerId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the ledger associated with the journal. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountedCr":{
            "type":"number",
            "description":"Entered credit amount stated in the base currency of the ledger. Currently equal to entered credit amount.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"The date the associated accounting transaction took place. Normally inherited from the transaction, but can be modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "AccountedDr":{
            "type":"number",
            "description":"Entered debit amount stated in the base currency of the ledger. Currently equal to entered debit amount.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramId":{
            "title":"Program",
            "maxLength":"30",
            "type":"string",
            "description":"A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DivisionId":{
            "title":"Division",
            "maxLength":"30",
            "type":"string",
            "description":"The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"System-generated line number, starting from 1, within a journal.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "EnteredDr":{
            "title":"Debit Amount",
            "type":"number",
            "description":"Entered debit amount that is calculated for the line by the system based on the associated accounting rule.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency that the entered debit or entered credit amount is stated in. Value is mandatory and is inherited from the accounting transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "EnteredCr":{
            "title":"Credit Amount",
            "type":"number",
            "description":"Entered credit amount that is calculated for the line by the system based on the associated accounting rule.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Tracks the number of updates to the journal line. Mandatory system-maintained value.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "FundId":{
            "title":"Fund",
            "maxLength":"30",
            "type":"string",
            "description":"The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency that the accounted debit or accounted credit amount is stated in. Value is mandatory and is inherited from the ledger associated with the journal.",
            "nullable":false,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule.",
            "nullable":true,
            "x-queryable":true
        },
        "JeLineId":{
            "title":"Journal Line ID",
            "type":"integer",
            "description":"The unique identifier of the journal line. Mandatory system-generated number.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JeLineStatus":{
            "title":"Line Status",
            "maxLength":"1",
            "type":"string",
            "description":"Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid).",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : 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."
        }
    }
}

Back to Top