Reference fields

The Abillify API utilizes reference fields across multiple schema components to facilitate data retrieval for merchants and ensure uniqueness for specific elements such as voucher numbers. These references do not establish cross-relationships between entities but serve to streamline merchant processes and prevent duplication. All reference fields are always stored as strings. Below is a structured overview of how these references work and the expected values for each field.

General Reference Field Usage

Reference fields are used to uniquely identify records within the API. These fields typically store unique IDs or user-defined values, making it easier for merchants to locate and manage their data. Merchants can use their own identifiers as references; if none are provided, Abillify will automatically generate one.

Key Reference Fields and Expected Values

Bankaccount Schema

• reference: Represents the mandate reference number for direct debits.
  • Example: "M1234567890"

Creditnote Schema

• reference: Holds the unique credit note number assigned by the user.
  • Example: "1234567890"

Identity Schema

• reference: Represents the user-defined customer number.
  • Example: "1234567890"

Invoice Schema

• reference: The invoice number defined by the user.
  • Example: "1234567890"

Order Schema

• reference: The unique identifier for the order in the merchant's system.
  • Example: "123456789098765443"

Best Practices

• Ensure Uniqueness: Reference values must be unique and consistent across systems.
• Use Meaningful Identifiers: Reference fields should align with external systems, such as invoice numbers, order IDs, or mandate references.