Jump to

• Request
• Response
• Examples

Create a payment document for a bank account

post

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

Request

Path Parameters

• BankAccountId(required): integer(int64)
  The unique identifier of the bank account.

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.
• Upsert-Mode:
  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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• FirstAvailableDocumentNumber(required): 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.
• 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(required): string
  Title: Payment Document

  Maximum Length: 100

  The name of the payment document.

{
    "required":[
        "FirstAvailableDocumentNumber",
        "PaymentDocumentName"
    ],
    "type":"object",
    "properties":{
        "InactiveDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the payment document starts being/ is inactive.",
            "format":"date",
            "nullable":true
        },
        "NumberOfSetupDocuments":{
            "title":"Number of Setup Documents",
            "type":"number",
            "description":"The number of documents printed at the beginning of each automatic payment batch.",
            "nullable":true
        },
        "LastAvailableDocumentNumber":{
            "title":"Last Available Document Number",
            "type":"number",
            "description":"The last payment number available on a payment document.",
            "nullable":true
        },
        "NumberOfLinesPERRemitStub":{
            "title":"Number of Lines per Remittance Stub",
            "type":"number",
            "description":"The number of lines allowed per remittance stub.",
            "nullable":true
        },
        "FirstAvailableDocumentNumber":{
            "title":"First Available Document Number",
            "type":"number",
            "description":"The first payment number available on a payment document.",
            "nullable":false
        },
        "PaperStockType":{
            "title":"Paper Stock Type",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaperStockType1"
                ]
            }
        },
        "PaymentDocumentCategory":{
            "title":"Payment Document Category",
            "maxLength":"255",
            "type":"string",
            "description":"The category of the payment document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentDocumentCategoryName"
                ]
            }
        },
        "LastIssuedDocumentNumber":{
            "title":"Last Issued Document Number",
            "type":"number",
            "description":"The last payment number used on a payment document to pay invoices.",
            "nullable":false,
            "default":"0"
        },
        "PaymentDocumentName":{
            "title":"Payment Document",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment document.",
            "nullable":false
        },
        "ManualPaymentsOnlyFlag":{
            "title":"Restrict use to manually issued payments",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option that indicates whether manual payment is allowed. The default value is False.",
            "nullable":false,
            "default":false
        },
        "PaymentDocumentId":{
            "type":"integer",
            "description":"The unique identifier of the bank account payment document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "bankAccountCheckbooks":{
            "title":"Bank Account Checkbooks",
            "type":"array",
            "description":"The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.",
            "items":{
                "$ref":"#/components/schemas/cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-post-request"
            }
        },
        "FormatName":{
            "title":"Format",
            "maxLength":"300",
            "type":"string",
            "description":"The payment format name of the payment document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AttachedRemittanceStubFlag":{
            "title":"Attached remittance stub",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option that indicates whether attaching remittance stub is allowed. The default value is False.",
            "nullable":false,
            "default":false
        }
    }
}

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

• Array of: object schema

{
    "title":"Bank Account Checkbooks",
    "type":"array",
    "description":"The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.",
    "items":{
        "$ref":"#/components/schemas/cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CheckbookId: integer (int64)
  The unique identifier of the bank account checkbook.
• CheckbookName: string
  Title: Checkbook

  Maximum Length: 240

  The name of the checkbook.
• DateReceived: string (date)
  Title: Received Date

  The date when the checkbook was received.
• EndNumber: number
  Title: End Number

  The ending number of 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.

{
    "type":"object",
    "properties":{
        "EndNumber":{
            "title":"End Number",
            "type":"number",
            "description":"The ending number of the checkbook.",
            "nullable":false
        },
        "CheckbookId":{
            "type":"integer",
            "description":"The unique identifier of the bank account checkbook.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CheckbookName":{
            "title":"Checkbook",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the checkbook.",
            "nullable":true
        },
        "DateReceived":{
            "title":"Received Date",
            "type":"string",
            "description":"The date when the checkbook was received.",
            "format":"date",
            "nullable":true
        },
        "StartNumber":{
            "title":"Start Number",
            "type":"number",
            "description":"The starting number of the checkbook.",
            "nullable":false
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":"30",
            "type":"string",
            "description":"The prefix used for the checkbook.",
            "nullable":true
        }
    }
}

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 : cashBankAccounts-bankAccountPaymentDocuments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InactiveDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the payment document starts being/ is inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfSetupDocuments":{
            "title":"Number of Setup Documents",
            "type":"number",
            "description":"The number of documents printed at the beginning of each automatic payment batch.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastAvailableDocumentNumber":{
            "title":"Last Available Document Number",
            "type":"number",
            "description":"The last payment number available on a payment document.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfLinesPERRemitStub":{
            "title":"Number of Lines per Remittance Stub",
            "type":"number",
            "description":"The number of lines allowed per remittance stub.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstAvailableDocumentNumber":{
            "title":"First Available Document Number",
            "type":"number",
            "description":"The first payment number available on a payment document.",
            "nullable":false,
            "x-queryable":true
        },
        "PaperStockType":{
            "title":"Paper Stock Type",
            "maxLength":"255",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaperStockType1"
                ]
            },
            "x-queryable":true
        },
        "PaymentDocumentCategory":{
            "title":"Payment Document Category",
            "maxLength":"255",
            "type":"string",
            "description":"The category of the payment document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PaymentDocumentCategoryName"
                ]
            },
            "x-queryable":true
        },
        "LastIssuedDocumentNumber":{
            "title":"Last Issued Document Number",
            "type":"number",
            "description":"The last payment number used on a payment document to pay invoices.",
            "nullable":false,
            "default":"0",
            "x-queryable":true
        },
        "PaymentDocumentName":{
            "title":"Payment Document",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the payment document.",
            "nullable":false,
            "x-queryable":true
        },
        "ManualPaymentsOnlyFlag":{
            "title":"Restrict use to manually issued payments",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option that indicates whether manual payment is allowed. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PaymentDocumentId":{
            "type":"integer",
            "description":"The unique identifier of the bank account payment document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "bankAccountCheckbooks":{
            "title":"Bank Account Checkbooks",
            "type":"array",
            "description":"The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.",
            "items":{
                "$ref":"#/components/schemas/cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response"
            }
        },
        "FormatName":{
            "title":"Format",
            "maxLength":"300",
            "type":"string",
            "description":"The payment format name of the payment document.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachedRemittanceStubFlag":{
            "title":"Attached remittance stub",
            "maxLength":"1",
            "type":"boolean",
            "description":"The option that indicates whether attaching remittance stub is allowed. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response

{
    "title":"Bank Account Checkbooks",
    "type":"array",
    "description":"The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.",
    "items":{
        "$ref":"#/components/schemas/cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-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 : cashBankAccounts-bankAccountPaymentDocuments-bankAccountCheckbooks-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndNumber":{
            "title":"End Number",
            "type":"number",
            "description":"The ending number of the checkbook.",
            "nullable":false,
            "x-queryable":true
        },
        "CheckbookId":{
            "type":"integer",
            "description":"The unique identifier of the bank account checkbook.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DateReceived":{
            "title":"Received Date",
            "type":"string",
            "description":"The date when the checkbook was received.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Prefix":{
            "title":"Prefix",
            "maxLength":"30",
            "type":"string",
            "description":"The prefix used for the checkbook.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckbookName":{
            "title":"Checkbook",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the checkbook.",
            "nullable":true,
            "x-queryable":true
        },
        "NoOfDocuments":{
            "title":"Number of Documents",
            "type":"string",
            "description":"The number of documents associated to the checkbook.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StartNumber":{
            "title":"Start Number",
            "type":"number",
            "description":"The starting number of the checkbook.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "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."
        }
    }
}

Links

bankAccountCheckbooks

Operation: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/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.

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