Get all payment groups
get
/fscmRestApi/resources/11.13.18.05/publicSectorPaymentGroups
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: The unique identifier for the payment group.
Finder Variables:- PaymentHistoryKey; integer; The unique identifier for the payment transaction.
- simpleSearchFinder: Finds the payment groups that match the primary key criteria specified.
Finder Variables:- value; string; Finds the payment groups that match the primary key criteria specified.
- PrimaryKey: The unique identifier for the payment group.
-
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:- AgencyId; integer; The unique identifier of the agency associated with the payment group.
- AmountDue; number; The total payment amount due that is the sum total of the amounts on the payment history lines.
- BusinessEntityDbaName; string; Doing business as name of the business making the payment.
- BusinessEntityName; string; The entity name of the business making the payment.
- BusinessEntityPartyId; integer; The unique identifier for the business entity party associated with this transaction.
- BusinessProfileId; integer; The unique identifier for the profile of the business entity associated with this transaction.
- Classification; string; The source application that generated the fee.
- CreditAmountApplied; number; The amount of the credit applied to the payment.
- ItemCurrency; string; The currency code for the total payment amount.
- ItemUnitPrice; number; The base price of the item being paid for by the payment transaction.
- PartyId; integer; The unique identifier for the party associated with this payment group.
- PayerAddress; string; The address of the person who made the payment.
- PayerFirstName; string; The first name of the payer for a payment transaction.
- PayerLastName; string; The last name of the payer for a payment transaction.
- PayerName; string; The name of the person who made the payment.
- PaymentAmount; number; The total payment amount authorized and settled by the payment gateway or verified by the trust account system.
- PaymentDate; string; The date on which the group of payment transactions occurred.
- PaymentHistoryKey; integer; The unique identifier for the payment group.
- PaymentMethod; string; Identifies the meaning that is associated with the payment method value.
- PaymentMethodCode; string; The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check.
- PaymentReferenceId; string; A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer.
- PaymentStatus; string; Indicates the status of the payment.
- PaymentStatusDesc; string; Describes the payment status.
- PaymentTransactionId; string; The unique identifier of the transaction that is received from the payment gateway or from the trust account system.
- ProfileId; integer; The unique identifier for the profile of the user associated with this payment group.
- RecordId; string; The source application's record identifier.
- RecordType; string; The source application's record type.
- RecordTypeId; string; The source application's record type identifier.
- ReversalTransTypeDesc; string; Describes the reversal transaction type.
- ReversalTransactionType; string; Indicates the type of reversal transaction.
- TrustAccountNumber; string; An attribute that identifies the deposit account number.
-
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 TopResponse
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.
Root Schema : publicSectorPaymentGroups
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorPaymentGroups-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Read Only:
true
The unique identifier of the agency associated with the payment group. -
AmountDue: number
Read Only:
true
The total payment amount due that is the sum total of the amounts on the payment history lines. -
BusinessEntityDbaName: string
Read Only:
true
Maximum Length:100
Doing business as name of the business making the payment. -
BusinessEntityName: string
Read Only:
true
Maximum Length:100
The entity name of the business making the payment. -
BusinessEntityPartyId: integer
(int64)
Read Only:
true
The unique identifier for the business entity party associated with this transaction. -
BusinessProfileId: integer
(int64)
Read Only:
true
The unique identifier for the profile of the business entity associated with this transaction. -
Classification: string
Read Only:
true
Maximum Length:3
The source application that generated the fee. -
CreditAmountApplied: number
Read Only:
true
The amount of the credit applied to the payment. -
ItemCurrency: string
Read Only:
true
Maximum Length:3
The currency code for the total payment amount. -
ItemUnitPrice: number
Read Only:
true
The base price of the item being paid for by the payment transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier for the party associated with this payment group. -
PayerAddress: string
Read Only:
true
Maximum Length:240
The address of the person who made the payment. -
PayerFirstName: string
Read Only:
true
Maximum Length:150
The first name of the payer for a payment transaction. -
PayerLastName: string
Read Only:
true
Maximum Length:150
The last name of the payer for a payment transaction. -
PayerName: string
Read Only:
true
Maximum Length:100
The name of the person who made the payment. -
PaymentAmount: number
Read Only:
true
The total payment amount authorized and settled by the payment gateway or verified by the trust account system. -
PaymentDate: string
(date)
Read Only:
true
The date on which the group of payment transactions occurred. -
PaymentHistoryKey: integer
Read Only:
true
The unique identifier for the payment group. -
PaymentMethod: string
Read Only:
true
Maximum Length:80
Identifies the meaning that is associated with the payment method value. -
PaymentMethodCode: string
Read Only:
true
Maximum Length:30
The method of payment used for a payment transaction, such as credit card, cash, personal check, or cashier???s check. -
PaymentReferenceId: string
Read Only:
true
Maximum Length:50
A reference value created by the payment module and sent as pass through data to the payment processor, trust account, and cash drawer. -
PaymentStatus: string
Read Only:
true
Maximum Length:30
Indicates the status of the payment. -
PaymentStatusDesc: string
Read Only:
true
Maximum Length:80
Describes the payment status. -
PaymentTransactionId: string
Read Only:
true
Maximum Length:50
The unique identifier of the transaction that is received from the payment gateway or from the trust account system. -
ProfileId: integer
(int64)
Read Only:
true
The unique identifier for the profile of the user associated with this payment group. -
RecordId: string
Read Only:
true
Maximum Length:50
The source application's record identifier. -
RecordType: string
Read Only:
true
Maximum Length:100
The source application's record type. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
The source application's record type identifier. -
ReversalTransactionType: string
Read Only:
true
Maximum Length:30
Indicates the type of reversal transaction. -
ReversalTransTypeDesc: string
Read Only:
true
Maximum Length:80
Describes the reversal transaction type. -
TrustAccountNumber: string
Read Only:
true
Maximum Length:30
An attribute that identifies the deposit account number.
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.