Skip to main content

Advanced If and Segmentation variables

This article provides an overview of supported variables for expression in Strategy Step IF-condition and Segmentation steps.​

Introduction and shorthands​

You can use variables that are included in the to claim model provided by receeve. You can also use all Data fields that were transferred to receeve in the meta-data of each claim.

For example:

  • totalFees

  • amount (or claimAmount)

  • debtor.contactInformation.mobileNumber (or shorthand:mobileNumber)

  • debtor.contactInformation.postalCode(or shorthand:postalCode)

  • debtor.contactInformation.email (or shorthand:email)

Note that only the following shorthands are available:

claimAmount, mobileNumber, postalCode, email, debtorBirthday, debtorGender

Claim​

  • amount (number, amount in cents)

  • totalFees (number, sum amount of all fees in cents)

  • dueDate (string, Due date of the claim in the system)

  • externalClaimRef (string, Client claim reference)

  • externalPortfolioRef (string, Client portfolio reference)

  • externalDueDate (string, Client due date)

  • currency (string, 3-digit currency code (ISO 4217))

  • paymentReference (string, Reference to be used to match the payment)

  • Entity (string, person or company that is in debt)

Debtor / Customer​

  • SSN?: string; Social Security Number

  • gender?: "F" | "M";

  • externalDebtorRef (string, Client debtor reference)

  • companyName?: string;

  • title?: string;

  • firstName: string;

  • middleName?: string;

  • lastName: string;

  • birthday?: string;

  • placeOfBirth?: string;

  • IBAN?: string;

contactInformation:

  • email?: string;

  • mobileNumber?: string;

  • landLine?: string;

  • workPhoneNumber?: string;

  • additionalAddresses?: Address[];

  • houseNumber?: string;

  • addressLine1?: string;

  • addressLine2?: string;

  • addressLine3?: string;

  • city?: string;

  • postalCode?: string;

  • suburb?: string;

  • state?: string; 2-digit country code (ISO 3166-1)

  • country: string;

Calculated variables​

  • debtorAge (in years)

  • externalDueDate (date)

  • originalClaimAge (in days)

  • dayOfTheWeek (day of the week UTC)

  • dayOfTheMonth (day of the month UTC)

  • todaysDate (YYYY-MM-DD, but UTC, not localized)

MomentJs​

There is possible to use momentJs library in the conditions. Also usage of moment.tz() is possible, example:

moment.tz("Europe/Riga").format("YYYY-MM-DD HH")

Payment Variables​

  • lastSettledPayment

  • lastCanceledPayment

  • lastDisputedPayment

  • lastProcessingPayment

each variable is composed of these properties:

  • currency (string, currency of the payment)

  • amount (number, amount of the payment in cents)

  • date (string with format YYYY-MM-DD, but UTC, not localized)

  • providerName (string, name of the provider for example 'trustly')

  • context (string, type of payment: 'claim', 'promiseToPay', 'instalment')

Example:

lastSettledPayment.date

returns the last settled payment of the claim,

(e.g. 2020-07-10) or null if there is no payment yet