Get all payment documents for a bank account
get
/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments
Request
Path Parameters
-
BankAccountId(required): integer(int64)
The unique identifier of the bank account.
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 -
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 bank account payment document with the specified primary key.
Finder Variables:- PaymentDocumentId; integer; The unique identifier of the payment document.
- PrimaryKey: Finds the bank account payment document with the specified primary key.
-
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:- AttachedRemittanceStubFlag; boolean; The option that indicates whether attaching remittance stub is allowed. The default value is False.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date and time when the record was created.
- FirstAvailableDocumentNumber; number; The first payment number available on a payment document.
- FormatName; string; The payment format name of the payment document.
- InactiveDate; string; The date when the payment document starts being/ is inactive.
- LastAvailableDocumentNumber; number; The last payment number available on a payment document.
- LastIssuedDocumentNumber; number; The last payment number used on a payment document to pay invoices.
- LastUpdateDate; string; The date and time when the record was last updated.
- LastUpdateLogin; string; The session login associated to the user who last updated the record.
- LastUpdatedBy; string; The user who last updated the record.
- ManualPaymentsOnlyFlag; boolean; The option that indicates whether manual payment is allowed. The default value is False.
- NumberOfLinesPERRemitStub; number; The number of lines allowed per remittance stub.
- NumberOfSetupDocuments; number; The number of documents printed at the beginning of each automatic payment batch.
- PaperStockType; string; The type of the paper stock. Possible values are Blank Stock and Numbered Stock. A list of accepted values is defined in the lookup type CE_PAPER_STOCK_TYPES.
- PaymentDocumentCategory; string; The category of the payment document.
- PaymentDocumentId; integer; The unique identifier of the bank account payment document.
- PaymentDocumentName; string; The name of the payment document.
-
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 : cashBankAccounts-bankAccountPaymentDocuments
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 : cashBankAccounts-bankAccountPaymentDocuments-item-response
Type:
Show Source
object
-
AttachedRemittanceStubFlag: boolean
Title:
Attached remittance stub
Maximum Length:1
Default Value:false
The option that indicates whether attaching remittance stub is allowed. The default value is False. -
bankAccountCheckbooks: array
Bank Account Checkbooks
Title:
Bank Account Checkbooks
The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
FirstAvailableDocumentNumber: number
Title:
First Available Document Number
The first payment number available on a payment document. -
FormatName: string
Title:
Format
Maximum Length:300
The payment format name of the payment document. -
InactiveDate: string
(date)
Title:
End Date
The date when the payment document starts being/ is inactive. -
LastAvailableDocumentNumber: number
Title:
Last Available Document Number
The last payment number available on a payment document. -
LastIssuedDocumentNumber: number
Title:
Last Issued Document Number
Default Value:0
The last payment number used on a payment document to pay invoices. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManualPaymentsOnlyFlag: boolean
Title:
Restrict use to manually issued payments
Maximum Length:1
Default Value:false
The option that indicates whether manual payment is allowed. The default value is False. -
NumberOfLinesPERRemitStub: number
Title:
Number of Lines per Remittance Stub
The number of lines allowed per remittance stub. -
NumberOfSetupDocuments: number
Title:
Number of Setup Documents
The number of documents printed at the beginning of each automatic payment batch. -
PaperStockType: string
Title:
Paper Stock Type
Maximum Length:255
The type of the paper stock. Possible values are Blank Stock and Numbered Stock. A list of accepted values is defined in the lookup type CE_PAPER_STOCK_TYPES. -
PaymentDocumentCategory: string
Title:
Payment Document Category
Maximum Length:255
The category of the payment document. -
PaymentDocumentId: integer
(int64)
The unique identifier of the bank account payment document.
-
PaymentDocumentName: string
Title:
Payment Document
Maximum Length:100
The name of the payment document.
Nested Schema : Bank Account Checkbooks
Type:
array
Title:
Bank Account Checkbooks
The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response
Type:
Show Source
object
-
CheckbookId: integer
(int64)
The unique identifier of the bank account checkbook.
-
CheckbookName: string
Title:
Checkbook
Maximum Length:240
The name of the checkbook. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
DateReceived: string
(date)
Title:
Received Date
The date when the checkbook was received. -
EndNumber: number
Title:
End Number
The ending number of the checkbook. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoOfDocuments: string
Title:
Number of Documents
Read Only:true
The number of documents associated to the checkbook. -
Prefix: string
Title:
Prefix
Maximum Length:30
The prefix used for the checkbook. -
StartNumber: number
Title:
Start Number
The starting number of the checkbook.
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.
Examples
The following example shows how to retrieve all payment documents for a bank account by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://fuscdrmsmc79-fa-ext.us2.oracle.com/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "AttachedRemittanceStubFlag": false, "CreatedBy": "CASH_MANAGER", "CreationDate": "2020-04-21T01:57:59.885+00:00", "FirstAvailableDocumentNumber": 100, "InactiveDate": null, "LastAvailableDocumentNumber": null, "LastIssuedDocumentNumber": 99, "LastUpdateDate": "2020-04-21T01:59:26.324+00:00", "LastUpdateLogin": "A38FC7027DB67485E053D713F50A02D1", "LastUpdatedBy": "CASH_MANAGER", "ManualPaymentsOnlyFlag": false, "NumberOfLinesPERRemitStub": null, "NumberOfSetupDocuments": null, "PaymentDocumentId": 300100196595204, "PaymentDocumentName": "DOCUMENT1", "PaperStockType": "Blank Stock", "FormatName": "Laser Check Format", "PaymentDocumentCategory": null, "links": [ { "rel": "self", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204", "name": "bankAccountPaymentDocuments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204", "name": "bankAccountPaymentDocuments", "kind": "item" }, { "rel": "parent", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495", "name": "cashBankAccounts", "kind": "item" }, { "rel": "lov", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204/lov/PaymentDocCategoryVVOVA", "name": "PaymentDocCategoryVVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204/lov/PaperStockTypeVOVA", "name": "PaperStockTypeVOVA", "kind": "collection" }, { "rel": "lov", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204/lov/FormatPVOVA", "name": "FormatPVOVA", "kind": "collection" }, { "rel": "child", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204/child/bankAccountCheckbooks", "name": "bankAccountCheckbooks", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 500, "offset": 0, "links": [ { "rel": "self", "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments", "name": "bankAccountPaymentDocuments", "kind": "collection" } ] }