Overview
The Payment Reference Mask is a crucial feature that helps in generating unique and structured Payment IDs based on specific parts of a document. This guide will explain the syntax and components used in the Payment Reference Mask to ensure accurate and consistent Payment ID generation.
Syntax(FIK)
The syntax for the Payment Reference Mask FIK71/FIK75 is as follows:
+71<{DDDDDDCCCCCCCT}M+B< (Max 14 characters between {})
+75<{DDDDDDDCCCCCCCT}M+B< (Max 15 characters between {})
Each character in the syntax represents a specific part of the document or a calculation method. Here’s a breakdown of what each symbol means:
- D: Document No.
- C: Customer No.
- T: Document Type
- B: Bank Creditor No. (full value)
- M: Modulus Check digit
The symbols {
and }
are used to specify the base for the Modulus Check digit calculation.
Components
-
Document No. (D): This part of the mask includes the document number, which is a unique identifier for each document. It ensures that each Payment ID is distinct and traceable to a specific document.
-
Customer No. (C): This includes the customer number, linking the Payment ID to the specific customer associated with the transaction.
-
Document Type (T): This specifies the type of document, such as an invoice or credit note, providing additional context to the Payment ID.
-
Bank Creditor No. (B): This includes the full value of the bank creditor number, ensuring that the Payment ID is associated with the correct bank.
-
Modulus Check Digit (M): The Modulus Check digit is a calculated value used to verify the integrity of the Payment ID. The symbols
{
and}
define the base for this calculation, ensuring that the check digit is correctly computed.
Example
Let’s consider an example to illustrate how the Payment Reference Mask works:
- Document No.: 123456
- Customer No.: 789012
- Document Type: 1 (Invoice)
- Bank Creditor No.: 345678
- Modulus Check Digit: 10
Using the syntax +71<{DDDDDDCCCCCCCT}M+B<
, the Payment ID would be generated as follows:
+71<1234567890121+345678<
Here, M
represents the Modulus Check digit calculated based on the base defined by {}
.
- If Document No. or Customer No. are to long compared to the definition and Payment Reference can´t be calculated an error will be shown.
- If Document No. or Customer No. are shorter than allowed trailing 0 will be put in front to match the full length.
Syntax(KID)
The syntax for the Payment Reference Mask KID is as follows:
{DDDDDDCCCCCC}M (Between 2 and 24 characters between {})
Each character in the syntax represents a specific part of the document or a calculation method. Here’s a breakdown of what each symbol means:
- D: Document No. (default set to 6 char.)
- C: Customer No. default set to 6 char.)
- Or add your Own S
- M: Modulus Check digit
The symbols {
and }
are used to specify the base for the Modulus Check digit calculation.
Components
-
Document No. (D): This part of the mask includes the document number, which is a unique identifier for each document. It ensures that each Payment ID is distinct and traceable to a specific document.
-
Customer No. (C): This includes the customer number, linking the Payment ID to the specific customer associated with the transaction.
-
Modulus Check Digit (M): The Modulus Check digit is a calculated value used to verify the integrity of the Payment ID. The symbols
{
and}
define the base for this calculation, ensuring that the check digit is correctly computed.
Example
Let’s consider an example to illustrate how the Payment Reference Mask works:
- Document No.: 123456
- Customer No.: 789012
- Modulus Check Digit: 10
Using the syntax {DDDDDDCCCCCCCT}M
, the Payment ID would be generated as follows:
123456789012
Here, M
represents the Modulus Check digit calculated based on the base defined by {}
.
Conclusion
Understanding and correctly implementing the Payment Reference Mask is essential for generating accurate and reliable Payment IDs. By following the syntax and components outlined in this guide, you can ensure that your Payment IDs are structured, unique, and verifiable.
How to setup and show FIK/KID on Printout
In the Payment Method the following must be setup:
With this setup, the field SCB Payment ID on the Posted Sales Invoice will be filled in with FIK/KID code based on the setup in the Payment Method
To add the field the Printout, go to the Document Customizer list, select the Posted Sales Invoice and add the field to the header section and define the requested caption
If the setup is done after posting the Sales Invoice, the Payment ID needs to be created manually on the Invoice
Comments
0 comments
Please sign in to leave a comment.