PaymentDocuments

This component runs the Payment Documents (PYD) process.

Payment Run (PYR) produces a payments file that contains the details of all of the payments or collections generated in the run. This file can be used to produce physical payment documents to support the payments or payment collections generated, if they are required.

You can choose to print payment documents for only some of the payments generated. For example, you may want to print the documents by currency and apply different payment document formats for each.

Note: If the payment documents to be printed include a system assigned transaction reference number, for example a cheque number, do not run this process if you have not set the correct starting reference number.

Methods

Process
Driver Type: SASI
Use this method to run the component.

Mandatory fields

  • A value for the input parameter Payment Run Rules Code, (payload element <PaymentRunRulesCode>) must be supplied. The value specified should be the payment profile that was selected in the Payment Run (PYR), or Payment Collection Run (PYC), to produce the payments.
    Note: This is different from the SunSystems Payment Documents (PYD) function that requires the Payment Profile Code. Payment Run Rules Code and Payment Profile Code are different names for the same parameter.

    Values for the range of accounts, currency and selection criteria to determine the payment documents you want to print may also be required.

  • If you want to generate Payment Documents using a particular Document Format, a value for Document Format Code (payload element <DocumentFormatCode>) must be supplied. The Document Format Code determines the type of payment documents to be printed. If appropriate, specify values in the payload for the following fields:
    • <Print> - if the Final Print option is not set, a draft version of the documents is produced. For example, for the predefined SunSystems formats this inserts the word DRAFT in large characters at the top of each document.
    • <PrintTestPage> - select this if you are printing on special stationery and want to check that the paper is aligned correctly.
    • <DocumentDate> - this is used as the posting date for the payment transactions and is the date printed on the remittance and cheque, if applicable.
    Note: At runtime the component validates the payload contents to ensure that the values supplied are correct. Various combinations of values may require other elements in the payload to be specified, before the payload can be processed successfully. This process can take a long time to complete.

Related data

Document Formats.