https://indebted-dev-docs.netlify.app/assets/js/4b53dfa3.d59d1b8d.js

1"use strict";(self.webpackChunkdocs_v_2=self.webpackChunkdocs_v_2||[]).push([[4787],{27825:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>a,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>d,toc:()=>c});var s=i(74848),r=i(28453);const t={sidebar_position:29,format:"md",title:"Advanced If and Segmentation variables"},l="Advanced If and Segmentation variables",d={id:"receive/strategy/strategy-builder/advanced-if-and-segmentation-variables",title:"Advanced If and Segmentation variables",description:"This article provides an overview of supported variables for expression in Strategy Step IF-condition and Segmentation steps.",source:"@site/docs/receive/strategy/strategy-builder/advanced-if-and-segmentation-variables.md",sourceDirName:"receive/strategy/strategy-builder",slug:"/receive/strategy/strategy-builder/advanced-if-and-segmentation-variables",permalink:"/docs/receive/strategy/strategy-builder/advanced-if-and-segmentation-variables",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:29,frontMatter:{sidebar_position:29,format:"md",title:"Advanced If and Segmentation variables"},sidebar:"receiveSidebar",previous:{title:"Step Type: Email",permalink:"/docs/receive/strategy/strategy-builder/step-type-email/"},next:{title:"Step Type: Set Landing Page Content",permalink:"/docs/receive/strategy/strategy-builder/step-type-set-landing-page-content/"}},a={},c=[{value:"This article provides an overview of supported variables for expression in Strategy Step IF-condition and Segmentation steps.",id:"this-article-provides-an-overview-of-supported-variables-for-expression-in-strategy-step-if-condition-and-segmentation-steps",level:2},{value:"<strong><strong>Introduction and shorthands</strong></strong>",id:"introduction-and-shorthands",level:3},{value:"Claim",id:"claim",level:3},{value:"Debtor / Customer",id:"debtor--customer",level:3},{value:"Calculated variables",id:"calculated-variables",level:3},{value:"MomentJs",id:"momentjs",level:3},{value:"Payment Variables",id:"payment-variables",level:3}];function o(e){const n={a:"a",br:"br",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"advanced-if-and-segmentation-variables",children:"Advanced If and Segmentation variables"})}),"\n",(0,s.jsx)(n.h2,{id:"this-article-provides-an-overview-of-supported-variables-for-expression-in-strategy-step-if-condition-and-segmentation-steps",children:"This article provides an overview of supported variables for expression in Strategy Step IF-condition and Segmentation steps."}),"\n",(0,s.jsx)(n.h3,{id:"introduction-and-shorthands",children:(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.strong,{children:"Introduction and shorthands"})})}),"\n",(0,s.jsx)(n.p,{children:"You can use variables that are included in the to claim model provided by receive.\xa0You can also use all Data fields that were transferred to receive in the meta-data of each claim."}),"\n",(0,s.jsx)(n.p,{children:"For example:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"totalFees"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["amount (or ",(0,s.jsx)(n.code,{children:"claimAmount"}),")"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["debtor.contactInformation.mobileNumber (or shorthand:",(0,s.jsx)(n.code,{children:"mobileNumber"}),")"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["debtor.contactInformation.postalCode(or shorthand:",(0,s.jsx)(n.code,{children:"postalCode"}),")"]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["debtor.contactInformation.email (or shorthand:",(0,s.jsx)(n.code,{children:"email"}),")"]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Note that only the following shorthands are available:"}),"\n",(0,s.jsx)(n.p,{children:"claimAmount, mobileNumber, postalCode, email, debtorBirthday, debtorGender"}),"\n",(0,s.jsx)(n.h3,{id:"claim",children:"Claim"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"amount (number, amount in cents)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"totalFees (number, sum amount of all fees in cents)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"dueDate (string, Due date of the claim in the system)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"externalClaimRef (string, Client claim reference)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"externalPortfolioRef (string, Client portfolio reference)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"externalDueDate (string, Client due date)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"currency (string, 3-digit currency code (ISO 4217))"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"paymentReference (string, Reference to be used to match the payment)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["Entity (string, person or company that is in debt)",(0,s.jsx)(n.br,{})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"debtor--customer",children:"Debtor / Customer"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"SSN?: string; Social Security Number"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:'gender?: "F" | "M";'}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"externalDebtorRef (string, Client debtor reference)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"companyName?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"title?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"firstName: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"middleName?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"lastName: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"birthday?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"placeOfBirth?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"IBAN?: string;"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"contactInformation:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"email?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"mobileNumber?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"landLine?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"workPhoneNumber?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"additionalAddresses?: Address[];"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"house

1Number?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"addressLine1?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"addressLine2?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"addressLine3?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"city?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["postalCode?: string; Postal code. Used to place the consumer when ",(0,s.jsx)(n.code,{children:"state"})," is absent or unclear."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"suburb?: string;"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["state?: string; State, province or territory. For US, CA and AU, prefer the ISO 3166-2 subdivision code (",(0,s.jsx)(n.code,{children:"IL"}),", ",(0,s.jsx)(n.code,{children:"ON"}),", ",(0,s.jsx)(n.code,{children:"NSW"}),"); we use it to apply state-level regulation. The full name (",(0,s.jsx)(n.code,{children:"Illinois"}),") is also understood. Not the city."]}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsxs)(n.p,{children:["country: string;",(0,s.jsx)(n.br,{})]}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"calculated-variables",children:"Calculated variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"debtorAge (in years)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"externalDueDate (date)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"originalClaimAge (in days)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"dayOfTheWeek (day of the week UTC)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"dayOfTheMonth (day of the month UTC)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"todaysDate (YYYY-MM-DD, but UTC, not localized)"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"momentjs",children:"MomentJs"}),"\n",(0,s.jsxs)(n.p,{children:["There is possible to use momentJs library in the conditions. Also usage of ",(0,s.jsx)(n.a,{href:"http://moment.tz",children:"moment.tz"}),"() is possible, example:"]}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-javascript",children:'moment.tz("Europe/Riga").format("YYYY-MM-DD HH")\n'})}),"\n",(0,s.jsx)(n.h3,{id:"payment-variables",children:"Payment Variables"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"lastSettledPayment"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"lastCanceledPayment"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"lastDisputedPayment"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"lastProcessingPayment"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"each variable is composed of these properties:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"currency (string, currency of the payment)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"amount (number, amount of the payment in cents)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"date (string with format YYYY-MM-DD, but UTC, not localized)"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"providerName (string, name of the provider for example 'trustly')"}),"\n"]}),"\n",(0,s.jsxs)(n.li,{children:["\n",(0,s.jsx)(n.p,{children:"context (string, type of payment: 'claim', 'promiseToPay', 'instalment')"}),"\n"]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Example:"}),"\n",(0,s.jsx)(n.p,{children:(0,s.jsx)(n.code,{children:"lastSettledPayment.date"})}),"\n",(0,s.jsx)(n.p,{children:"returns the last settled payment of the claim,"}),"\n",(0,s.jsxs)(n.p,{children:["(e.g. ",(0,s.jsx)(n.code,{children:"2020-07-10"}),") or ",(0,s.jsx)(n.code,{children:"null"})," if there is no payment yet"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(o,{...e})}):o(e)}},28453:(e,n,i)=>{i.d(n,{R:()=>l,x:()=>d});var s=i(96540);const r={},t=s.createContext(r);function l(e){const n=s.useContext(t);return s.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:l(e.components),s.createElement(t.Provider,{value:n},e.children)}}}]);