Update a payment document for a bank account
patch
/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}
Request
Path Parameters
-
BankAccountId(required): integer(int64)
The unique identifier of the bank account.
-
PaymentDocumentId(required): integer(int64)
The unique identifier of the bank account payment document.
Header Parameters
-
Metadata-Context: string
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: string
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-
AttachedRemittanceStubFlag: boolean
Title:
Attached remittance stubMaximum Length:1Default Value:falseThe option that indicates whether attaching remittance stub is allowed. The default value is False. -
bankAccountCheckbooks: array
Bank Account Checkbooks
Title:
Bank Account CheckbooksThe bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date. -
FirstAvailableDocumentNumber: number
Title:
First Available Document NumberThe first payment number available on a payment document. -
FormatName: string
Title:
FormatMaximum Length:300The payment format name of the payment document. -
InactiveDate: string
(date)
Title:
End DateThe date when the payment document starts being/ is inactive. -
LastAvailableDocumentNumber: number
Title:
Last Available Document NumberThe last payment number available on a payment document. -
LastIssuedDocumentNumber: number
Title:
Last Issued Document NumberDefault Value:0The last payment number used on a payment document to pay invoices. -
ManualPaymentsOnlyFlag: boolean
Title:
Restrict use to manually issued paymentsMaximum Length:1Default Value:falseThe option that indicates whether manual payment is allowed. The default value is False. -
NumberOfLinesPERRemitStub: number
Title:
Number of Lines per Remittance StubThe number of lines allowed per remittance stub. -
NumberOfSetupDocuments: number
Title:
Number of Setup DocumentsThe number of documents printed at the beginning of each automatic payment batch. -
PaperStockType: string
Title:
Paper Stock TypeMaximum Length:255The 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 CategoryMaximum Length:255The category of the payment document. -
PaymentDocumentName: string
Title:
Payment DocumentMaximum Length:100The name of the payment document.
Nested Schema : Bank Account Checkbooks
Type:
arrayTitle:
Bank Account CheckbooksThe bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.
Show Source
Nested Schema : cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-patch-request
Type:
Show Source
object-
CheckbookName: string
Title:
CheckbookMaximum Length:240The name of the checkbook. -
DateReceived: string
(date)
Title:
Received DateThe date when the checkbook was received. -
EndNumber: number
Title:
End NumberThe ending number of the checkbook. -
Prefix: string
Title:
PrefixMaximum Length:30The prefix used for the checkbook. -
StartNumber: number
Title:
Start NumberThe starting number of the checkbook.
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.
Root Schema : cashBankAccounts-bankAccountPaymentDocuments-item-response
Type:
Show Source
object-
AttachedRemittanceStubFlag: boolean
Title:
Attached remittance stubMaximum Length:1Default Value:falseThe option that indicates whether attaching remittance stub is allowed. The default value is False. -
bankAccountCheckbooks: array
Bank Account Checkbooks
Title:
Bank Account CheckbooksThe bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the record was created. -
FirstAvailableDocumentNumber: number
Title:
First Available Document NumberThe first payment number available on a payment document. -
FormatName: string
Title:
FormatMaximum Length:300The payment format name of the payment document. -
InactiveDate: string
(date)
Title:
End DateThe date when the payment document starts being/ is inactive. -
LastAvailableDocumentNumber: number
Title:
Last Available Document NumberThe last payment number available on a payment document. -
LastIssuedDocumentNumber: number
Title:
Last Issued Document NumberDefault Value:0The last payment number used on a payment document to pay invoices. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The session login associated to the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManualPaymentsOnlyFlag: boolean
Title:
Restrict use to manually issued paymentsMaximum Length:1Default Value:falseThe option that indicates whether manual payment is allowed. The default value is False. -
NumberOfLinesPERRemitStub: number
Title:
Number of Lines per Remittance StubThe number of lines allowed per remittance stub. -
NumberOfSetupDocuments: number
Title:
Number of Setup DocumentsThe number of documents printed at the beginning of each automatic payment batch. -
PaperStockType: string
Title:
Paper Stock TypeMaximum Length:255The 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 CategoryMaximum Length:255The category of the payment document. -
PaymentDocumentId: integer
(int64)
The unique identifier of the bank account payment document.
-
PaymentDocumentName: string
Title:
Payment DocumentMaximum Length:100The name of the payment document.
Nested Schema : Bank Account Checkbooks
Type:
arrayTitle:
Bank Account CheckbooksThe 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:
arrayTitle:
LinksThe 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:
CheckbookMaximum Length:240The name of the checkbook. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date and time when the record was created. -
DateReceived: string
(date)
Title:
Received DateThe date when the checkbook was received. -
EndNumber: number
Title:
End NumberThe ending number of the checkbook. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The session login associated to the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoOfDocuments: string
Title:
Number of DocumentsRead Only:trueThe number of documents associated to the checkbook. -
Prefix: string
Title:
PrefixMaximum Length:30The prefix used for the checkbook. -
StartNumber: number
Title:
Start NumberThe starting number of the checkbook.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- bankAccountCheckbooks
-
Parameters:
- BankAccountId:
$request.path.BankAccountId - PaymentDocumentId:
$request.path.PaymentDocumentId
The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date. - BankAccountId:
Examples
The following example shows how to update a payment document for a bank account by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X PATCH -d <payload> https://fuscdrmsmc79-fa-ext.us2.oracle.com/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196595204
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"FirstAvailableDocumentNumber": 15,
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AttachedRemittanceStubFlag": false,
"CreatedBy": "CASH_MANAGER",
"CreationDate": "2020-04-21T01:57:59.885+00:00",
"FirstAvailableDocumentNumber": 15,
"InactiveDate": null,
"LastAvailableDocumentNumber": null,
"LastIssuedDocumentNumber": 14,
"LastUpdateDate": "2020-04-21T02:11:48+00:00",
"LastUpdateLogin": "A38FEA9E660574ADE053D713F50A815E",
"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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"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"
}
]
}