Create a payment document for a bank account

post

/fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : cashBankAccounts-bankAccountPaymentDocuments-item-response
Type: object
Show Source
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 : cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to create a payment document for a bank account by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://fuscdrmsmc79-fa-ext.us2.oracle.com/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments

Example Request Payload

The following example shows the contents of the request body in JSON format:

{

"AttachedRemittanceStubFlag": false,
"FirstAvailableDocumentNumber": 13,
"LastIssuedDocumentNumber": 14,
"LastAvailableDocumentNumber": null,
"ManualPaymentsOnlyFlag": false,
"PaymentDocumentName": "DOCUMENT3",
"PaperStockType": "Blank Stock",
"FormatName": "Laser Check Format",
"PaymentDocumentCategory": null
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{

  "AttachedRemittanceStubFlag": false,
  "CreatedBy": "CASH_MANAGER",
  "CreationDate": "2020-04-21T03:07:01+00:00",
  "FirstAvailableDocumentNumber": 13,
  "InactiveDate": null,
  "LastAvailableDocumentNumber": null,
  "LastIssuedDocumentNumber": 14,
  "LastUpdateDate": "2020-04-21T03:07:01.034+00:00",
  "LastUpdateLogin": "A38FEA9E660574ADE053D713F50A815E",
  "LastUpdatedBy": "CASH_MANAGER",
  "ManualPaymentsOnlyFlag": false,
  "NumberOfLinesPERRemitStub": null,
  "NumberOfSetupDocuments": null,
  "PaymentDocumentId": 300100196596732,
  "PaymentDocumentName": "DOCUMENT3",
  "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/300100196596732",
      "name": "bankAccountPaymentDocuments",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://fuscdrmsmc79-fa-ext.us2.oracle.com:443/fscmRestApi/resources/11.13.0.0/cashBankAccounts/300100196526495/child/bankAccountPaymentDocuments/300100196596732",
      "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/300100196596732/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/300100196596732/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/300100196596732/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/300100196596732/child/bankAccountCheckbooks",
      "name": "bankAccountCheckbooks",
      "kind": "collection"
    }
  ]
}
Back to Top