Jump to

• Request
• Response

Get all accounting transactions

get

/fscmRestApi/resources/11.13.18.05/publicSectorEventTransactionLines

Request

Query Parameters

• 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
• 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:
  
  

  • PrimaryKey: Finds the accounting transaction that matches the specified primary key criteria.
    Finder Variables:
    • EventLineId; integer; The unique identifier for the accounting transaction.
  • simpleSearchFinder: Finds the accounting transaction (event line) that matches the specified value.
    Finder Variables:
    • value; string; The unique identifier for the accounting transaction.
• 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.
• 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
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccountPurpose; string; Indicates the purpose of the deposit account used to charge the transaction.
  • AccountType; string; Indicates the type of deposit account used to charge the transaction.
  • AccountingDate; string; The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application.
  • AccountingEventId; string; Indicates the accounting event the rule is associated with.
  • AgencyId; integer; The unique identifier of the agency associated with the accounting transaction. Value is mandatory and is supplied by the calling application.
  • BatchRequestId; string; Unique identifier assigned by the system to facilitate the Generate Accounting process.
  • BusinessFunctionId; string; Identifies a specific agency business activity that is also referenced on the applicable accounting event for the transaction.
  • Classification; string; Indicates the the product offering associated with the transaction.
  • CreatedBy; string; The user who created the accounting transaction.
  • CreationDate; string; The date and time that the accounting transaction was created.
  • CurrencyCode; string; The currency that the transaction amount is stated in. Value is mandatory and is supplied by the calling application.
  • EventId; integer; Indicates the unique identifier of the event.
  • EventLineId; integer; The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.
  • EventLineStatus; string; The status of the accounting transaction. Accepted values are C (Created) and G (Journal Generated). Transactions begin in a C status and move to a G status once an accounting journal has been generated.
  • FeeItemId; string; The fee item associated with the accounting transaction. Value is mandatory if Fee Item Id is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
  • IssueSubtypeId; string; Indicates the unique identifier of the issue subtype.
  • LastUpdateDate; string; The date and time that the accounting transaction was last updated.
  • LastUpdatedBy; string; The user who last updated the accounting transaction.
  • PaymentMethodCode; string; Indicates the method of payment used in the payment transaction.
  • PaymentReferenceId; string; Indicates the payment reference ID associated with the transaction.
  • RefundMethodCode; string; Indicates the refund payment method associated with the transaction.
  • RefundReasonCode; string; Indicates the refund reason associated with the transaction.
  • RefundReferenceId; string; Indicates the refund reference ID associated with the transaction.
  • ReversalReasonCd; string; Indicates the reversal reason associated with the transaction.
  • ReversalTranType; string; Indicates the type of transaction. Usually it is the record type associated with the transaction.
  • RuleClassification; string; Indicates the type of accounting entry to be generated including the source transaction table.
  • SourceName; string; The name of the application table that contains the source transaction which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
  • TransAmount; number; The amount of the accounting transaction. Value is mandatory and is supplied by the calling application.
  • TransactionId; integer; The unique identifier of the source transaction on the source application table which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
  • TransactionType; string; The type of transaction or business activity the accounting transaction represents. Value is mandatory if Transaction Type is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
  • TrustAccountNumber; string; Indicates the deposit account used to charge the transaction.
• 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".

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 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 : publicSectorEventTransactionLines

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorEventTransactionLines-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorEventTransactionLines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorEventTransactionLines-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 : publicSectorEventTransactionLines-item-response

Type: object

Show Source

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

  The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application.
• AccountingEventId: string
  Title: Accounting Event

  Maximum Length: 30

  Indicates the accounting event the rule is associated with.
• AccountPurpose: string
  Title: Deposit Account Purpose

  Maximum Length: 30

  Indicates the purpose of the deposit account used to charge the transaction.
• AccountType: string
  Title: Deposit Account Type

  Maximum Length: 30

  Indicates the type of deposit account used to charge the transaction.
• AgencyId: integer (int32)
  Title: Agency ID

  The unique identifier of the agency associated with the accounting transaction. Value is mandatory and is supplied by the calling application.
• BatchRequestId: string
  Maximum Length: 30

  Unique identifier assigned by the system to facilitate the Generate Accounting process.
• BusinessFunctionId: string
  Title: Business Function

  Maximum Length: 30

  Identifies a specific agency business activity that is also referenced on the applicable accounting event for the transaction.
• Classification: string
  Title: Classification

  Maximum Length: 7

  Indicates the the product offering associated with the transaction.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the accounting transaction.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the accounting transaction was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The currency that the transaction amount is stated in. Value is mandatory and is supplied by the calling application.
• EventId: integer (int64)
  Indicates the unique identifier of the event.
• EventLineId: integer (int64)
  The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.
• EventLineStatus: string
  Title: Status

  Maximum Length: 1

  Default Value: C

  The status of the accounting transaction. Accepted values are C (Created) and G (Journal Generated). Transactions begin in a C status and move to a G status once an accounting journal has been generated.
• FeeItemId: string
  Title: Fee Item ID

  Maximum Length: 30

  The fee item associated with the accounting transaction. Value is mandatory if Fee Item Id is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
• IssueSubtypeId: string
  Title: Issue Subtype

  Maximum Length: 50

  Indicates the unique identifier of the issue subtype.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the accounting transaction was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the accounting transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PaymentMethodCode: string
  Title: Payment Method

  Maximum Length: 30

  Indicates the method of payment used in the payment transaction.
• PaymentReferenceId: string
  Title: Payment Reference ID

  Maximum Length: 50

  Indicates the payment reference ID associated with the transaction.
• RefundMethodCode: string
  Title: Refund Method

  Maximum Length: 30

  Indicates the refund payment method associated with the transaction.
• RefundReasonCode: string
  Title: Refund Reason

  Maximum Length: 20

  Indicates the refund reason associated with the transaction.
• RefundReferenceId: string
  Title: Refund Reference ID

  Maximum Length: 50

  Indicates the refund reference ID associated with the transaction.
• ReversalReasonCd: string
  Title: Reversal Reason

  Maximum Length: 30

  Indicates the reversal reason associated with the transaction.
• ReversalTranType: string
  Title: Reversal Transaction Type

  Maximum Length: 30

  Indicates the type of transaction. Usually it is the record type associated with the transaction.
• RuleClassification: string
  Title: Event Type

  Maximum Length: 50

  Indicates the type of accounting entry to be generated including the source transaction table.
• SourceName: string
  Title: Source Table

  Maximum Length: 30

  The name of the application table that contains the source transaction which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
• TransactionId: integer (int64)
  Title: Transaction ID

  The unique identifier of the source transaction on the source application table which supports the accounting transaction. Value is mandatory and is supplied by the calling application.
• TransactionType: string
  Title: Transaction Type

  Maximum Length: 50

  The type of transaction or business activity the accounting transaction represents. Value is mandatory if Transaction Type is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.
• TransAmount: number
  Title: Transaction Amount

  The amount of the accounting transaction. Value is mandatory and is supplied by the calling application.
• TrustAccountNumber: string
  Title: Deposit Account Number

  Maximum Length: 30

  Indicates the deposit account used to charge the transaction.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the accounting transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundMethodCode":{
            "title":"Refund Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the refund payment method associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"50",
            "type":"string",
            "description":"The type of transaction or business activity the accounting transaction represents. Value is mandatory if Transaction Type is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AccountingDate":{
            "title":"Accounting Date",
            "type":"string",
            "description":"The date that the accounting transaction occurred. Value is mandatory and is supplied by the calling application.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessFunctionId":{
            "title":"Business Function",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies a specific agency business activity that is also referenced on the applicable accounting event for the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "EventLineStatus":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"The status of the accounting transaction. Accepted values are C (Created) and G (Journal Generated).  Transactions begin in a C status and move to a G status once an accounting journal has been generated.",
            "nullable":false,
            "default":"C",
            "x-queryable":true
        },
        "IssueSubtypeId":{
            "title":"Issue Subtype",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the unique identifier of the issue subtype.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The currency that the transaction amount is stated in. Value is mandatory and is supplied by the calling application.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentReferenceId":{
            "title":"Payment Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the payment reference ID associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item ID",
            "maxLength":"30",
            "type":"string",
            "description":"The fee item associated with the accounting transaction. Value is mandatory if Fee Item Id is defined as required on PSC_ERP_ACCT_EVENT_FIELD_B.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountingEventId":{
            "title":"Accounting Event",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the accounting event the rule is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "ReversalReasonCd":{
            "title":"Reversal Reason",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the reversal reason associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"7",
            "type":"string",
            "description":"Indicates the the product offering associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReasonCode":{
            "title":"Refund Reason",
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the refund reason associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Indicates the unique identifier of the event.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TrustAccountNumber":{
            "title":"Deposit Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the deposit account used to charge the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceName":{
            "title":"Source Table",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the application table that contains the source transaction which supports the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleClassification":{
            "title":"Event Type",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the type of accounting entry to be generated including the source transaction table.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethodCode":{
            "title":"Payment Method",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the method of payment used in the payment transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RefundReferenceId":{
            "title":"Refund Reference ID",
            "maxLength":"50",
            "type":"string",
            "description":"Indicates the refund reference ID associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountType":{
            "title":"Deposit Account Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of deposit account used to charge the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the source transaction on the source application table which supports the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventLineId":{
            "type":"integer",
            "description":"The unique identifier for the accounting transaction (event line). Value is mandatory and is system-generated during a create action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReversalTranType":{
            "title":"Reversal Transaction Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the type of transaction. Usually it is the record type associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchRequestId":{
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier assigned by the system to facilitate the Generate Accounting process.",
            "nullable":true,
            "x-queryable":true
        },
        "TransAmount":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"The amount of the accounting transaction. Value is mandatory and is supplied by the calling application.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountPurpose":{
            "title":"Deposit Account Purpose",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the purpose of the deposit account used to charge the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the accounting transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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