About Input Objects
Input objects can be described as "composable objects" because they include a set of input fields that define the object.
Input fields
| Name | Description |
|---|---|
| The account number to filter for. |
| The category to filter for. |
| The channel to filter for. |
| The customer contact to filter for. |
| The external identifier to filter for. |
| The priority to filter for. |
| The resolution status to filter for. |
| The resolution type to filter for. |
| The supply point identifier to filter for. |
| Tags to filter for. |
| The user ID to filter for. |
Example
{
"externalIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"channel": "abc123",
"priority": "LOW",
"tags": "MOVE_IN",
"category": "UNKNOWN",
"accountNumber": "abc123",
"userId": "abc123",
"customerContact": "abc123",
"supplyPointIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| A JSON object containing market parameters to store on the purchase. |
| ID of the accepted quote. |
Example
{
"accountNumber": "abc123",
"quoteId": "abc123",
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| Identifier of the Offer. |
Example
{
"identifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| Whether the customer has accepted the terms and conditions. |
| Possible values: 000000: RESIDENTIAL A01: A01 A011: A011 A011100: A011100 A011200: A011200 A011300: A011300 A011400: A011400 A011500: A011500 A012: A012 A012100: A012100 A012200: A012200 A012300: A012300 A013: A013 A013100: A013100 A013200: A013200 A013300: A013300 A013400: A013400 A013500: A013500 A013600: A013600 A013700: A013700 A013900: A013900 A014: A014 A014100: A014100 A014200: A014200 A014300: A014300 A014400: A014400 A014500: A014500 A014600: A014600 A014900: A014900 A015: A015 A015100: A015100 A015200: A015200 A015900: A015900 A016: A016 A016000: A016000 A017: A017 A017100: A017100 A017200: A017200 A018: A018 A018000: A018000 A019: A019 A019100: A019100 A019200: A019200 A019300: A019300 A019900: A019900 A02: A02 A020: A020 A020100: A020100 A020200: A020200 A020300: A020300 A03: A03 A030: A030 A030100: A030100 A030200: A030200 A04: A04 A041: A041 A041100: A041100 A041200: A041200 A041300: A041300 A041400: A041400 A041900: A041900 A042: A042 A042000: A042000 A05: A05 A051: A051 A051000: A051000 A052: A052 A052100: A052100 A052200: A052200 A052900: A052900 B06: B06 B060: B060 B060000: B060000 B07: B07 B070: B070 B070000: B070000 B08: B08 B080: B080 B080100: B080100 B080200: B080200 B080300: B080300 B080400: B080400 B080500: B080500 B080600: B080600 B080700: B080700 B080900: B080900 B09: B09 B091: B091 B091100: B091100 B091900: B091900 B099: B099 B099000: B099000 B10: B10 B101: B101 B101100: B101100 B101200: B101200 B109: B109 B109000: B109000 C11: C11 C111: C111 C111100: C111100 C111200: C111200 C111300: C111300 C112: C112 C112000: C112000 C113: C113 C113100: C113100 C113200: C113200 C113300: C113300 C114: C114 C114000: C114000 C115: C115 C115000: C115000 C116: C116 C116100: C116100 C116200: C116200 C117: C117 C117100: C117100 C117200: C117200 C117300: C117300 C117400: C117400 C118: C118 C118100: C118100 C118200: C118200 C119: C119 C119100: C119100 C119200: C119200 C119900: C119900 C12: C12 C121: C121 C121100: C121100 C121200: C121200 C121300: C121300 C121400: C121400 C122: C122 C122000: C122000 C13: C13 C131: C131 C131100: C131100 C131200: C131200 C131300: C131300 C132: C132 C132000: C132000 C133: C133 C133100: C133100 C133200: C133200 C133300: C133300 C133400: C133400 C134: C134 C134000: C134000 C135: C135 C135100: C135100 C135200: C135200 C14: C14 C141: C141 C141100: C141100 C141200: C141200 C141300: C141300 C149: C149 C149100: C149100 C149200: C149200 C149300: C149300 C149400: C149400 C149900: C149900 C15: C15 C151: C151 C151000: C151000 C152: C152 C152100: C152100 C152200: C152200 C152300: C152300 C152400: C152400 C152900: C152900 C16: C16 C161: C161 C161100: C161100 C161200: C161200 C162: C162 C162000: C162000 C17: C17 C170: C170 C170100: C170100 C170900: C170900 C18: C18 C181: C181 C181100: C181100 C181200: C181200 C181300: C181300 C182: C182 C182100: C182100 C182900: C182900 C183: C183 C183100: C183100 C183200: C183200 C184: C184 C184100: C184100 C184200: C184200 C185: C185 C185100: C185100 C185200: C185200 C189: C189 C189100: C189100 C189200: C189200 C189900: C189900 C19: C19 C191: C191 C191100: C191100 C191200: C191200 C191300: C191300 C191400: C191400 C191500: C191500 C191600: C191600 C191900: C191900 C192: C192 C192000: C192000 C20: C20 C201: C201 C201000: C201000 C202: C202 C202100: C202100 C202900: C202900 C203: C203 C203100: C203100 C203200: C203200 C203300: C203300 C203400: C203400 C209: C209 C209000: C209000 C21: C21 C211: C211 C211000: C211000 C212: C212 C212100: C212100 C212200: C212200 C213: C213 C213100: C213100 C213200: C213200 C213300: C213300 C213900: C213900 C214: C214 C214100: C214100 C214200: C214200 C214900: C214900 C22: C22 C221: C221 C221000: C221000 C222: C222 C222100: C222100 C222200: C222200 C222300: C222300 C222400: C222400 C222900: C222900 C223: C223 C223100: C223100 C223900: C223900 C224: C224 C224000: C224000 C229: C229 C229100: C229100 C229200: C229200 C229300: C229300 C229900: C229900 C23: C23 C231: C231 C231100: C231100 C231200: C231200 C231300: C231300 C231900: C231900 C239: C239 C239100: C239100 C239200: C239200 C239300: C239300 C239400: C239400 C239900: C239900 C24: C24 C241: C241 C241100: C241100 C241200: C241200 C241900: C241900 C242: C242 C242100: C242100 C242200: C242200 C242900: C242900 C243: C243 C243100: C243100 C243200: C243200 C243900: C243900 C244: C244 C244100: C244100 C244900: C244900 C245: C245 C245100: C245100 C245200: C245200 C246: C246 C246100: C246100 C246200: C246200 C246300: C246300 C246900: C246900 C249: C249 C249100: C249100 C249900: C249900 C25: C25 C251: C251 C251100: C251100 C251200: C251200 C251300: C251300 C251900: C251900 C259: C259 C259100: C259100 C259200: C259200 C259900: C259900 D26: D26 D261: D261 D261100: D261100 D261200: D261200 D261900: D261900 D262: D262 D262000: D262000 D263: D263 D263000: D263000 D264: D264 D264000: D264000 D27: D27 D270: D270 D270000: D270000 D28: D28 D281: D281 D281100: D281100 D281200: D281200 D29: D29 D291: D291 D291100: D291100 D291900: D291900 D292: D292 D292100: D292100 D292200: D292200 E30: E30 E301: E301 E301100: E301100 E301900: E301900 E302: E302 E302000: E302000 E31: E31 E310: E310 E310100: E310100 E310900: E310900 E32: E32 E321: E321 E321100: E321100 E321200: E321200 E322: E322 E322100: E322100 E322200: E322200 E322300: E322300 E322400: E322400 E323: E323 E323100: E323100 E323200: E323200 E323300: E323300 E323400: E323400 E323900: E323900 E324: E324 E324100: E324100 E324200: E324200 E324300: E324300 E324400: E324400 E324500: E324500 E329: E329 E329100: E329100 E329200: E329200 E329900: E329900 F33: F33 F331: F331 F331100: F331100 F331200: F331200 F331900: F331900 F332: F332 F332100: F332100 F332200: F332200 F332300: F332300 F333: F333 F333100: F333100 F333200: F333200 F333900: F333900 F34: F34 F341: F341 F341100: F341100 F341900: F341900 F349: F349 F349100: F349100 F349200: F349200 F349300: F349300 F349400: F349400 F349900: F349900 F35: F35 F350: F350 F350100: F350100 F350200: F350200 F350300: F350300 F350400: F350400 F350500: F350500 F36: F36 F360: F360 F360100: F360100 F360200: F360200 F360300: F360300 F360400: F360400 F360500: F360500 F360600: F360600 F360900: F360900 F37: F37 F371: F371 F371100: F371100 F371200: F371200 F372: F372 F372000: F372000 F373: F373 F373100: F373100 F373200: F373200 F373300: F373300 F373400: F373400 F373500: F373500 F373600: F373600 F373900: F373900 F38: F38 F380: F380 F380000: F380000 G39: G39 G391: G391 G391100: G391100 G391200: G391200 G391300: G391300 G392: G392 G392100: G392100 G392200: G392200 G40: G40 G400: G400 G400000: G400000 G41: G41 G411: G411 G411000: G411000 G412: G412 G412100: G412100 G412200: G412200 G412300: G412300 G412900: G412900 G42: G42 G421: G421 G421100: G421100 G421200: G421200 G421300: G421300 G421400: G421400 G422: G422 G422100: G422100 G422200: G422200 G422900: G422900 G423: G423 G423100: G423100 G423200: G423200 G424: G424 G424100: G424100 G424200: G424200 G424300: G424300 G424400: G424400 G424500: G424500 G425: G425 G425100: G425100 G425200: G425200 G425300: G425300 G425900: G425900 G426: G426 G426000: G426000 G427: G427 G427100: G427100 G427200: G427200 G427300: G427300 G427400: G427400 G427900: G427900 G43: G43 G431: G431 G431000: G431000 G432: G432 G432000: G432000 H44: H44 H440: H440 H440000: H440000 H45: H45 H451: H451 H451100: H451100 H451200: H451200 H451300: H451300 H452: H452 H452000: H452000 H453: H453 H453000: H453000 I46: I46 I461: I461 I461000: I461000 I462: I462 I462100: I462100 I462200: I462200 I462300: I462300 I47: I47 I471: I471 I471000: I471000 I472: I472 I472000: I472000 I48: I48 I481: I481 I481000: I481000 I482: I482 I482000: I482000 I49: I49 I490: I490 I490000: I490000 I50: I50 I501: I501 I501000: I501000 I502: I502 I502100: I502100 I502900: I502900 I51: I51 I510: I510 I510100: I510100 I510200: I510200 I52: I52 I521: I521 I521100: I521100 I521200: I521200 I521900: I521900 I522: I522 I522000: I522000 I529: I529 I529100: I529100 I529200: I529200 I529900: I529900 I53: I53 I530: I530 I530100: I530100 I530900: I530900 J54: J54 J541: J541 J541100: J541100 J541200: J541200 J541300: J541300 J541400: J541400 J541900: J541900 J542: J542 J542000: J542000 J55: J55 J551: J551 J551100: J551100 J551200: J551200 J551300: J551300 J551400: J551400 J552: J552 J552100: J552100 J552200: J552200 J56: J56 J561: J561 J561000: J561000 J562: J562 J562100: J562100 J562200: J562200 J57: J57 J570: J570 J570000: J570000 J58: J58 J580: J580 J580100: J580100 J580200: J580200 J580900: J580900 J59: J59 J591: J591 J591000: J591000 J592: J592 J592100: J592100 J592200: J592200 J60: J60 J601: J601 J601000: J601000 J602: J602 J602000: J602000 K62: K62 K621: K621 K621000: K621000 K622: K622 K622100: K622100 K622200: K622200 K622300: K622300 K622900: K622900 K623: K623 K623000: K623000 K624: K624 K624000: K624000 K63: K63 K631: K631 K631000: K631000 K632: K632 K632100: K632100 K632200: K632200 K633: K633 K633000: K633000 K64: K64 K641: K641 K641100: K641100 K641900: K641900 K642: K642 K642000: K642000 L66: L66 L661: L661 L661100: L661100 L661900: L661900 L662: L662 L662000: L662000 L663: L663 L663100: L663100 L663200: L663200 L663900: L663900 L664: L664 L664000: L664000 L67: L67 L671: L671 L671100: L671100 L671200: L671200 L672: L672 L672000: L672000 M69: M69 M691: M691 M691000: M691000 M692: M692 M692100: M692100 M692200: M692200 M692300: M692300 M692400: M692400 M692500: M692500 M693: M693 M693100: M693100 M693200: M693200 M694: M694 M694000: M694000 M695: M695 M695000: M695000 M696: M696 M696100: M696100 M696200: M696200 M697: M697 M697000: M697000 M699: M699 M699100: M699100 M699900: M699900 M70: M70 M700: M700 M700000: M700000 N72: N72 N721: N721 N721100: N721100 N721200: N721200 N722: N722 N722000: N722000 N729: N729 N729100: N729100 N729200: N729200 N729300: N729300 N729400: N729400 N729900: N729900 N73: N73 N731: N731 N731100: N731100 N731200: N731200 N731300: N731300 N732: N732 N732000: N732000 O75: O75 O751: O751 O751000: O751000 O752: O752 O752000: O752000 O753: O753 O753000: O753000 O754: O754 O754000: O754000 O755: O755 O755100: O755100 O755200: O755200 O76: O76 O760: O760 O760000: O760000 O77: O77 O771: O771 O771100: O771100 O771200: O771200 O771300: O771300 O771400: O771400 O771900: O771900 O772: O772 O772000: O772000 P80: P80 P801: P801 P801000: P801000 P802: P802 P802100: P802100 P802200: P802200 P802300: P802300 P802400: P802400 P81: P81 P810: P810 P810100: P810100 P810200: P810200 P82: P82 P821: P821 P821100: P821100 P821200: P821200 P821900: P821900 P822: P822 P822000: P822000 Q84: Q84 Q840: Q840 Q840100: Q840100 Q840200: Q840200 Q85: Q85 Q851: Q851 Q851100: Q851100 Q851200: Q851200 Q852: Q852 Q852000: Q852000 Q853: Q853 Q853100: Q853100 Q853200: Q853200 Q853300: Q853300 Q853400: Q853400 Q853900: Q853900 Q859: Q859 Q859100: Q859100 Q859900: Q859900 Q86: Q86 Q860: Q860 Q860100: Q860100 Q860900: Q860900 Q87: Q87 Q871: Q871 Q871000: Q871000 Q879: Q879 Q879000: Q879000 R89: R89 R891: R891 R891000: R891000 R892: R892 R892100: R892100 R892200: R892200 R90: R90 R900: R900 R900100: R900100 R900200: R900200 R900300: R900300 R91: R91 R911: R911 R911100: R911100 R911200: R911200 R911300: R911300 R911400: R911400 R912: R912 R912100: R912100 R912900: R912900 R913: R913 R913100: R913100 R913900: R913900 R92: R92 R920: R920 R920100: R920100 R920200: R920200 R920900: R920900 S94: S94 S941: S941 S941100: S941100 S941200: S941200 S941900: S941900 S942: S942 S942100: S942100 S942200: S942200 S942900: S942900 S949: S949 S949100: S949100 S949900: S949900 S95: S95 S951: S951 S951100: S951100 S951200: S951200 S952: S952 S952000: S952000 S953: S953 S953100: S953100 S953200: S953200 S953300: S953300 S953400: S953400 S953900: S953900 S954: S954 S954000: S954000 S955: S955 S955100: S955100 S955200: S955200 S955900: S955900 S96: S96 S960: S960 S960100: S960100 S960200: S960200 S960300: S960300 T99: T99 T994: T994 T994000: T994000 T995: T995 T995000: T995000 T997: T997 T997000: T997000 T998: T998 T998000: T998000 T999: T999 T999999: T999999 |
| The billing address country code. |
| The billing address for the property. |
| Extra billing address field. |
| Extra billing address field. |
| Extra billing address field. |
| Extra billing address field. |
| The billing address postcode. |
| The billing name (if different from the customer's name). |
| Whether the customer is business or residential. |
| The customer's date of birth. |
| The date the switch should be effective from. |
| The customer's email address. |
| The customer's family name. |
| The customer's given name. |
| The customer's GST number (for business customers if applicable). |
| Whether the switch is a new move in or not. |
| Whether the customer has a medical dependency. |
| The customer's mobile number. |
| Whether the customer has opted out from retrieving prior usage data. |
| Whether the property is the primary place of residence. |
| The product code (returned from RequestQuote). |
| The customer's desired pronouns. |
| The quote code (returned from RequestQuote). |
| The referral code (from a referring account). |
| The sales subchannel request referrer (set by the browser). |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"dateOfBirth": "2020-01-01",
"pronouns": "abc123",
"email": "abc123",
"mobile": "abc123",
"anzsicCode": "abc123",
"quoteCode": "abc123",
"productCode": "abc123",
"referralCode": "abc123",
"effectiveFrom": "2020-01-01",
"isMoveIn": true,
"billingName": "abc123",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingAddressPostcode": "abc123",
"billingAddressCountryCode": "abc123",
"business": true,
"ppr": true,
"medicalDependency": true,
"optOutFromPriorData": true,
"acceptedTAndC": true,
"gstNumber": "abc123",
"referrer": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number of the account to update. |
| Billing address details. |
Example
{
"accountNumber": "abc123",
"billingAddress": BillingAddressDetailsInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ledger id for the account. Deprecated The 'ledgerId' field is deprecated. |
| The ledger number for the account. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
Example
{
"accountNumber": "abc123"
}AccountReferenceInput
The input type for the account reference.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The namespace for the reference. |
| The reference value. |
Example
{
"accountNumber": "abc123",
"namespace": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| Internal account id (not account number). |
| The account number eg. A-FF15AE70. |
| Account Reference. |
| Bills (Shortcut). |
| Account or Billing name. |
| Business name. |
| Business identifier or number. |
| Location (Supply or Billing, full or partial, address or post code). |
| Meter Serial Number. |
| The portfolio number eg. P-A123B456. |
| Statements (Alias for bills). |
| URN Number. |
| The Account User ID (not account number). |
Example
{
"accountNumber": "abc123",
"portfolioNumber": "abc123",
"urn": "abc123",
"user": "abc123",
"account": "abc123",
"bill": "abc123",
"statements": "abc123",
"meterSerialNumber": "abc123",
"location": "abc123",
"billingName": "abc123",
"businessName": "abc123",
"businessNumber": "abc123",
"accountReferences": "abc123"
}Input fields
| Name | Description |
|---|---|
| The date of birth of the account user. |
| The email associated with the account user. |
| The family name of the account user. |
| The given name of the account user. |
| The landline number of the account user. |
| The mobile number of the account user. |
Example
{
"givenName": 1.0,
"familyName": 1.0,
"dateOfBirth": 1.0,
"email": 1.0,
"mobile": 1.0,
"landline": 1.0
}Input fields
| Name | Description |
|---|---|
| The date of birth of the account user. |
| The email of the account user. |
| The family name of the account user. |
| The given name of the account user. |
| The landline number of the account user. |
| The mobile number of the account user. |
| Allows optional extra weighting on search fields. Boost certain fields between Float(0.0) and Float(1.0) to increase prominence of that field in the total search result calculation. |
| Field for saving the confidence score of results, useful when we have multiple account users with similar matching fields. Set between: - Float(0.0) (Match everything) - Float(1.0) (Match nothing) |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"dateOfBirth": "2020-01-01",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"threshold": 1.0,
"searchWeightMappings": AccountUserFuzzySearchWeightMappingType
}Input fields
| Name | Description |
|---|---|
| The unique identifier of the contract to actualize. |
| The day and time from when the contract actualization is valid. |
Example
{
"identifier": NonEmptyString,
"validFrom": "2020-01-01T00:00:00.000Z"
}Example
{
"businessId": "abc123",
"segmentName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The slug of the campaign we want to assign. |
| The date in which the link between the campaing and the account is meant to expire. If null, no specific expiring date will be set. |
| The date in which the link between the campaing and the account is meant to start. If null, no specific start date will be set. |
Example
{
"accountNumber": "abc123",
"campaign": "abc123",
"startDate": "2020-01-01",
"expiryDate": "2020-01-01"
}AddChildToPropertyInput
Input for adding a child property to a parent property in a hierarchy.
Input fields
| Name | Description |
|---|---|
| The ID of the child property to add to the parent. |
| The name of the hierarchy. |
| The ID of the parent property. |
Example
{
"parentId": "abc123",
"childId": "abc123",
"hierarchyName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The time at which the note will appear to have been added (defaults to now). |
| The content of the note. |
| The relay id of the conversation that will be assigned to the bucket. |
| Is the note pinned, to make it clearer to the support user. |
Example
{
"conversationRelayId": "abc123",
"content": "abc123",
"addedAt": "2020-01-01T00:00:00.000Z",
"isPinned": true
}AddParentToPropertyInput
Input for adding a parent property to a child property in a hierarchy.
Input fields
| Name | Description |
|---|---|
| The ID of the child property. |
| The name of the hierarchy. |
| The ID of the parent property to add to the child. |
Example
{
"childId": "abc123",
"parentId": "abc123",
"hierarchyName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The portfolio number to which the reference will be added. |
| The namespace of the portfolio reference. |
| The value of the portfolio reference. |
Example
{
"portfolioNumber": "abc123",
"referenceNamespace": "abc123",
"referenceValue": "abc123"
}AddPropertyInput
Input type for adding a new property to an account.
Input fields
| Name | Description |
|---|---|
| The account number to add the property to. |
| The address of the property using the rich address format. |
Example
{
"accountNumber": "abc123",
"address": RichAddressInput
}AddPropertyToHierarchyInput
Input for adding a property to a hierarchy as a root node.
Input fields
| Name | Description |
|---|---|
| The name of the hierarchy to add the property to. |
| The ID of the property to add to the hierarchy. |
Example
{
"propertyId": "abc123",
"hierarchyName": "abc123"
}AddSignupReferralOnAccountInput
Required information for creating a referral reward for an organization
Input fields
| Name | Description |
|---|---|
| The account number for the referred account. |
| The referral scheme code for the organization. |
Example
{
"accountNumber": "abc123",
"schemeCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The relay id of the conversation that will be assigned to the bucket. |
| A list of entries to add to the storyline. |
| The time the storyline was generated. |
| A list of knowledge article IDs to associate with the storyline. |
| The Neuralink request ID. |
| The summary of the storyline. |
| The topic of the storyline. |
Example
{
"conversationRelayId": "abc123",
"topic": "abc123",
"summary": "abc123",
"generatedAt": "2020-01-01T00:00:00.000Z",
"entries": InkStorylineEntryInput,
"neuralinkRequestId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"knowledgeArticleIds": [1]
}Input fields
| Name | Description |
|---|---|
| The portfolio number for the portfolio to add the user to. |
| The role code to assign to the user. |
| The user number for the user to add to the portfolio. |
Example
{
"userNumber": "abc123",
"roleCode": "abc123",
"portfolioNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The new amount for the amended payment. |
| The new date to collect the payment. |
| The ID of the payment to amend. |
| Reason for amending the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": 1,
"amount": 1,
"paymentDate": "2020-01-01",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number for the requested repayment. |
| The id of the account repayment to be approved. |
Example
{
"accountNumber": "abc123",
"repaymentId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Whether the assessment should unpause the collection process when applicable. |
| The collection process number to run pause assessment against. |
Example
{
"number": "abc123",
"allowUnpausing": true
}Input fields
| Name | Description |
|---|---|
| The name of the bucket to assign the conversation to. |
| The relay id of the conversation that will be assigned to the bucket. |
Example
{
"conversationRelayId": "abc123",
"bucketName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Unique slug identifier for the estimation group. |
| Supply point external identifier. |
| Datetime period start to look for supply point. |
Example
{
"estimationGroupCode": "abc123",
"supplyPointExternalId": "abc123",
"supplyPointPeriodStart": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The account number to associate to the call. |
| The ID of the call. |
Example
{
"callId": "abc123",
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| A JSON object of additional details regarding the item. |
| Unique reference to look up the associated item (ex. UUID or primary key). |
| Associated item type. |
| The Collection Process Record Number. |
| The datetime when action that resulted in the associated item happened. |
Example
{
"number": "abc123",
"itemType": "TRANSACTIONAL_MESSAGING_TRIGGER",
"itemReference": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"extraDetails": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| Account number. |
| Address line 1. |
| Address line 2. |
| Address line 3. |
| Address line 4. |
| Address line 5. |
| Content type of the recording. |
| Duration of the recording in seconds. |
| Size of the file in bytes. |
| UUID of the audio recording. |
| Timestamp of the recorded location. |
| Horizontal accuracy of the location. |
| Latitude of the recorded location. |
| Longitude of the recorded location. |
| List of outcomes for the session. |
| List of uploaded photos. |
| Postal code. |
| S3 bucket where the audio file is stored. |
| S3 key for the audio recording. |
| Sales mode of the session. |
| List of scan values. |
| Start time of the session. |
| End time of the session. |
| Subdomain of the affiliate link. |
| Type of the session. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"contentType": "abc123",
"duration": "abc123",
"fileSize": 1,
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123",
"postcode": "abc123",
"accountNumber": "abc123",
"locationAt": "2020-01-01T00:00:00.000Z",
"locationHorizontalAccuracy": 1,
"locationLatitude": "1.0",
"locationLongitude": "1.0",
"outcomes": OutcomeInput,
"salesMode": "abc123",
"type": "abc123",
"startedAt": "2020-01-01T00:00:00.000Z",
"stoppedAt": "2020-01-01T00:00:00.000Z",
"s3Bucket": "abc123",
"s3Key": "abc123",
"subdomain": "abc123",
"photos": PhotoInput,
"scans": ["abc123"]
}Input fields
| Name | Description |
|---|---|
| SSO access token for the chosen provider authentication. |
| Provider code from user login used for SSO. |
| SSO token expiry for the provider's authentication (integer in seconds). |
| ID of the device in the external provider system. |
| Full redirect URI (including all query string parameters) from the result of an OAuth 2.0 flow. |
| SSO refresh token for the chosen provider authentication. |
| State from user login used for SSO. |
Example
{
"accessToken": "abc123",
"authorizationCode": "abc123",
"refreshToken": "abc123",
"expiresIn": 1,
"state": "abc123",
"providerDeviceId": "abc123",
"redirectUri": "abc123"
}AwardLoyaltyPointsInput
The input type for awarding Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| A unique idempotency key for the award operation. |
| A note about the award. |
| The number of Loyalty Points to award. |
| The reason code associated with the award. |
Example
{
"accountNumber": "abc123",
"points": 1,
"reasonCode": "POINTS_AWARDED_FOR_ACCOUNT_ACTION",
"note": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}BackendScreenEventInput
Input for a backend action.
Input fields
| Name | Description |
|---|---|
| The ID of the action to perform. |
| List of key-value pairs (strings) to pass as parameters to the mutation. |
Example
{
"eventId": "abc123",
"params": BackendScreenParamInputType
}BackendScreenParamInputType
A key-value pair (both Strings) which is passed in parameters to a backend action.
Example
{
"key": "abc123",
"value": "abc123"
}BalanceTriggeredScheduleInput
A payment schedule which triggers a payment the balance of a ledger drops below a certain value.
Input fields
| Name | Description |
|---|---|
| The ledger balance (in the minor currency unit) which when passed will trigger a payment to be taken. |
| The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero. |
Example
{
"balanceThreshold": 1,
"targetBalance": 1
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"accountHolder": "abc123",
"iban": "abc123",
"accountNumber": "abc123",
"bankCode": "abc123",
"branchCode": "abc123",
"accountType": "abc123"
}BaseInitializeAccountInput
Minimum input required to initiate the Initialize Account step prior to sign up.
This type should be extended by clients/territories in order to define the input required by the specific client/territory for account preparation.
Either the preferred richbillingaddress or the legacy billing_address must be provided.
Input fields
| Name | Description |
|---|---|
| The type of account to create. |
| The billing address in legacy format. Must be provided if richbillingaddress is not provided. |
| The billing name. |
| The brand of the created account. |
| The chosen payment day. |
| The date of sale, defaults to today if not provided. |
| The number of the portfolio that the account will be associated with. |
| The preferred supply start date. |
| The billing address in the preferred RichAddress format. Must be provided if billing_address is not provided. |
| Sales information. |
| Information of the supply points that the customer is intending to sign up for supply. |
| The number of the user that owns the account. |
Example
{
"userNumber": "abc123",
"portfolioNumber": "abc123",
"accountType": "BUSINESS",
"brandCode": "abc123",
"billingName": "abc123",
"billingAddress": LifecycleAddressInput,
"richBillingAddress": RichAddressInput,
"salesInfo": SalesInformationInput,
"preferredSsd": "2020-01-01",
"dateOfSale": "2020-01-01",
"chosenPaymentDay": 1,
"supplyPointInfoList": PrepareAccountSupplyPointInput
}BaseInitializeUserInput
Minimum input required to initiate the Initialize User step prior to sign up.
This type should be extended by clients/territories in order to define the input required by the specific client/territory for user preparation.
Input fields
| Name | Description |
|---|---|
| The type of account this user is associated with initially. |
| The brand of the created portfolio. |
| The customer's details. |
| Optional user details to set on the user (e.g. namespace-based values like SSN last 4, PIN). |
| The number of portfolio this user will be linked to. |
| The user's role for the portfolio. |
Example
{
"customerDetails": CustomerDetailsInput,
"portfolioNumber": "abc123",
"role": RoleString,
"brandCode": "abc123",
"accountType": "BUSINESS",
"details": DetailsInputType
}Input fields
| Name | Description |
|---|---|
| The ID of the contract. |
| Optional note to capture at the point of termination. |
| The requested date of the termination. |
| Whether to waive any exit fees associated with the contract or not. |
Example
{
"contractIdentifier": "abc123",
"requestedTerminationDate": "2020-01-01",
"waiveExitFee": true,
"contractNote": ContractNoteInput
}BespokeRateConfigurationInput
Input type for the BespokeRateConfigurationType.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| The schedules for the bespoke rate configuration. |
Example
{
"isVariable": true,
"schedules": BespokeRateScheduleInput
}BespokeRateItemInput
Item for the BespokeRateConfiguration term.
Input fields
| Name | Description |
|---|---|
| The price per unit for the bespoke rate item. |
| The rate specification code for the bespoke rate item. |
| The variant profile for the bespoke rate item. |
Example
{
"pricePerUnit": "1.0",
"rateSpecificationCode": "abc123",
"variantProfile": VariantProfileInput
}BespokeRateScheduleInput
Schedule for the BespokeRateConfiguration term.
Input fields
| Name | Description |
|---|---|
| The items for the bespoke rate schedule. |
| The product code for the bespoke rate schedule. |
| The external identifier of the supply point that this bespoke rate schedule targets. |
| The datetime the schedule of bespoke rates is valid from. |
| The datetime the schedule of bespoke rates is valid to. |
Example
{
"items": BespokeRateItemInput,
"productCode": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"supplyPointIdentifier": "abc123"
}BillDueDateInput
Input type for BillDueDateTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
Example
{
"isVariable": true
}Input fields
| Name | Description |
|---|---|
| The target balance (in the minor currency unit) for the ledger; used to calculate the payment amount. Defaults to zero. |
Example
{
"targetBalance": 1
}BillTriggeredScheduleInput
A payment schedule which triggers a payment when a bill is issued.
Optionally a payment day frequency multiplier can be specified in which case the payment is taken on the first occurrence of the payment day after a bill has been issued.
Input fields
| Name | Description |
|---|---|
| The multiple of months at which payment are taken. Required when a payment day is chosen, ignored if payment day not set. |
| The day of the month at which to take payment; allowed values -28 to 28 (excl. 0). Negative values count backwards from the end of the month. If not provided payment is taken whenever a bill is issued. |
Example
{
"paymentDay": 1,
"frequencyMultiplier": 1
}Input fields
| Name | Description |
|---|---|
| Administrative area. |
| Billing country. |
| Billing delivery point identifier. |
| Billing dependent locality. |
| Billing locality. |
| Billing postal code. |
| Billing sorting code. |
| Billing street address. |
| Billing structured street address. |
Example
{
"streetAddress": "abc123",
"structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"dependentLocality": "abc123",
"locality": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"deliveryPointIdentifier": "abc123",
"administrativeArea": "abc123",
"country": "abc123"
}BillingDocumentIssuanceFrequencyInput
Input type for the BillingDocumentIssuanceFrequencyTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
Example
{
"isVariable": true
}Input fields
| Name | Description |
|---|---|
| The key of the business detail. |
| The value of the business detail. |
Example
{
"key": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the call to add the metadata to. |
| List of metadata items to add to the call. |
Example
{
"callId": "abc123",
"metadata": CallMetadataItemInput
}Input fields
| Name | Description |
|---|---|
| Whether this metadata item should be hidden on the support site and kraken phone. |
| The key of the metadata item. |
| The value of the metadata item. |
Example
{
"key": "abc123",
"value": "abc123",
"hideOnSupportSite": true
}Input fields
| Name | Description |
|---|---|
| The account number of the item. |
| The end of the call window for the item. |
| The start of the call window for the item. |
| The metadata of the item. |
| The phone number of the item. |
Example
{
"phoneNumber": "abc123",
"callWindowStart": "2020-01-01T00:00:00.000Z",
"callWindowEnd": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"metadata": {"key": "value"}
}CancelEnrollmentInput
Input required to cancel an enrollment.
Input fields
| Name | Description |
|---|---|
| The Kraken account number. Deprecated The 'accountNumber' field is deprecated. |
| The identifier of the process to cancel. |
| The reason for the cancellation. |
| Information of the supply points included in the enrollment to be cancelled. Deprecated The 'supplyPoints' field is deprecated. |
Example
{
"number": "abc123",
"accountNumber": "abc123",
"reason": "abc123",
"supplyPoints": SupplyPointInfoInput
}CancelLeaveSupplierInput
Input required to cancel a LeaveSupplier journey.
Input fields
| Name | Description |
|---|---|
| The ID of the LeaveSupplier process to cancel. Deprecated The 'leaveSupplierProcessId' field is deprecated. |
| |
| The ID of the LeaveSupplier process to cancel. |
| The reason for the cancellation. |
Example
{
"number": NonEmptyID,
"leaveSupplierProcessId": NonEmptyID,
"reason": "abc123",
"marketData": CancelLeaveSupplierMarketInputType
}Input fields
| Name | Description |
|---|---|
| Input types cannot be without fields. And because no market cancellation input type is defined, we must have a void field. |
Example
{
"voidField": "abc123"
}Input fields
| Name | Description |
|---|---|
| When true, automatically updates the request status to match the appointment if no active appointments remain. Example: Cancelling the last active appointment on a request will also cancel the request. |
| The ID of the appointment. |
| The cancellation reason for this appointment. |
Example
{
"appointmentId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"alignRequestStatus": true,
"cancellationCategory": "CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ID of the payment to cancel. |
| Reason for cancelling the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The id of the request to be cancelled. |
Example
{
"requestId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding wizard to cancel. |
Example
{
"wizardId": "abc123"
}CharacteristicOverride
Override for a product characteristic.
Input fields
| Name | Description |
|---|---|
| The code of the characteristic to override. |
| Override the characteristic with a list of values. |
Example
{
"code": "abc123",
"values": {"key": "value"}
}CharacteristicOverrideConfigurationInput
Input type for the CharacteristicOverrideConfigurationTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| List of characteristic overrides. |
Example
{
"isVariable": true,
"overrides": CharacteristicOverrideInputType
}CharacteristicOverrideInputType
Input type for overriding a product characteristic.
Input fields
| Name | Description |
|---|---|
| The code of the characteristic to override. |
| Override the characteristic with a list of values. |
| Optional product code. If specified, the override applies only to this product. |
Example
{
"characteristicCode": NonEmptyString,
"overrideValue": {"key": "value"},
"productCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The characteristic code. |
| The value for the characteristic. |
Example
{
"characteristicCode": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"line1": "abc123",
"line2": "abc123",
"city": "abc123",
"code": "abc123",
"country": "abc123"
}Example
{
"lat": "abc123",
"lon": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
|
Example
{
"id": "abc123",
"shortName": "abc123",
"descriptor": "abc123",
"fullName": "abc123",
"gps": ChargeNetGPSType,
"address": ChargeNetAddressType
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| Transaction end time. |
| Measurement of kWh. |
| Transaction start time. |
Example
{
"type": "CHARGE",
"billTo": "CREDIT",
"costInclGst": "abc123",
"costExclGst": "abc123",
"kWh": "abc123",
"startTime": "2020-01-01T00:00:00.000Z",
"endTime": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The DCA agency owning the proceeding. |
| The campaign for the proceeding. |
| The ledger identifier. |
| Whether to send a notification to the DCA. |
| The reason for stopping. |
| The date where dca proceeding stopped. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"stopReason": "abc123",
"stoppedDate": "2020-01-01",
"notifyDca": true,
"agency": "abc123",
"campaign": "abc123"
}Input fields
| Name | Description |
|---|---|
| The reason for closing the conversation. |
| The relay id of the conversation to close. |
Example
{
"conversationRelayId": "abc123",
"closeReason": "AGENT_CLOSED"
}Input fields
| Name | Description |
|---|---|
| The number of the Kraken account that the conversation is from. Required for Account User authorization. |
| The relay id of the live chat conversation. |
Example
{
"accountNumber": "abc123",
"liveChatConversationRelayId": "abc123"
}CollateralRequiredInput
Input type for CollateralRequiredTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
Example
{
"isVariable": true
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The payment amount (in cents). |
| The type of the payment instruction. |
| The reason a payment is being collected, for internal audit purposes. |
| |
| The ID of the ledger on which to collect the payment. Deprecated The 'ledgerId' field is deprecated. |
| The number of the ledger on which to collect the payment. |
| The date to attempt to take the payment. Cannot be a date in the past. Payment will be collected on the requested date or as soon as possible after that date. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"description": "abc123",
"idempotencyKey": "abc123",
"collectionMethod": "BPAY",
"ledgerId": "abc123",
"ledgerNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The agency. |
| Amount of debt. |
| The campaign. |
| The date where commencement started. |
| If the commencement is white label. |
| The ledger identifier. |
| Notes for the commencement. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"agency": "abc123",
"campaign": "abc123",
"isWhiteLabel": true,
"dateStarted": "abc123",
"amount": 1,
"notes": "abc123"
}Input fields
| Name | Description |
|---|---|
| The entire continuation URI returned by the vendor. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"continuationUri": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number that the device is registered to. |
| External reference in the third-party system to identify the device. |
| Postcode of the property (linked to the account) that the device is registered to. |
Example
{
"accountNumber": "abc123",
"postalCode": "abc123",
"externalDeviceIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123"
}CompleteStandalonePaymentInput
Input fields for completing a standalone payment.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The vendor's token used to complete the operation. |
| The token used to identify this payment to ensure it is only processed once. |
| The number of the specific ledger against which this payment should be applied. |
| The retrieval token for this standalone payment. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"retrievalToken": "abc123",
"completionToken": "abc123",
"idempotencyKey": "abc123"
}Input fields
| Name | Description |
|---|---|
| The IP address of the customer confirming the double opt-in, if applicable. |
| The token for the consent to be updated. |
Example
{
"token": "abc123",
"ipAddress": "abc123"
}Input fields
| Name | Description |
|---|---|
| The code of the consent type. |
| The value to update the consent to. |
Example
{
"code": "abc123",
"value": "ACCEPTED"
}Input fields
| Name | Description |
|---|---|
| The code of the consent type. |
| The source of the consent event. |
| The value to update the consent to. |
Example
{
"consentTypeCode": "abc123",
"value": "ACCEPTED",
"source": "CONSUMER_SITE"
}ContractFiltersInput
Input type for filtering contracts by party or subject.
Input fields
| Name | Description |
|---|---|
| Filter contracts by party (the entity that signed the contract). Provide either an account number or business ID. |
| Filter contracts by subject (the account impacted by the contract). Provide the account number. |
Example
{
"party": PartyInput,
"subject": NonEmptyString
}ContractMetaDataInput
Input type for the ContractMetaDataTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| The additional metadata of the contract. |
Example
{
"isVariable": true,
"metadata": {"key": "value"}
}ContractNoteInput
Input for capturing a note alongside a contract journey mutation.
Input fields
| Name | Description |
|---|---|
| Optional free-text note (max 1,000 characters). |
| The slug of the reason for this note. |
Example
{
"reasonSlug": NonEmptyString,
"note": "abc123"
}ContractedVolumeConfigurationInput
Input type for the ContractedVolumeConfigurationType.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| The periods for the contracted volume configuration. |
Example
{
"isVariable": true,
"periods": ContractedVolumePeriodInput
}Input fields
| Name | Description |
|---|---|
| The market name the contracted volume applies to. |
| The unit for the commodity provided by the contracted volume. |
| The datetime the period the contracted volume is valid from. |
| The datetime the period the contracted volume is valid to. |
| The decimal value of the quantity provided by the contracted volume. |
Example
{
"value": "1.0",
"unit": "abc123",
"marketName": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception, if any. |
| Any optional useful context involved in the API call. |
| The correlation id header from the HTTP request. |
| The input data provided to the API, if any. |
| The name of the operation associated with this call. |
| The response returned by the API. |
Example
{
"correlationId": "abc123",
"operationName": "abc123",
"inputData": {"key": "value"},
"response": {"key": "value"},
"context": {"key": "value"},
"apiExceptionId": 1
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception, if any. |
| The event category. |
| Any optional useful context involved in the event. |
| Any useful event description. |
| The event type. |
Example
{
"eventType": "abc123",
"category": "abc123",
"description": "abc123",
"context": {"key": "value"},
"apiExceptionId": 1
}Input fields
| Name | Description |
|---|---|
| The account number associated with the exception, if available. |
| The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception. |
| Category associated with this exception. Uses the default category if not provided. |
| The API client channel where the exception was triggered from. |
| Contextual information about the exception, if any. |
| The customer contact associated with the exception, if available. |
| External identifier mapping an entity on the client's database. |
| The key date associated with the exception, if available. |
| The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception. |
| The priority. Defaults to LOW if not provided. |
| The resolution status. Defaults to UNASSIGNED if not provided. |
| The resolution type. Defaults to UNASSIGNED if not provided. |
| The supply point identifier associated with the exception, if available. |
| Tags associated with this exception if any. |
| The user ID associated with the exception, if available. |
Example
{
"externalIdentifier": "abc123",
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"context": {"key": "value"},
"channel": "abc123",
"assignedUserId": 1,
"operationsTeamId": 1,
"tags": "MOVE_IN",
"category": "UNKNOWN",
"accountNumber": "abc123",
"userId": 1,
"customerContact": "abc123",
"supplyPointIdentifier": "abc123",
"keyDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The ID of the associated API exception. |
| The body of the note. |
Example
{
"body": "abc123",
"apiExceptionId": "abc123"
}CreateAccountChargeInput
The input type for the account charge.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The climate change levy amount of the charge to be added. Deprecated The 'cclAmount' field is deprecated. |
| Optional short note about account charge for customer display. |
| The gross amount of the charge to be added. |
| Any extra data that will be associated with account charge. |
| The net amount of the charge to be added. Deprecated The 'netAmount' field is deprecated. |
| Optional short note about account charge for internal use. |
| The reason why the charge is added to the account. This should be a valid charge reason code. |
| The sales tax amount of the charge to be added. Deprecated The 'salesTaxAmount' field is deprecated. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"cclAmount": 1,
"metadata": {"key": "value"},
"note": "abc123",
"displayNote": "abc123",
"reason": "abc123"
}CreateAccountCreditInput
The input type for the account credit.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The gross amount of the credit to be created. |
| Any extra data that will be associated with account credit. |
| The net amount of the credit to be created. |
| Optional short note about account credit. |
| The reason why the credit is added to the account. |
| The sales tax amount of the credit to be created. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"grossAmount": 1,
"salesTaxAmount": 1,
"metadata": {"key": "value"},
"note": "abc123",
"reason": "EXTERNAL_REFERRAL_CREDIT"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Pin the note to account. |
| The note to add. |
| When to unpin the note from the account. |
Example
{
"accountNumber": "abc123",
"note": "abc123",
"isPinned": true,
"unpinAt": "2020-01-01T00:00:00.000Z"
}CreateAccountPaymentScheduleInput
Input type for updating the payment schedule on a ledger. Requires an account_number, ledger_number and at least one of payment_day or payment_amount to be provided. trigger and amount_strategy should be provided when updating the payment amount of a variable payment schedule.
Input fields
| Name | Description |
|---|---|
| Number of the account for which to update the schedule. |
| How the payment value is determined. |
| Number of the ledger associated with the current payment schedule. |
| The new fixed payment amount. |
| The new day of the month at which to take payment; ranges from 1 to 28. |
| When a payment is due. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"paymentDay": 1,
"paymentAmount": 1,
"trigger": "PLAN",
"amountStrategy": "FIXED"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Reminder content. |
| When the reminder is due. |
| The reminder type. |
Example
{
"accountNumber": "abc123",
"reminderType": "AD_HOC",
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The contact email for the link. |
| The contact name for the link. |
| The organisation for whom to create the affiliate link for. |
| Will be validated as follows:
|
Example
{
"organisationId": "abc123",
"subdomain": "abc123",
"contactName": "abc123",
"contactEmail": "abc123"
}Input fields
| Name | Description |
|---|---|
| Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
| Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
| Allow registration requests with customers without an email address. |
| Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
| Allow performing tariff renewals via API. |
| Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
| The primary contact email for the organisation. |
| Default Account Type. |
| Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
| The name of the organisation that is going to be created. |
| Sales Channel. Deprecated The 'salesChannel' field is deprecated. |
| Sales Channel Code. |
| Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"name": "abc123",
"contactEmail": "abc123",
"salesChannel": "DIRECT",
"salesChannelCode": "abc123",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true
}Input fields
| Name | Description |
|---|---|
| The IP Address of the user. |
| The affiliate link for whom to create the session for. |
| Additional query parameters to attach to this session. |
| The quote share that led to this session. |
| The HTTP user agent. |
Example
{
"linkId": "abc123",
"ipAddress": "abc123",
"userAgent": "abc123",
"queryParams": {"key": "value"},
"quoteShareId": "abc123"
}Input fields
| Name | Description |
|---|---|
| A code that uniquely identifies the account. |
| The date and time when the agreement was made. |
| A dictionary of additional parameters for the agreement. |
| A code that uniquely identifies the product. |
| The deadline date and time for rescinding the agreement. |
| The external identifier of the supply point. |
| The start date of the agreement. |
| The end date of the agreement (exclusive). |
Example
{
"accountNumber": "abc123",
"supplyPointExternalIdentifier": "abc123",
"productCode": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"agreedAt": "2020-01-01T00:00:00.000Z",
"params": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"rescissionDeadlineAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Identification of the account that is requesting the agreement rollover. |
| Identification of the agreement that is being rolled over. |
| The expected date when the agreement rollover will be executed.If not provided, will calculate it taking into account the valid to date of the agreement. |
| A JSON object containing additional parameters for the agreement rollover. Ensure it's properly encoded. |
| The product code for the new agreement. |
| If the agreement is open-ended, will terminate the agreement on this date. |
| Suppress Agreement Rollover communications. |
| List of comma-separated tags to be added to the rollover. |
Example
{
"accountNumber": "abc123",
"currentAgreementId": "abc123",
"renewProductCode": "abc123",
"rolloverDate": "2020-01-01",
"expectedSendDate": "2020-01-01",
"suppressComms": true,
"tags": ["abc123"],
"params": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Input fields
| Name | Description |
|---|---|
| The billing address for the business. |
| Additional details for the business. |
| The legal address for the business. |
| The business' name. |
| The business' number. |
| The list of sectors the business operates in. |
| The company type of a business account. |
Example
{
"businessName": "abc123",
"businessNumber": "abc123",
"businessType": "SOLE_TRADER",
"businessDetails": BusinessDetailInput,
"businessBillingAddress": RichAddressInput,
"businessLegalAddress": RichAddressInput,
"businessSectors": [BusinessSectorString]
}Input fields
| Name | Description |
|---|---|
| The campaign ID. |
| The items to add. |
Example
{
"campaignId": "abc123",
"campaignItems": CampaignItemInput
}Input fields
| Name | Description |
|---|---|
| Additional data about the event (e.g., error details, reactivation reason). |
| The type of event that occurred. |
| The Collection Process Record Number. |
| When the event actually occurred. If not provided, uses current time. |
Example
{
"number": "abc123",
"eventType": "REACTIVATION_PENDING",
"occurredAt": "2020-01-01T00:00:00.000Z",
"data": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The account number of the account the complaint is for. |
| The brand associated with the complaint. |
| Source of the complaint. |
| The preferred communication method. Deprecated The 'preferredCommunicationMethod' field is deprecated. |
| The complainant's preferred contact method. |
| The complaint status. |
| Complaint subtype. |
| A summary of the complaint. |
| Complaint type. |
Example
{
"accountNumber": "abc123",
"type": "abc123",
"subtype": "abc123",
"summary": "abc123",
"preferredCommunicationMethod": "LANDLINE",
"preferredContactMethod": "abc123",
"communicationSource": "TELEPHONE",
"status": "abc123",
"brand": "abc123"
}CreateContractInput
Input type for creating a contract.
Input fields
| Name | Description |
|---|---|
| The party for the contract. |
| The sale metadata associated with the contract. |
| Date when the contract was signed. |
| The accounts impacted by this contract, supplied as a list of account numbers. This field is only applicable when the party is a business. |
| The terms of the contract. |
| Title of the contract. |
| Date from which the contract is valid. |
| Date until which the contract is valid. Leave null for open-ended contracts. |
Example
{
"party": PartyInput,
"subject": [NonEmptyString],
"terms": OneOfTermInput,
"signedAt": "2020-01-01T00:00:00.000Z",
"validFrom": "2020-01-01T00:00:00.000Z",
"validTo": "2020-01-01T00:00:00.000Z",
"title": NonEmptyString,
"sale": SalesDetailsInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The start datetime of the agreement. |
| The end datetime of the agreement, if any. |
| The amount contributed per interval. Note, this is in the smallest domination that the currency supports. e.g. Pence, Cents, Yen, etc. |
| The frequency of contributions. |
| The code of the scheme to contribute to. |
Example
{
"accountNumber": "abc123",
"schemeCode": "abc123",
"interval": "MONTHLY",
"amount": 1,
"activeFrom": "2020-01-01T00:00:00.000Z",
"activeTo": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Source ledger number. |
| Target ledger number. |
Example
{
"sourceLedgerNumber": "abc123",
"targetLedgerNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The number of the affected account. |
| The id of the affected user. |
| The number of the affected user. |
| The source of the feedback. |
| The id of the ink conversation that triggered this feedback request. |
| The id of the support user who last contacted the customer. |
| The id of the voice call (new call system) that triggered this feedback request. |
Example
{
"accountNumber": "abc123",
"feedbackSource": "abc123",
"accountUserId": 1,
"accountUserNumber": "abc123",
"voiceCallId": 1,
"inkConversationId": 1,
"lastContactedSupportUserId": 1
}Input fields
| Name | Description |
|---|---|
| The number of the account that the event should be created for. |
| The category of the event. |
| An array of content data associated with the event. |
| A human-readable description of the event. |
| The time the event occurred. |
| The subcategory of the event. |
Example
{
"accountNumber": "abc123",
"category": "COMMUNICATIONS",
"subcategory": "TELEPHONE",
"description": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": ExternalAccountEventContent
}Input fields
| Name | Description |
|---|---|
| The category of the event. |
| An array of content data associated with the event. |
| A human-readable description of the event. |
| The time the event occurred. |
| The subcategory of the event. |
| The user that the event should be created for. |
Example
{
"userId": "abc123",
"category": "COMMUNICATIONS",
"subcategory": "TELEPHONE",
"description": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": ExternalAccountEventContent
}Input fields
| Name | Description |
|---|---|
| The account number of the account to link this message to. |
| Content specific for emails. If the message sent was an email, then this should be provided. |
| The date and time this message was sent. |
| The name of the external messaging vendor that sent this message (for example, 'SENDGRID'). |
| The unique ID of the message in the external vendor's system. |
Example
{
"vendor": "abc123",
"vendorMessageId": "abc123",
"sentAt": "2020-01-01T00:00:00.000Z",
"accountNumber": "abc123",
"emailContent": EmailContentInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the quote. |
| A JSON object containing market parameters to store on the quote. |
| Products to get a quote for. |
Example
{
"accountNumber": "abc123",
"productsToQuote": ProductToQuoteInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| A JSON object containing client parameters to store on the quote. |
| Customer profile. |
| A JSON object containing market parameters to store on the quote. |
| Products to get a quote for. |
Example
{
"customerProfile": CustomerProfileInput,
"productsToQuote": ProductToQuoteInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The phone number that the call is from. |
| The phone number that the call is to. |
| The Voice vendor managing the call. |
| The ID of the call in the vendor's system. |
Example
{
"fromPhoneNumber": "abc123",
"toPhoneNumber": "abc123",
"vendor": "TWILIO",
"vendorCallId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The number of the Kraken account that the message was from. |
| The channel type the posted message should be treated as in Ink. It is used to determine how the message should be processed and what channel-specific features are available for this message. |
| An optional parameter where we can pass the generic message headers if it has one Email channel tries to get the value |
| An arbitrary, unique ID for this message. This must be unique for each message that is supplied using the same organisation; collisions between messages provided by different organisations are tolerated. Stored as vendor_id. |
| |
| When the message occurred in the system of origin. |
| An optional vendor value to denote which system it originated from. If no vendor is passed, we will get the default generic vendor from the setting called INKDEFAULTGENERICMESSAGEAPI_VENDOR. |
Example
{
"accountNumber": "abc123",
"channel": "EMAIL",
"messageId": "abc123",
"newMessage": InkMessageInput,
"vendor": "abc123",
"messageHeaders": {"key": "value"},
"occurredAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The number of the Kraken account that the message was from. |
| An arbitrary, unique ID for this message. Used in combination with vendor to guarantee uniqueness of the message in Ink. Stored as vendor_id. |
| |
| When the message occurred in the system of origin. |
| An optional value that is used in conjunction with message_id to guarantee uniqueness of a message in Ink. It is usually name of the system the message originated from. If not supplied, Ink provides a default system value. |
Example
{
"accountNumber": "abc123",
"messageId": "abc123",
"newMessage": InkMessageInput,
"vendor": "abc123",
"occurredAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The legal address of the internal company. |
| The name of the internal company. |
| The registration number deemed as primary for the internal company. |
| The tax identifier number deemed as primary for the internal company. |
| The registration number deemed as secondary for the internal company. |
Example
{
"name": "abc123",
"primaryRegistrationNumber": "abc123",
"secondaryRegistrationNumber": "abc123",
"primaryTaxIdentifierNumber": "abc123",
"legalAddress": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| Account number's external identifier. |
| The address for the lead. |
| The ID of the affiliate organisation. Deprecated The 'affiliateOrganisationId' field is deprecated. |
| The number of the affiliate organisation assigned to the lead. |
| The team associated with the lead. |
| The username of the user assigned to the lead. |
| Consents to be associated with the lead. |
| The extra details for the lead. |
| The code of the funnel. Deprecated The 'funnelCode' field is deprecated. |
| A list of contact details for the lead. |
| The type of the lead. |
| The national ID. |
| The sales channel of the lead. |
Example
{
"funnelCode": "abc123",
"affiliateOrganisationId": 1,
"assignedToAffiliateNumber": "abc123",
"assignedToUsername": "abc123",
"assignedToTeamName": "abc123",
"salesChannel": "abc123",
"leadContacts": LeadContactDetailsInput,
"leadType": "BUSINESS",
"nationalId": "abc123",
"consents": ConsentTypeInput,
"address": RichAddressInput,
"extraDetailsItems": ExtraDetailsItem,
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| MFA enrolment method. |
Example
{
"mfaMethod": "EMAIL"
}Input fields
| Name | Description |
|---|---|
| ID of the product switch process model already initiated. |
Example
{
"productSwitchProcessId": "abc123"
}Input fields
| Name | Description |
|---|---|
| List of Offerings. |
Example
{
"productOfferings": OfferingForQuotingInput
}Input fields
| Name | Description |
|---|---|
| Request related assets. |
| Comment for the request. |
| Details to be reviewed by the approver when the request is an emergency requiring approval. |
| Is emergency. |
| Ignore any warnings raised by the request checks. |
| Request reporter. |
| Run validation checks before creating the request. Cannot be false when using AccountUser authentication. |
| Request status. This value may be overridden to APPROVAL_PENDING if the reason or emergency requires approval. |
| Supply point external identifier to market name mappings to associate with the request. If this is provided, |
| List of internal IDs of supply points to associate with the request. If this is provided, |
Example
{
"supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput,
"supplyPointInternalIds": [1],
"comment": "abc123",
"status": "IN_PROGRESS",
"isEmergency": true,
"emergencyApprovalDetails": "abc123",
"reporter": ReporterInput,
"assets": OnSiteJobsAssetInput,
"runRequestChecks": true,
"overrideRequestCheckWarnings": true
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The billing address for the lead. |
| The ID of the affiliate organisation. Deprecated The 'affiliateOrganisationId' field is deprecated. |
| The number of the affiliate organisation the opportunity is assigned to. |
| The name of the team the opportunity is assigned to. |
| The username of the user to assign the opportunity to. |
| Consents to be associated with the opportunity. |
| The extra details for the opportunity. |
| The code of the funnel. |
| The contact details for the lead. |
| The type of the lead. |
| The national ID. |
| Notes about the opportunity. |
| The address for the opportunity. |
| The ID of the product offering. |
| The sales channel of the opportunity. |
| Supply points for the opportunity. |
| Whether to use the same address for billing. |
Example
{
"funnelCode": "abc123",
"affiliateOrganisationId": 1,
"assignedToAffiliateNumber": "abc123",
"assignedToUsername": "abc123",
"assignedToTeamName": "abc123",
"salesChannel": "abc123",
"notes": "abc123",
"extraDetailsItems": _CreateOpportunityExtraDetailsItem,
"useSameAddressAsBilling": true,
"supplyPoints": LeadSupplyPoint,
"productOfferingId": "abc123",
"leadContactDetails": LeadContactDetailsInput,
"leadType": "abc123",
"nationalId": "abc123",
"accountNumber": "abc123",
"consents": ConsentTypeInput,
"address": RichAddressInput,
"opportunityAddress": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| The category of the file being created. |
| The unique number of the opportunity. |
| S3 key for the file attachment. |
Example
{
"opportunityNumber": "abc123",
"s3Key": "abc123",
"category": "LEAD_FILE"
}Input fields
| Name | Description |
|---|---|
| The address for the opportunity. |
| The ID of the affiliate organisation. Deprecated The 'affiliateOrganisationId' field is deprecated. |
| The number of the affiliate organisation the opportunity is assigned to. |
| The name of the team the opportunity is assigned to. |
| The username of the user to assign the opportunity to. |
| The extra details for the opportunity. |
| The code of the funnel. |
| The number of the lead. |
| Notes about the opportunity. |
| The ID of the product offering. |
| The sales channel of the opportunity. |
| Supply points for the opportunity. |
| Whether to use the same address for billing. |
Example
{
"funnelCode": "abc123",
"affiliateOrganisationId": 1,
"assignedToAffiliateNumber": "abc123",
"assignedToUsername": "abc123",
"assignedToTeamName": "abc123",
"salesChannel": "abc123",
"notes": "abc123",
"extraDetailsItems": _CreateOpportunityExtraDetailsItem,
"useSameAddressAsBilling": true,
"supplyPoints": LeadSupplyPoint,
"leadNumber": "abc123",
"productOfferingIdentifier": "abc123",
"address": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| The id of the account user. |
| The number of the loyalty card. |
| The scheme of the loyalty card. |
Example
{
"accountUserId": "abc123",
"scheme": "abc123",
"number": "abc123"
}CreateOrUpdateTimeSeriesEntriesInput
All information provided in order to create or update time series entries associated with an existing time series.
Input fields
| Name | Description |
|---|---|
| The time series code. |
| The time series entries. |
| The product code associated to the time series. |
Example
{
"code": NonEmptyString,
"productCode": NonEmptyString,
"entries": TimeSeriesEntryInput
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The unique string used to identify this intent to ensure it is only processed once. |
| The unique identifier for the target the payment should be associated with. |
| The type of target the payment should be associated with. |
Example
{
"accountNumber": "abc123",
"targetType": "ledger",
"targetIdentifier": "abc123",
"idempotencyKey": "abc123"
}Input fields
| Name | Description |
|---|---|
| The brand to associate with this portfolio, if not provided the default brand will be used. |
| Whether collective bills should be issued for the portfolio's accounts. The default value is False. |
| The ID of the operations team to associate with this portfolio.If no team is provided, no team will be assigned to the portfolio. |
Example
{
"brandCode": "abc123",
"operationsTeamId": "abc123",
"collectiveBilling": true
}Input fields
| Name | Description |
|---|---|
| The user to associate with the portfolio. |
| The portfolio to associate the user with. |
| The role to assign to the user. If not provided the default role will be used. |
Example
{
"portfolioId": "abc123",
"accountUserId": "abc123",
"role": RoleString
}Input fields
| Name | Description |
|---|---|
| List of post events to create. |
Example
{
"events": PostEventInput
}CreateProductInput
Input type for creating a product.
Input fields
| Name | Description |
|---|---|
| The product availability status. |
| The date the product is available from. |
| The date the product is available to. |
| The brand code. |
| Overrides for product characteristics. |
| The product code. |
| The product description. |
| The product description. |
| The date the product ends. |
| The product title. |
| Whether the product is hidden. |
| The name of the market the product belongs to. |
| The product notes. |
| The product parameters. |
| The product specification code. |
| The product specification ID. Deprecated The 'specificationIdentifier' field is deprecated. |
| Tags associated with the product. |
| The product term in months. |
| A list of terms and conditions specified by codes to associate with the product. |
| The product contract type. |
Example
{
"marketName": NonEmptyString,
"code": NonEmptyString,
"brandCode": NonEmptyString,
"notes": "abc123",
"fullName": NonEmptyString,
"displayName": NonEmptyString,
"description": "abc123",
"availableFrom": "2020-01-01T00:00:00.000Z",
"availableTo": "2020-01-01T00:00:00.000Z",
"isHidden": true,
"tags": "abc123",
"term": 1,
"endsAt": "2020-01-01T00:00:00.000Z",
"availabilityStatus": "EVERYONE",
"termsContractType": "abc123",
"termsAndConditionsTypes": "abc123",
"params": {"key": "value"},
"specificationCode": "abc123",
"specificationIdentifier": "abc123",
"characteristicOverrides": CharacteristicOverride
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the purchase. |
| A JSON object containing client parameters to store on the purchase. |
| Products being purchased. |
Example
{
"accountNumber": "abc123",
"saleItems": ProductToPurchaseInput,
"clientParams": {"key": "value"},
"marketParams": {"key": "value"}
}CreateReferralInput
Required information for creating a referral
Input fields
| Name | Description |
|---|---|
| The account number for the referred account. |
| A referral code, e.g. grey-badger-47. |
Example
{
"accountNumber": "abc123",
"reference": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The id of the user responsible for completing the reminder. |
| The id of the team responsible for completing the reminder. |
| The name of the team responsible for completing the reminder. |
| The username of the user responsible for completing the reminder. |
| The business ID. |
| Reminder content. |
| When the reminder is due. |
| The reminder type name. |
| Reopen ink conversation. |
Example
{
"accountNumber": "abc123",
"businessId": 1,
"reminderTypeName": "abc123",
"content": "abc123",
"dueAt": "2020-01-01T00:00:00.000Z",
"assigneeUsername": "abc123",
"assigneeId": "abc123",
"assigneeTeamName": "abc123",
"assigneeTeamId": "abc123",
"reopenInkConversation": true
}Input fields
| Name | Description |
|---|---|
| Whether the scheduled transaction is a 'CHARGE' or a 'CREDIT'. |
| Additional data that will be consumed and associated with the scheduled transaction. |
| Optional short note about the scheduled transaction for customer display. |
| The gross amount of the scheduled transaction. |
| Unique identifier for the scheduled transaction. |
| Optional short note about the scheduled transaction for internal use. |
| The number of the ledger the scheduled transaction is for. |
| Any extra data that will be associated with scheduled transaction. |
| The net amount of the scheduled transaction. |
| The schedule on which the scheduled transaction will be posted. |
| The reason why the scheduled transaction is added to the account. Based on the input this should be a valid charge or a valid credit reason code. |
| The tax amount of the scheduled transaction. |
| The tax rate of the scheduled transaction. |
Example
{
"action": "abc123",
"grossAmount": 1,
"netAmount": 1,
"taxAmount": 1,
"taxRate": "1.0",
"reason": "abc123",
"idempotencyKey": "abc123",
"postedAfter": "2020-01-01T00:00:00.000Z",
"ancillaryData": {"key": "value"},
"metadata": {"key": "value"},
"internalNote": "abc123",
"displayNote": "abc123",
"ledgerNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| Day to fixed bill on if billingperiodlength set. |
| For fixed billing accounts only, the length of their billing period. Can be MONTHLY or QUARTERLY. |
| Month to start billing from if billingperiodlength set to QUARTERLY or the multiplier is > 1. |
| For fixed billing accounts only, the number the period length is to be multiplied by to get the total period length, i.e. for billing every second month, select 2 combined with a billing period length MONTHLY. Can't be > 1 for quarterly billing. |
| |
| This must be a string-ified version of the JSON representation of RichAddressInput type. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"portfolioNumber": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"billingName": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"brand": "abc123",
"dateOfBirth": "2020-01-01",
"billingAddressLine1": "abc123",
"billingAddressLine2": "abc123",
"billingAddressLine3": "abc123",
"billingAddressLine4": "abc123",
"billingAddressLine5": "abc123",
"billingPostcode": "abc123",
"billingRichAddress": "abc123",
"billingPeriodLength": "abc123",
"billingPeriodMultiplier": 1,
"billingPeriodDay": 1,
"billingPeriodMonth": 1,
"isBusinessAccount": true,
"companyName": "abc123",
"companyNumber": "abc123",
"businessType": "abc123",
"password": "abc123",
"passwordUpdateToken": "abc123",
"urn": "abc123",
"clientMutationId": "abc123"
}CreateTimeSeriesPricesInput
Input data to create prices associated with the time series represented by the code.
Input fields
| Name | Description |
|---|---|
| The time series code. |
| The time series entries. |
| The product code associated to the time series. |
Example
{
"code": NonEmptyString,
"productCode": NonEmptyString,
"entries": TimeSeriesEntryInput
}CustomerDetailsInput
Details about the customer.
Input fields
| Name | Description |
|---|---|
| The customer's date of birth. |
| Account email. |
| Family name. |
| Given name. |
| A free text field to help identifying the customer (e.g. for a job title). |
| Account landline number. |
| Account mobile phone number. |
| The customer's communication preferences. |
| The customer's pronouns. |
| The customer's title. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"title": "abc123",
"pronouns": "abc123",
"email": "abc123",
"mobile": "abc123",
"landline": "abc123",
"dateOfBirth": "2020-01-01",
"label": "abc123",
"preferences": UpdateAccountUserCommsPreferencesInput
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
|
Example
{
"answer": "abc123",
"issueResolved": true,
"formId": 1,
"feedbackId": 1,
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Line 1 of customer's address. |
| Line 2 of customer's address. |
| Line 3 of customer's address. |
| Line 4 of customer's address. |
| Line 5 of customer's address. |
| Customer's email. |
| Customer's family name. |
| Customer's given name. |
| Customer's phone number. |
| Customer's postcode. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"postcode": "abc123",
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "abc123",
"addressLine4": "abc123",
"addressLine5": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The most recently registered device of this type will be de-authenticated. |
Example
{
"accountNumber": "abc123",
"deviceType": "BATTERIES"
}Input fields
| Name | Description |
|---|---|
| Device ID. |
Example
{
"deviceId": "abc123"
}DeductLoyaltyPointsInput
The input type for deducting Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The related user id to deduct points from. The primary account user will have their points deducted if this isn't present. |
| A unique idempotency key for the deduction operation. |
| A note about the deduction. |
| The number of Loyalty Points to deduct. |
| The reason code associated with the deduction. |
Example
{
"accountNumber": "abc123",
"accountUserId": "abc123",
"points": 1,
"reasonCode": "POINTS_DEDUCTED_FOR_ACCOUNT_ACTION",
"note": "abc123",
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}DelayerDaysInput
Input type for the PaysByDirectDebitTerm.
Input fields
| Name | Description |
|---|---|
| Number of days to delay based on delay strategy. |
| Whether the term is variable. |
| Defines the method for calculating the delay period. |
Example
{
"isVariable": true,
"days": 1,
"strategy": "FIXED"
}Input fields
| Name | Description |
|---|---|
| The account number associated with the removed AccountReference. |
| The namespace associated with the removed AccountReference. |
Example
{
"accountNumber": "abc123",
"namespace": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
Example
{
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| MFA method. |
Example
{
"mfaMethod": "EMAIL"
}DeletePropertyDescendantsInput
Input for deleting all descendants of a property in a hierarchy.
Input fields
| Name | Description |
|---|---|
| The name of the hierarchy. |
| The ID of the property whose descendants should be deleted. |
Example
{
"propertyId": "abc123",
"hierarchyName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Device push notification token. |
Example
{
"token": "abc123"
}Input fields
| Name | Description |
|---|---|
| Supply point external identifier. |
| Datetime period start to look for supply point. |
Example
{
"supplyPointExternalId": "abc123",
"supplyPointPeriodStart": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Namespace of the detail. |
| Value of the detail. |
Example
{
"namespace": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| Auxiliary device variant id. |
| Unique device variant id. |
Example
{
"deviceVariantId": "abc123",
"auxDeviceVariantId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The authentication details required given the chosen provider. |
| The device type specific details required for registering a device. |
| The device type to be registered - batteries, electric vehicles, heat pumps or thermostats. |
| The ID of the property the device belongs to. |
| The provider used to authenticate the device. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"deviceType": "BATTERIES",
"provider": "BYD",
"deviceDetails": DeviceDetailsInput,
"authentication": AuthenticationInput
}Input fields
| Name | Description |
|---|---|
| The number of the account requesting the double opt-in. |
| The consent type code to create a consent for. |
| The email address of the customer requesting the double opt-in. |
| The IP address of the customer requesting the double opt-in. |
| The mobile number of the customer requesting the double opt-in. |
Example
{
"accountNumber": "abc123",
"emailAddress": "abc123",
"mobileNumber": "abc123",
"consentTypeCode": "abc123",
"ipAddress": "abc123"
}ElectricityFiltersInput
Filter measurements by electricity parameters.
Input fields
| Name | Description |
|---|---|
| The identifier of the specific device associated to this reading. |
| The identifier of the market supply point associated to this reading. |
| Reading direction is based on the utility generated or consumed by the customer. |
| The frequency of the reading. |
| |
| The identifier of the register associated to this reading. |
Example
{
"readingFrequencyType": "RAW_INTERVAL",
"marketSupplyPointId": "abc123",
"deviceId": "abc123",
"readingDirection": "CONSUMPTION",
"registerId": "abc123",
"readingQuality": "ACTUAL"
}Input fields
| Name | Description |
|---|---|
| Actual Transfer Date. |
| Expected Transfer Date. |
| Electricity Trader Switch Gain Process ID to be updated. |
| Possible values: INITIATED: INITIATED REQUESTEDWITHREGISTRY: REQUESTEDWITHREGISTRY ACCEPTEDBYREGISTRY: ACCEPTEDBYREGISTRY REJECTEDBYREGISTRY: REJECTEDBYREGISTRY ACKNOWLEDGEDBYOTHERSUPPLIER: ACKNOWLEDGEDBYOTHERSUPPLIER TRANSFERCOMPLETED: TRANSFERCOMPLETED OPENINGREADRECEIVED: OPENINGREADRECEIVED WITHDRAWN: WITHDRAWN |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "abc123",
"expectedTransferDate": "2020-01-01",
"actualTransferDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| Actual Transfer Date. |
| Expected Transfer Date. |
| Electricity Trader Switch Loss Market Process ID to be updated. |
Possible values: INITIATED: INITIATED ACKNOWLEDGED: ACKNOWLEDGED TRANSFERCOMPLETED: TRANSFERCOMPLETED WITHDRAWN: WITHDRAWN |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "INITIATED",
"expectedTransferDate": "2020-01-01",
"actualTransferDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| An HTML email body. At least one of bodyTxt or bodyHtml must be provided. |
| A plain text email body. At least one of bodyTxt or bodyHtml must be provided. |
| Either the sender's email address or the sender's name and email address (for example, 'sender@example.com' or 'Sender Name sender@example.com'). |
| List of reply-to email addresses (for example, 'reply@example.com'). |
| The email subject line. |
| The recipient email address (for example, 'user@example.com'). |
Example
{
"subjectTxt": "abc123",
"bodyTxt": "abc123",
"bodyHtml": "abc123",
"toEmail": "abc123",
"fromEmail": "abc123",
"replyToEmails": ["abc123"]
}Input fields
| Name | Description |
|---|---|
| The ID of the Contribution Agreement to end. |
| The future end datetime of the agreement. If not given, terminate now. |
Example
{
"contributionAgreementId": "abc123",
"endAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The ID of the call to enqueue. |
| Whether to infer the preferred language of the calling account. |
| Whether to infer the operations group attributes of the calling account. |
| The priority with which the call should be routed. A higher number corresponds to a higher routing priority. |
| List of routing attribute references to add to the call. For example, 'SKILL.ENERGY'. Each attribute should already have been created in Kraken. |
| A URL that defines the behaviour of the call when it is enqueued and the caller is waiting. If not set, audio configured in Kraken will be played to the caller. The URL must return a response that can be interpreted by the vendor handling the call. For
example, if the call is handled by Twilio, TwiML supported by a |
Example
{
"callId": "abc123",
"routingAttributes": ["abc123"],
"priority": 1,
"waitingBehaviourUrl": "abc123",
"inferLanguageAttribute": true,
"inferOperationsGroupAttributes": true
}EnrollAccountInLoyaltyProgramInput
The input type for enrolling an account in loyalty program.
Input fields
| Name | Description |
|---|---|
| The account number to enroll. |
| The account user id to enroll. |
Example
{
"accountUserId": "abc123",
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The Kraken account number. |
| Bank details for setting up a payment instruction as part of the enrollment. |
| Contract identifiers for contracts that this journey's account is subject to. |
| Details of an externally created payment instruction to be recorded in Kraken. |
| If this is a house move, the number of the leave supplier process associated with the move out. |
| Enrollment note. |
| Details of the payment schedule(s) to be created as part of enrollment. |
| Payment slip details for setting up a payment instruction in the vendor's system as part of the enrollment. |
| Sales info for this enrollment. |
| Details of the security deposit to be created as part of enrollment. |
Example
{
"accountNumber": "abc123",
"bankDetails": BankDetailsInput,
"paymentSlipDetails": PaymentSlipDetailsInput,
"instructionDetails": InstructionDetailsInput,
"paymentSchedule": PaymentScheduleDetailsInput,
"securityDeposit": SecurityDepositInput,
"salesInfo": SalesInformationInput,
"note": "abc123",
"leaveSupplierNumber": "abc123",
"contractIdentifiers": ["abc123"]
}ExternalAccountEventContent
A piece of content associated with an external account event.
Input fields
| Name | Description |
|---|---|
| The content type of the content. |
| A human-readable description of the content. |
| The value of the content. |
Example
{
"description": "abc123",
"contentType": "PLAINTEXT",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| The key of the extra detail item to be added or modified. |
| The value of the extra detail item to be added or modified. |
Example
{
"key": "abc123",
"value": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Input fields
| Name | Description |
|---|---|
| The payment action intent details that identify the target for this payment. |
| The payment amount in the minor unit of currency. |
| The description of the payment, as shown to the customer. |
| The datetime when the payment failed. |
| The customer-facing description of the failure. |
| The reason for the failure. |
| The date when the payment was made. |
| The details of the payment method used for this payment. |
| The reference used to uniquely identify this payment. |
| The code the payment provider specified. |
Example
{
"actionIntent": PaymentActionIntentOneOfInput,
"reference": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"customerReference": "abc123",
"paymentMethod": PaymentMethodInput,
"failedAt": "2020-01-01T00:00:00.000Z",
"failureReason": "PAYMENT_INSTRUCTION_NOT_USABLE",
"failureDescription": "abc123",
"vendorFailureCode": "abc123"
}ForceReauthenticationInput
The input type for repudiating previously issued Kraken Tokens and refresh tokens.
Input fields
| Name | Description |
|---|---|
| Also force third-party applications you have authorized to use your account to reauthenticate. |
Example
{
"includeThirdParties": true
}Input fields
| Name | Description |
|---|---|
| |
| Form content. |
| Form type. |
Example
{
"accountNumber": "abc123",
"formType": "COVID_19_FINANCIAL_ENERGY_ASSESSMENT",
"content": {"key": "value"}
}GenerateAffiliatesAudioRecordingPreSignedUrlInput
Input fields to generate a pre-signed upload URL for an affiliates audio recording.
Input fields
| Name | Description |
|---|---|
| The name of the file to be uploaded. |
Example
{
"filename": "abc123"
}Input fields
| Name | Description |
|---|---|
| The channel of the contact. |
| The name of the file. |
Example
{
"channel": "EMAIL",
"filename": "abc123"
}GenerateLeadsFileAttachmentDownloadPreSignedUrlInput
Input fields to generate a pre-signed download URL for a leads file attachment.
Input fields
| Name | Description |
|---|---|
| The ID of the opportunity file attachment. |
| The unique opportunity number to which the file attachment belongs. |
Example
{
"attachmentId": "abc123",
"opportunityNumber": "abc123"
}GenerateLeadsFileAttachmentPreSignedUrlInput
Input fields to generate a pre-signed upload URL for a leads file attachment.
Input fields
| Name | Description |
|---|---|
| The category of the file. The list of allowed values is specified by the client. |
| The name of the file to be uploaded. |
| The unique opportunity number to which the file is related. |
Example
{
"filename": "abc123",
"opportunityNumber": "abc123",
"category": "LEAD_FILE"
}Input fields
| Name | Description |
|---|---|
| The market message part ID associated with the ICP. |
| Market process ID. |
| User reference in outbound read replacement message. |
Example
{
"marketMessagePartId": "abc123",
"userReference": "abc123",
"marketProcessId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}GetEmbeddedSecretForNewPaymentInstructionInput
The input for getting the client secret for an embedded new card payment method form.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| The ledger ID. Deprecated The 'ledgerId' field is deprecated. |
| WARNING: Will be mandatory in future versions The number of the ledger. |
Example
{
"accountNumber": "abc123",
"instructionType": "BPAY",
"ledgerId": "abc123",
"ledgerNumber": "abc123"
}GetEmbeddedSecretForNewPaymentInstructionWithoutAccountInput
The input for getting the client secret for an embedded new stored payment method form.
Input fields
| Name | Description |
|---|---|
| The type of the new payment instruction. |
Example
{
"instructionType": "BPAY"
}GetHostedUrlForNewPaymentInstructionInput
The input needed for getting the external URL for setting up a payment instruction.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| The ledger number. |
| The URL to redirect the user to after the action was cancelled. |
| The URL to redirect the user to after the action resulted in an error. |
| The URL to redirect the user to after the action resulted in a failure. |
| The URL to redirect the user to after the action was completed successfuly. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"instructionType": "BPAY",
"returnUrlSuccess": "abc123",
"returnUrlFailure": "abc123",
"returnUrlError": "abc123",
"returnUrlCancel": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the business that will grant access. |
| The code of the role that will be granted. |
| The number of the user that will gain access. |
Example
{
"userNumber": "abc123",
"businessId": "abc123",
"roleCode": "abc123"
}GuaranteeOfOriginConfigurationInput
Input type for the GuaranteeOfOriginConfigurationTerm.
Input fields
| Name | Description |
|---|---|
| The percentage of the guarantee of origin. |
| Whether the term is variable. |
Example
{
"isVariable": true,
"guaranteeOfOriginPercentage": "ZERO"
}Input fields
| Name | Description |
|---|---|
| Region name for the address. |
| Street name for the address. |
| Street number for the address. |
| Suburb name for the address. |
Example
{
"streetNumber": "abc123",
"streetName": "abc123",
"suburb": "abc123",
"region": "AUCKLAND"
}Input fields
| Name | Description |
|---|---|
| The escalation start date for the product rate override configuration. |
| The index code for the product rate override configuration. |
Example
{
"indexCode": "abc123",
"escalationStartAt": "2020-01-01T00:00:00.000Z"
}InitiateHostedStandalonePaymentInput
Input fields for initiating a hosted standalone payment.
The amount should always be provided in the minor unit of currency (e.g., pence not pounds, cents not dollars, etc.).
A standalone payment can be made against a specific ledger (e.g., a debt ledger) by providing the ledger number (or ledger id, please see deprecated fields).
Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be collected in the minor unit of currency. |
| The method by which the payment is being collected. |
| A description of the purpose of the payment. |
| The id of the specific ledger against which this payment should be applied. Deprecated The 'ledgerId' field is deprecated. |
| The number of the specific ledger against which this payment should be applied. |
| The URL to redirect the user to after the action was cancelled. |
| The URL to redirect the user to after the action resulted in an error. |
| The URL to redirect the user to if the url is not longer valid. |
| The URL to redirect the user to after the action resulted in a failure. |
| The URL to redirect the user to after the action was completed but the payment is still being processed. |
| The URL to redirect the user to after the action was completed successfuly. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"description": "abc123",
"collectionMethod": "CARD",
"ledgerNumber": "abc123",
"ledgerId": "abc123",
"returnUrlSuccess": "abc123",
"returnUrlPending": "abc123",
"returnUrlFailure": "abc123",
"returnUrlError": "abc123",
"returnUrlCancel": "abc123",
"returnUrlExpired": "abc123"
}Input fields
| Name | Description |
|---|---|
| Identification of the account that requesting the product switch. |
| ID of the selected quoted product, obtain from quoting that supply point. |
| Suppress Product Switch communications. |
| The date at which the product switch becomes effective. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Example
{
"accountNumber": "abc123",
"quotedProductId": "abc123",
"switchDate": "2020-01-01",
"userId": "abc123",
"suppressCommunications": true
}InitiateStandalonePaymentInput
Input fields for initiating a standalone payment.
The amount should always be provided in the minor unit of currency (e.g., pence not pounds, cents not dollars, etc.).
A standalone payment can be made against a specific ledger (e.g., a debt ledger) by providing the ledger number. Accounts have a default ledger that will be used if not provided.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be collected in the minor unit of currency. |
| The method by which the payment is being collected. |
| A description of the purpose of the payment. |
| Whether the authorisation to initiate the payment was given over the phone. |
| The id of the specific ledger against which this payment should be applied. Deprecated The 'ledgerId' field is deprecated. |
| The number of the specific ledger against which this payment should be applied. |
Example
{
"accountNumber": "abc123",
"amount": 1,
"description": "abc123",
"collectionMethod": "CARD",
"isTelephoneInitiated": true,
"ledgerId": "abc123",
"ledgerNumber": "abc123"
}InkEmailMessageInput
This type is used to create an inbound email.
Input fields
| Name | Description |
|---|---|
| Message attachments. |
| The carbon copy (cc) email addresses the message was sent to. |
| The email address the message was sent from. |
| The content of the message, as plain text. |
| The S3 bucket in which the original email is stored. |
| The S3 key of the original email. |
| The email subject/title. |
| The email addresses the message was sent to. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"subject": "abc123",
"fromAddress": Email,
"toAddresses": Email,
"ccAddresses": [Email],
"s3Bucket": "abc123",
"s3Key": "abc123"
}Input fields
| Name | Description |
|---|---|
| The S3 bucket of the attachment. |
| The S3 key of the attachment. |
Example
{
"s3Key": "abc123",
"s3Bucket": "abc123"
}InkGenericMessageInput
This type is used to create an generic message.
Input fields
| Name | Description |
|---|---|
| Message attachments. |
| The identity the message was sent from. |
| The content of the message, as plain text. |
| The identity the message was sent to. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"fromHandle": "abc123",
"toHandle": "abc123"
}InkLiveChatMessageInput
This type is used to create a live chat message.
Input fields
| Name | Description |
|---|---|
| Message attachments. |
| The identity the message was sent from. |
| The content of the message, as plain text. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"fromHandle": "abc123"
}InkMessageInput
An Ink message used as an input.
This is intended to be morally equivalent to a tagged union; exactly one of the properties provided here is expected to be provided.
At current, only a few channels are provided. This is intended to be a backwards-compatible extension point to allow other message input types to be added in the future.
Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"liveChat": InkLiveChatMessageInput,
"generic": InkGenericMessageInput,
"email": InkEmailMessageInput,
"post": InkPostMessageInput
}InkPostMessageInput
This type is used to create an inbound post.
Input fields
| Name | Description |
|---|---|
| The account number that the letter was sent from. |
| Message attachments. |
| Notes on the letter. |
| The content of the message, as plain text. |
Example
{
"plainTextContent": "abc123",
"attachments": InkGenericMessageAttachmentInput,
"accountNumber": "abc123",
"notes": "abc123"
}Input fields
| Name | Description |
|---|---|
| The content of the storyline entry. |
| The optional related object ID of the entry. |
| The type of the storyline entry. |
| Whether this entry is identified as the root cause of the issue. |
| The datetime when the storyline entry occurred. |
| Optional URL related to the storyline entry. |
Example
{
"contentId": 1,
"entryType": "INBOUND_MESSAGE",
"occurredAt": "2020-01-01T00:00:00.000Z",
"content": "abc123",
"url": "abc123",
"isRootCause": true
}Input fields
| Name | Description |
|---|---|
| The identifier for a Kraken Flow run. |
| The uuid of a ElectricityTraderSwitchGainProcess that associates with the Flow run. |
Example
{
"flowRunIdentifier": "abc123",
"marketProcessId": "abc123"
}InstigateContractVariationInput
Input type for instigating a contract variation.
Input fields
| Name | Description |
|---|---|
| The date from which the varied terms will apply. |
| Optional note to capture at the point of variation. |
| The unique identifier of the contract to vary. |
| The terms to be varied in the contract. |
Example
{
"identifier": NonEmptyString,
"applicableAt": "2020-01-01T00:00:00.000Z",
"terms": OneOfTermInput,
"contractNote": ContractNoteInput
}Input fields
| Name | Description |
|---|---|
| Datetime that we were made aware of these changes. |
| List of changes. |
| Datetime that these changes are effective from. |
| ICP number. |
Example
{
"icpNumber": "abc123",
"effectiveAt": "2020-01-01T00:00:00.000Z",
"believedAt": "2020-01-01T00:00:00.000Z",
"changes": PriceChangeInput
}InstructionDetailsInput
Input type for instruction details that was created using the embedded process.
This means it was set up in the vendor system, and we only need to store a representation of the instruction in Kraken, but not make any calls to the vendor. This method of instruction creation must always be used for creating card instructions.
Input fields
| Name | Description |
|---|---|
| The type of the payment instruction. |
| The datetime from which the instruction is vaild. |
| The name of the vendor the payment instruction was set up with. |
| The vendor's reference for this payment instruction. |
Example
{
"vendorName": "GOCARDLESS",
"instructionType": "BPAY",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendorReference": "abc123"
}InvalidatePaymentInstructionInput
Input for invalidating an arbitrary payment instruction.
Input fields
| Name | Description |
|---|---|
| |
| The id of the payment instruction to be invalidated. |
Example
{
"accountNumber": "abc123",
"id": "abc123"
}InvalidatePreSignedTokenInput
Input type for the InvalidatePreSignedToken mutation.
Input fields
| Name | Description |
|---|---|
|
Example
{
"token": "abc123"
}InvalidatePreSignedTokensForUserInput
Input type for the InvalidatePreSignedTokensForUser mutation.
Input fields
| Name | Description |
|---|---|
| The email address of the user whose tokens should be invalidated. |
| The scope of the token to invalidate. If this argument is not specified, all pre-signed tokens issued to the user are invalidated. |
Example
{
"email": "abc123",
"scope": "SUBMIT_METER_READINGS"
}InvalidateRefreshTokenInput
Input type for the InvalidateRefreshToken mutation.
Input fields
| Name | Description |
|---|---|
|
Example
{
"refreshToken": "abc123"
}InvalidateRefreshTokensForUserInput
Input type for the InvalidateRefreshTokensForUser mutation.
Input fields
| Name | Description |
|---|---|
| The email address of the user whose tokens should be invalidated. |
Example
{
"email": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number of the join supplier process (e.g. A-12345678). |
| The JoinSupplierProcess ID. Deprecated The 'joinSupplierProcessId' field is deprecated. |
| The JoinSupplierProcess number. |
Example
{
"accountNumber": "abc123",
"joinSupplierProcessId": 1,
"joinSupplierProcessNumber": NonEmptyID
}LatePaymentFeesInput
Input type for the LatePaymentFeesTerm. This type is used to create or update late payment fees terms in contracts. If percentage_fee is provided, percentage_interval_days must also be provided.
Input fields
| Name | Description |
|---|---|
| The flat fee amount for late payment. |
| The interest policy to use for late payment fee calculations. |
| Whether the term is variable. |
| The percentage fee for late payment. |
| The interval in days for the percentage fee (1=daily, 7=weekly, 30=monthly, 365=yearly). |
Example
{
"isVariable": true,
"flatFeeAmount": "1.0",
"percentageFee": "1.0",
"percentageIntervalDays": "1.0",
"interestPolicyName": "abc123"
}Example
{
"nameKeyword": "abc123",
"emailDomain": "abc123",
"iban": "abc123"
}Input fields
| Name | Description |
|---|---|
| The role of the contact. |
Example
{
"role": "LEGAL_CONTACT"
}Input fields
| Name | Description |
|---|---|
| The email address of the contact. |
| Extra details for the contact as key/value pairs. |
| Extra details for the contact. Deprecated The 'extraDetails' field is deprecated. |
| The family name of the contact. |
| The given name of the contact. |
| The phone number of the contact. |
| The roles of the contact. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"extraDetails": {"key": "value"},
"extraDetailItems": ExtraDetailsItem,
"roles": "LEGAL_CONTACT"
}Input fields
| Name | Description |
|---|---|
| The supply point ID. |
| The product's market name. |
Example
{
"externalIdentifier": "abc123",
"marketName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Supply points market codes to filter opportunities. |
Example
{
"marketCodes": "NZL_ELECTRICITY"
}Input fields
| Name | Description |
|---|---|
| Filter opportunities by assigned to affiliate number. |
| The name of the team the leads are assigned to. |
| The username of the user the leads are assigned to. |
| The name of the organization the leads are created by. Deprecated The 'createdByOrganization' field is deprecated. |
| Free text field that will search against different identifiers of the lead. Currently supported include: lead number, phone number, email, name. |
| Filter leads by type. |
| Filter leads by stage code. |
Example
{
"assignedToTeam": "abc123",
"createdByOrganization": "abc123",
"assignedToAffiliateNumber": "abc123",
"assignedToUsername": "abc123",
"leadType": "BUSINESS",
"freeText": "abc123",
"stageCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The Kraken account number. |
| Future billing address. |
| |
| The requested last day of supply. |
| The type of leave supplier process to initiate. |
Example
{
"accountNumber": "abc123",
"marketData": LeaveSupplierMarketInputType,
"futureBillingAddress": RichAddressInput,
"subtype": "MOVE_OUT",
"requestedSupplyEndDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| A list of supply points for initiating a leave supplier journey. |
Example
{
"supplyPointData": _DefaultMarketTerminationInput
}LegacyCustomerOrderInput
Input type for specifying a customer, either an account or a business (legacy).
Input fields
| Name | Description |
|---|---|
| The account number. |
| The business identifier. |
Example
{
"account": NonEmptyString,
"business": 1
}LegacyItemProfileInput
Input type for item profile (legacy).
Input fields
| Name | Description |
|---|---|
| The characteristic values for this item profile. |
Example
{
"characteristics": {"key": "value"}
}LegacyMarketDataInput
Input type combining base supply point group fields with market-specific enrollment data (legacy).
Inherits address/property fields from BaseSupplyPointGroupInput and adds a single
context field whose type is a dynamically constructed InputObjectType containing
one field per configured market (morally a oneOf – callers should supply exactly one).
Input fields
| Name | Description |
|---|---|
| The address where the supply points to be supplied are located. |
| Market-specific enrollment details. Provide exactly one of the configured market input objects inside this container. |
| The ID of the property where the supply points are located. |
| The structured address where the supply points to be supplied are located.When available, please provide this field only, rather than addressDetails. |
Example
{
"addressDetails": LifecycleAddressInput,
"structuredAddress": RichAddressInput,
"property": "abc123",
"context": OneOfMarketEnrollmentInputType
}LegacyOrderInput
Input type for creating or updating an order (legacy).
Input fields
| Name | Description |
|---|---|
| The customer identifier who is placing the order. |
| The order lines for this order. |
| The sales record associated with this order. |
| The date and time at which the order was signed. A contract signing date, for example. This is required if the order contains terms. |
| The source Offering identifier that generated this Order. |
| The terms applicable to this order. |
Example
{
"customer": LegacyCustomerOrderInput,
"lines": LegacyOrderLineInput,
"signedAt": "2020-01-01T00:00:00.000Z",
"terms": OneOfTermInput,
"sale": SalesRecordInput,
"source": "abc123"
}LegacyOrderItemInput
Input type for order item (legacy).
Input fields
| Name | Description |
|---|---|
| The code identifying the item. |
| Market-specific data for the item. |
| The profile containing characteristics of the item. |
Example
{
"profile": LegacyItemProfileInput,
"marketData": LegacyMarketDataInput,
"code": NonEmptyString
}LegacyOrderLineInput
Input type for OrderLine (legacy).
Input fields
| Name | Description |
|---|---|
| The item being ordered. |
| The period for which this order line is valid. Can be a range or a duration. |
| The target customer identifier for this order line. |
| The terms applicable to this order line. |
Example
{
"item": LegacyOrderItemInput,
"period": LegacyOrderLinePeriodInput,
"target": NonEmptyString,
"terms": OneOfTermInput
}LegacyOrderLinePeriodInput
Input type for order line period - either explicit dates or duration (legacy). Use either (start + end) OR duration, not both.
Input fields
| Name | Description |
|---|---|
| Duration in seconds. Deprecated The 'duration' field is deprecated. |
| The end date and time of the period. |
| The start date and time of the period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z",
"duration": 1.0
}LegacyProcessOrderInput
Input type for processing an order (legacy).
Input fields
| Name | Description |
|---|---|
| The order to be processed. |
Example
{
"order": LegacyOrderInput
}Input fields
| Name | Description |
|---|---|
| Country code. |
| Line 1 of address. |
| Line 2 of address. |
| Line 3 of address. |
| Line 4 of address. |
| Line 5 of address. |
| Postal code. |
Example
{
"line1": "abc123",
"postalCode": "abc123",
"countryCode": "abc123",
"line2": "abc123",
"line3": "abc123",
"line4": "abc123",
"line5": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account ID. |
| The business ID. |
| The business role code of the linked account (default to OWNER). |
| Whether the business should be overwritten (default to false). |
Example
{
"accountId": "abc123",
"businessId": "abc123",
"shouldOverwrite": true,
"roleCode": BusinessRoleString
}LinkUserToLineInput
Link an AccountUser to a LINE account.
Input fields
| Name | Description |
|---|---|
|
Example
{
"linkToken": "abc123"
}LoyaltyPointLedgerEntryInput
The input type for retrieving a loyalty point ledger entry.
Input fields
| Name | Description |
|---|---|
| The unique idempotency key for the ledger entry. |
Example
{
"idempotencyKey": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}LoyaltyPointLedgersInput
The input type for retrieving a loyalty point ledger entry.
Input fields
| Name | Description |
|---|---|
| The account user id. |
Example
{
"accountUserId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Optional account user id for more granular balance. |
Example
{
"accountNumber": "abc123",
"accountUserId": "abc123"
}LoyaltyPointsProgramEligibilityInput
The input type for checking eligibility to join the loyalty points program.
Input fields
| Name | Description |
|---|---|
| The account number to check. |
Example
{
"accountNumber": "abc123"
}MetadataInput
The metadata input type for mutations.
Input fields
| Name | Description |
|---|---|
| An identifier for the associated object, e.g. account_number for the Account linked object type or email for the Account User linked object type. |
| The key for the metadata. |
| The object that the metadata is associated with. |
| The metadata value which should be a valid JSON string. |
Example
{
"identifier": "abc123",
"linkedObjectType": "ACCOUNT",
"key": "abc123",
"value": {"key": "value"}
}MinimumContractLengthInput
Input type for the MinimumContractLengthTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| The minimum length of the contract. |
| The unit of time for the contract length. |
Example
{
"isVariable": true,
"length": 1,
"unitOfTime": "abc123"
}Input fields
| Name | Description |
|---|---|
| The name of the bucket to move the conversation to. |
| The relay id of the conversation that will be moved to the bucket. |
| Whether to unassign from user buckets. Defaults to False (only unassign from team buckets). |
Example
{
"conversationRelayId": "abc123",
"bucketName": "abc123",
"unassignFromUsers": true
}Input fields
| Name | Description |
|---|---|
| The brand code of the company/entity sending the comm. If provided as empty string or the field is not included, it will default to the 'primary' brand. |
| The email address of the recipient. |
| The family name of the recipient. |
| The given name of the recipient. |
| The mobile phone number of the recipient. |
Example
{
"email": Email,
"mobile": "abc123",
"givenName": "abc123",
"familyName": "abc123",
"brandCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| Building name. |
| Flat or unit number. If provided, |
| Flat or unit type. |
| Floor or level number. If provided, |
| Floor or level type. |
| House number 1. If provided, |
| House number 2. If provided, |
| House number suffix 1. If provided, |
| House number suffix 2. If provided, |
| Mailtown. |
| Postal delivery location. If provided, |
| Postal delivery number prefix. If provided, |
| Postal delivery number suffix. If provided, |
| Postal delivery number value. If provided, |
| Postal delivery type. |
| Propery name. |
| Rural delivery number. |
| Street name. |
| Street prefix. If provided, |
| Street suffix. If provided, |
| Street type. If provided, |
Example
{
"flatOrUnitType": "abc123",
"flatOrUnitNumber": "abc123",
"floorOrLevelType": "abc123",
"floorOrLevelNumber": "abc123",
"propertyName": "abc123",
"buildingName": "abc123",
"houseNumber1": "abc123",
"houseNumberSuffix1": "abc123",
"houseNumber2": "abc123",
"houseNumberSuffix2": "abc123",
"streetPrefix": "abc123",
"streetName": "abc123",
"streetType": "abc123",
"streetSuffix": "abc123",
"ruralDeliveryNumber": "abc123",
"mailtown": "abc123",
"postalDeliveryType": "abc123",
"postalDeliveryLocation": "abc123",
"postalDeliveryNumberPrefix": "abc123",
"postalDeliveryNumberValue": "abc123",
"postalDeliveryNumberSuffix": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| The OCPP authentication details. |
Example
{
"accountNumber": "abc123",
"details": "abc123"
}ObtainJSONWebTokenInput
The input type for obtaining a Kraken Token (JWT).
The currently supported inputs are: - account user email/password combination - account user API key - organization live secret key - pre-signed key - refresh token
Input fields
| Name | Description |
|---|---|
| API key of the account user. Use standalone, don't provide a second input field. |
| The response from the CAPTCHA challenge. Use with 'email' and 'password' fields. |
| Email address of the account user. Use with 'password' field. Deprecated The 'email' field is deprecated. |
| Live secret key of an third-party organization. Use standalone, don't provide a second input field. |
| Password of the account user. Use with 'email' field. Deprecated The 'password' field is deprecated. |
| Short-lived, temporary key (that's pre-signed). Use standalone, don't provide a second input field. |
| The refresh token that can be used to extend the expiry claim of a Kraken token. Use standalone, don't provide a second input field. |
Example
{
"APIKey": "abc123",
"organizationSecretKey": "abc123",
"preSignedKey": "abc123",
"refreshToken": "abc123",
"email": "abc123",
"password": "abc123",
"captchaResponse": "abc123"
}ObtainLongLivedRefreshTokenInput
The input type for obtaining a long-lived refresh token.
Input fields
| Name | Description |
|---|---|
| The Kraken Token that will be used to generate the long-lived refresh token. |
Example
{
"krakenToken": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number. |
| Offer group identifier. |
Example
{
"offerGroupIdentifier": "abc123",
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Product components. |
| Product offering identifier. |
| End datetime for the quote period for all products in this offering. Defaults to 1 year from start if not provided. |
| Start datetime for the quote period for all products in this offering. Defaults to current datetime if not provided. |
Example
{
"productOfferingIdentifier": "abc123",
"productComponents": ProductComponentForQuotingInput,
"quotePeriodStartDatetime": "2020-01-01T00:00:00.000Z",
"quotePeriodEndDatetime": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The comments for this appointment. |
| The communication strategy for this appointment. |
| The type of job being booked for the appointment. |
Example
{
"jobType": NonEmptyString,
"commsStrategy": "SEND_ALL",
"comments": "abc123"
}Input fields
| Name | Description |
|---|---|
| Additional details about the asset. |
| Asset external identifier. |
| The current asset fuel type. |
| Asset kind. |
| Asset status. |
| Supply point external identifier to market name mapping to associate with the asset. If this is provided, |
| Internal ID of the supply point to associate with the asset. If this is provided, |
Example
{
"externalIdentifier": NonEmptyString,
"kind": "METER",
"status": "EXISTING",
"additionalDetails": {"key": "value"},
"supplyPointIdentifierToMarketNameMapping": SupplyPointIdentifierToMarketNameMappingInput,
"supplyPointInternalId": 1,
"fuelType": "ELECTRICITY"
}Input fields
| Name | Description |
|---|---|
| The current status of the appointment. |
| List of assets associated with the appointment. |
| The cancellation reason for this appointment. |
| Appointment related comments. |
| The comms strategy. |
| The end date/time of this appointment. |
| The external reference provided by the vendor/contractor for the appointment. |
| The job notes. |
| The type of job this appointment is for. |
| The UUID of the On-Site Jobs request appointment is for. |
| Whether to run the side-effect action based on the new appointment status. Only applicable if a value was provided in the |
| The start date/time of this appointment. |
Example
{
"requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"jobType": "abc123",
"appointmentStatus": "PENDING",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"externalReference": "abc123",
"jobNotes": {"key": "value"},
"comments": "abc123",
"commsStrategy": "SEND_ALL",
"cancellationCategory": "CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER",
"assets": OnSiteJobsAssetInput,
"runActionsBasedOnStatus": true
}Input fields
| Name | Description |
|---|---|
| When true, automatically updates the request status to match its appointments. Defaults to true. |
| The Kraken ID of the appointment to update. |
| List of assets associated with the appointment. |
| When true, allows updating an appointment that is already in a terminal status. Defaults to false. |
| The cancellation category, if applicable. |
| Optional comments about the appointment. |
| The communication strategy to apply to this appointment. |
| The new end datetime for the appointment. For open-ended appointments, set to None. |
| Optional job notes as a JSON object. |
| Whether to run the side-effect action based on the new appointment status. Only applicable if a value was provided in the |
| The new start datetime for the appointment. |
| The new status for the appointment. |
Example
{
"appointmentId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"status": "PENDING",
"commsStrategy": "SEND_ALL",
"startAt": "2020-01-01T00:00:00.000Z",
"endAt": "2020-01-01T00:00:00.000Z",
"jobNotes": {"key": "value"},
"comments": "abc123",
"cancellationCategory": "CANCELLED_BY_SUPPLIER___CUSTOMER_CHANGING_SUPPLIER",
"assets": OnSiteJobsAssetInput,
"runActionsBasedOnStatus": true,
"alignRequestStatusWithAppointment": true,
"bypassTerminalAppointmentStatus": true
}Input fields
| Name | Description |
|---|---|
| List of assets associated with the request. |
| Comment for the request. |
| The UUID of the OnSite Jobs request to update. |
| Request status. |
Example
{
"requestId": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"comment": "abc123",
"status": "IN_PROGRESS",
"assets": OnSiteJobsAssetInput
}Input fields
| Name | Description |
|---|---|
| Simple Service enrollment details. |
Example
{
"services": SimpleServicesEnrollmentMarketInput
}Input fields
| Name | Description |
|---|---|
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
| Input type for contract term. |
Example
{
"terminationfee": TerminationFeeInput,
"contractedvolumeconfiguration": ContractedVolumeConfigurationInput,
"minimumcontractlength": MinimumContractLengthInput,
"bespokerateconfiguration": BespokeRateConfigurationInput,
"paysbydirectdebit": PaysByDirectDebitInput,
"timeofuseoverride": TimeOfUseOverrideInput,
"productrateoverrideconfiguration": ProductRateOverrideConfigurationInput,
"delayerdays": DelayerDaysInput,
"characteristicoverrideconfiguration": CharacteristicOverrideConfigurationInput,
"collateralrequired": CollateralRequiredInput,
"billduedate": BillDueDateInput,
"billingdocumentissuancefrequency": BillingDocumentIssuanceFrequencyInput,
"promotionassignmentterm": PromotionAssignmentTermInput,
"rategroupeligibilityconfiguration": RateGroupEligibilityConfigurationInput,
"contractmetadata": ContractMetaDataInput,
"latepaymentfees": LatePaymentFeesInput,
"guaranteeoforiginconfiguration": GuaranteeOfOriginConfigurationInput,
"taxadjustmentconfiguration": TaxAdjustmentConfigurationInput
}Input fields
| Name | Description |
|---|---|
| Filter opportunities by assigned to affiliate number. |
| Filter opportunities by assigned to team. |
| Filter opportunities by created by organization. Deprecated The 'createdByOrganization' field is deprecated. |
| Filter opportunities by funnel code. |
| Filter opportunities by lead number. |
| Filter opportunities by product offering identifier. |
| Filter opportunities by sales channel. |
| Filter opportunities by stage. |
| Filter opportunities by supply point markets. |
Example
{
"funnelCode": "abc123",
"stageCode": "abc123",
"leadNumber": "abc123",
"assignedToTeam": "abc123",
"salesChannel": "abc123",
"createdByOrganization": "abc123",
"assignedToAffiliateNumber": "abc123",
"productOfferingId": "abc123",
"supplyPointMarkets": "NZL_ELECTRICITY"
}Input fields
| Name | Description |
|---|---|
| Outcome category. |
| Optional reason for the outcome. |
| Type of the app session. |
Example
{
"type": "SALE",
"category": "SUCCESS",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the owner. |
| The type of owner entity. |
Example
{
"ownerType": "ACCOUNT_USER",
"ownerId": "abc123"
}PartyInput
Input type for specifying a contract party, either an account or a business.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The business identifier. |
Example
{
"account": NonEmptyString,
"business": 1
}Input fields
| Name | Description |
|---|---|
| Collection process number to pause. |
| Number of calendar days to pause collection process. |
| Start datetime for pause. |
| Reason for pausing collection process. |
Example
{
"number": "abc123",
"reason": "abc123",
"pauseStartAt": "2020-01-01T00:00:00.000Z",
"pauseLength": 1
}Input fields
| Name | Description |
|---|---|
| Account number for which to pause the dunning process. |
| An optional note for the pause. |
| The dunning process path name to pause. |
| The date from which the pause to take effect. |
| The date at which the pause should stop. |
Example
{
"accountNumber": "abc123",
"pathName": "abc123",
"startDate": "2020-01-01",
"stopDate": "2020-01-01",
"note": "abc123"
}Input fields
| Name | Description |
|---|---|
| Ad-hoc details of a payment action intent. |
| The token of an existing payment action intent. |
Example
{
"token": "abc123",
"options": PaymentActionIntentOptionsInput
}Input fields
| Name | Description |
|---|---|
| The unique identifier for the target the payment should be associated with. |
| The type of target the payment should be associated with. |
Example
{
"targetType": "ledger",
"targetIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The payment action intent details that identify the target for this payment. |
| The payment amount in the minor unit of currency. |
| The description of the payment, as shown to the customer. |
| The date when the payment was made. |
| The details of the payment method used for this payment. |
| The reference used to uniquely identify this payment. |
Example
{
"actionIntent": PaymentActionIntentOneOfInput,
"reference": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"customerReference": "abc123",
"paymentMethod": PaymentMethodInput
}Input fields
| Name | Description |
|---|---|
| The code of the payment method type used for this payment. |
Example
{
"type": "abc123"
}PaymentScheduleDetailsInput
Input type for payment schedule details.
This enables us to collect information to create 4 different types of schedules during enrollment: - Payment on receipt of bill - Payment at a fixed day of the month once a receipt of bill has been issued - Payment when a ledger balance drops below a certain value - Payment at regular intervals for a fixed amount
This is intended to be morally equivalent to a "union" input type.
Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"regularTriggered": RegularTriggeredScheduleInput,
"billTriggered": BillTriggeredScheduleInput,
"balanceTriggered": BalanceTriggeredScheduleInput,
"billTriggeredBalanceTarget": BillTriggeredBalanceTargetScheduleInput
}PaymentSlipDetailsInput
Input type for payment slip details.
This is used to set up a new payment instruction in the vendor's system as part of the enrollment process.
Input fields
| Name | Description |
|---|---|
| True if the customer also the payer. |
Example
{
"payerIsCustomer": true
}PayoutReferralForAccountInput
Required information for paying out a referral for an account
Input fields
| Name | Description |
|---|---|
| The account number of the referring/referred account. |
| Optional custom note to override the default display note and private note on the account credit. |
| The ID of the referral to payout. |
Example
{
"accountNumber": "abc123",
"referralId": 1,
"note": "abc123"
}PaysByDirectDebitInput
Input type for the PaysByDirectDebitTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| Whether the account is paying by direct debit or not. |
Example
{
"isVariable": true,
"paysByDirectDebit": true
}Input fields
| Name | Description |
|---|---|
| Content type of the photo. |
| Size of the file in bytes. |
| UUID for the photo. |
| S3 bucket where the photo is stored. |
| S3 key for the photo. |
Example
{
"id": "500c164d-38c7-4f74-9ac6-be210197e9e4",
"contentType": "abc123",
"fileSize": 1,
"s3Bucket": "abc123",
"s3Key": "abc123"
}Input fields
| Name | Description |
|---|---|
| The namespace of the portfolio reference. |
| The value of the portfolio reference. |
Example
{
"namespace": "abc123",
"value": "abc123"
}PossibleErrorsInputType
Information about the query/mutation for which one wants to know the possible errors.
Input fields
| Name | Description |
|---|---|
| Whether to include possible authentication errors. |
| Name of the query/mutation for which to get the possible errors. |
| Type of the query (query or mutation). |
Example
{
"name": "abc123",
"type": "query",
"authErrors": true
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Optional short note about the credit, to be displayed to the user. |
| The ID of the ledger where the credit will be posted. Deprecated The 'ledgerId' field is deprecated. |
| The number of the ledger where the credit will be posted. |
| The net amount of the credit to be posted. Amount should be posted in the smallest unit of currency. |
| Optional short note about the credit, to be displayed to internal systems. |
| The reason why the credit is posted. This should be a valid credit reason code. |
| The tax amount of the credit to be posted. Amount should be posted in the smallest unit of currency. |
Example
{
"accountNumber": "abc123",
"netAmount": 1,
"taxAmount": 1,
"displayNote": "abc123",
"note": "abc123",
"reason": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Explanation or context for the event. |
| Unique identifier for this event from the external vendor, if provided. Used for deduplication so that requests can be safely retried without creating duplicate events. |
| Type of post event (ie. 'delivered', 'returned', 'failed'). |
| Unique ID of the message (ie. letter or document) that this post event relates to. |
| The date/time that the post event occurred, if provided. |
Example
{
"messageId": "abc123",
"eventType": "abc123",
"description": "abc123",
"timestamp": "2020-01-01T00:00:00.000Z",
"eventId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The day of the week. |
| The maximum value. |
| The minimum value. |
| Time of day this change should apply. Format: HH:MM. |
Example
{
"dayOfWeek": "MONDAY",
"time": "00:00:00.000Z",
"min": "1.0",
"max": "1.0"
}Input fields
| Name | Description |
|---|---|
| The type of account to create. |
| The billing address. |
| The billing name. |
| The brand of the created account. |
| The chosen payment day. |
| The customer's details. |
| The date of sale, defaults to today if not provided. |
| The preferred supply start date. |
| Sales information. |
| Information of the supply points that the customer is intending to sign up for supply. |
Example
{
"accountType": "BUSINESS",
"brandCode": "abc123",
"billingName": "abc123",
"billingAddress": LifecycleAddressInput,
"customerDetails": CustomerDetailsInput,
"salesInfo": SalesInformationInput,
"preferredSsd": "2020-01-01",
"dateOfSale": "2020-01-01",
"chosenPaymentDay": 1,
"supplyPointInfoList": PrepareAccountSupplyPointInput
}PrepareAccountSupplyPointInput
Input that can be provided to prepare account in order to identify previous accounts. This can be either the id of an actual supply point, or its market name and external_identifier. Only one of these should be provided. If both are present we give preference to the object id.
Input fields
| Name | Description |
|---|---|
| The ID of the supply point to be enrolled. |
| The details of the supply point to be enrolled. |
Example
{
"supplyPointId": "abc123",
"supplyPointInfo": SupplyPointInfoInput
}Input fields
| Name | Description |
|---|---|
| Old value. |
| New Value. |
| Elements of path to changed value. |
Example
{
"path": "abc123",
"baseValue": "abc123",
"otherValue": "abc123"
}PriceForStreamInput
Rate group prices for a product.
Input fields
| Name | Description |
|---|---|
| The characteristic mapping for the price. |
| The price per unit. |
| The scheme labels for the price. |
Example
{
"price": "1.0",
"characteristicMapping": {"key": "value"},
"schemeLabels": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The Market Message Part ID associated with the ICP. |
Example
{
"marketMessagePartId": "abc123"
}Input fields
| Name | Description |
|---|---|
| Product code. |
| Quoting parameter list for this product. |
Example
{
"productCode": "abc123",
"quotingParams": _QuotingParam
}ProductRateOverrideConfigurationInput
Input type for the ProductRateOverrideConfigurationTerm.
Input fields
| Name | Description |
|---|---|
| The indexation options for the product rate override configuration. |
| Whether the term is variable. |
| The schedules for the product rate override configuration. |
Example
{
"isVariable": true,
"indexationOptions": IndexationOptionsInput,
"schedules": ProductRateOverrideScheduleInput
}ProductRateOverrideItemBandInput
Item input for Product Rate Override Configuration term by rate band.
Input fields
| Name | Description |
|---|---|
| The rate band for the product rate override item. |
| The characteristic values for the product rate override item. |
| The rate specification code for the product rate override item. |
| The scheme label mapping for the given rate override item. |
Example
{
"rateSpecificationCode": "abc123",
"characteristicValues": CharacteristicValueInput,
"schemeLabels": SchemeLabelInput,
"band": "abc123"
}ProductRateOverrideItemInput
Item input for Product Rate Override Configuration term.
Input fields
| Name | Description |
|---|---|
| The price per unit for the product rate override item. |
| The product code for the product rate override item. |
The rate band for the product rate override item. |
Example
{
"productCode": "abc123",
"rate": ProductRateOverrideItemBandInput,
"pricePerUnit": "1.0"
}ProductRateOverrideScheduleInput
Schedule for Product Rate Override Configuration term.
Input fields
| Name | Description |
|---|---|
| The effective from date for the product rate override schedule. |
| The items for the product rate override schedule. |
Example
{
"items": ProductRateOverrideItemInput,
"effectiveFrom": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Number of units. |
| Price per unit in smallest sub-unit of the currency. Only used if the product accepts arbitrary prices. |
| Products code to purchase. |
Example
{
"productCode": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1
}ProductToQuoteInput
Represents a product and the quantity to quote for a customer.
Input fields
| Name | Description |
|---|---|
| Currency. |
| Number of units. |
| Price per unit in smallest sub-unit of the currency. |
| ID of the product to quote. |
Example
{
"productId": "abc123",
"numberOfUnits": 1,
"pricePerUnit": 1,
"currency": "abc123"
}PromotionAssignmentScheduleInput
Input type for defining a promotion assignment schedule.
Input fields
| Name | Description |
|---|---|
| A mapping from discount codes to lists of targets. Each target is represented as {'target_type': {'domain': ..., 'type': ...}, 'identifier': ...}. |
| The promotion code for this schedule. |
Example
{
"promotionCode": "abc123",
"discountTargets": {"key": "value"}
}PromotionAssignmentTermInput
Input type for the PromotionAssignmentTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| A list of promotion assignment schedules to be associated with the contract. |
Example
{
"isVariable": true,
"schedules": PromotionAssignmentScheduleInput
}Input fields
| Name | Description |
|---|---|
| The ID of the approval. |
| The datetime when the approval was approved. |
| The underlying process requiring an approval. |
Example
{
"approvalId": "abc123",
"processType": "abc123",
"approvedAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The account number of the recipient of this trigger. |
| Account user number of the recipient of this trigger. |
| An optional unique identifier for the trigger. If provided and there is an existing trigger with the same idempotency key, a new trigger will not be created. |
| The non-account recipient of this trigger. Cannot be used in combination with accountnumber or accountuser_number. |
| The variables that will be passed through to message templates. |
| The code of the trigger type to be published. |
Example
{
"triggerTypeCode": "abc123",
"accountNumber": "abc123",
"accountUserNumber": "abc123",
"templateVariables": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType,
"recipient": NonAccountRecipient,
"idempotencyKey": "abc123"
}Input fields
| Name | Description |
|---|---|
| The params of the trigger type, as a JSON string. These are defined in the Params class for a trigger type. |
| The code of the trigger type to be published. |
Example
{
"triggerTypeCode": "abc123",
"params": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| The account to purchase a voucher for. |
| When the voucher becomes available to be redeemed. |
| How much to charge the account for in cents. Excludes tax. |
| How much to charge the account for in cents. Includes tax. |
| Additional metadata from client sources to be stored against the voucher. This data is not structural and won't be relied on by Kraken internally. |
| Display name for the voucher purchase. Maximum length is 255 characters. |
| The ID of the payment, if any. |
| When the purchase was performed. |
| The ledger number of the ledger to transfer the charge to, if any. |
| The type of voucher. |
| How much to credit the account for this voucher in cents. |
Example
{
"accountNumber": "abc123",
"voucherValueInCents": 1,
"chargeAmountInCents": 1,
"chargeAmountInCentsWithTax": 1,
"displayName": "abc123",
"clientParams": {"key": "value"},
"voucherType": "abc123",
"transferChargeLedgerNumber": "abc123",
"paymentId": "abc123",
"purchasedAt": "2020-01-01T00:00:00.000Z",
"availableFrom": "2020-01-01"
}QueryComplexityInputType
Information about the complexity of the query.
Input fields
| Name | Description |
|---|---|
| The operation name of the query to calculate complexity for if more than one is provided. |
| The query to calculate complexity for. |
| Any variables to include for the query. Pagination variables should be included as they will affect the overall weight of the query. |
Example
{
"query": "abc123",
"variables": {"key": "value"},
"operationName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account for which the quote was created. |
| Quote code. |
| Recipient information. |
Example
{
"recipient": Recipient,
"quoteCode": "abc123",
"accountNumber": "abc123"
}RateGroupEligibilityConfigurationInput
Input type for the RateGroupEligibilityTerm. Callers must provide at least one schedule (schedules / timeSeriesSpecificationSchedules).
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
| A list of rate group eligibility schedules to be associated with the contract. |
| A list of time series specification eligibility schedules to be associated with the contract. |
Example
{
"isVariable": true,
"schedules": RateGroupEligibilityScheduleInput,
"timeSeriesSpecificationSchedules": TimeSeriesSpecificationEligibilityScheduleInput
}RateGroupEligibilityPeriodInput
Input type representing a period with optional start and end dates.
Input fields
| Name | Description |
|---|---|
| The end date and time of the period. |
| The start date and time of the period. |
Example
{
"start": "2020-01-01T00:00:00.000Z",
"end": "2020-01-01T00:00:00.000Z"
}RateGroupEligibilityScheduleInput
Input type for defining a rate group eligibility schedule.
This input type is used to specify the details of a rate group eligibility schedule, including the associated product code, rate group code, eligibility status, and effective period.
Input fields
| Name | Description |
|---|---|
| The period during which this eligibility is effective. |
| Indicates if the rate group is eligible. |
| The product code associated with the rate group. |
| The rate group code. |
Example
{
"productCode": "abc123",
"rateGroupCode": "abc123",
"isEligible": true,
"effectivePeriod": RateGroupEligibilityPeriodInput
}RateGroupPricesInput
Rate group prices for a product.
Input fields
| Name | Description |
|---|---|
| The prices for the rate group. |
| The rate group code. |
Example
{
"rateGroup": "abc123",
"prices": PriceForStreamInput
}Input fields
| Name | Description |
|---|---|
| The Collection Process Record Number. |
Example
{
"number": "abc123"
}Input fields
| Name | Description |
|---|---|
| Email address of the recipient. |
| Family name of the recipient. |
| Given name of the recipient. |
| Mobile number of the recipient. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"email": "abc123",
"mobile": "abc123"
}Input fields
| Name | Description |
|---|---|
| The priority with which this information needs to be resolved. |
| A list of payments that have failed. The list may contain at most 250 items. |
Example
{
"noticePriority": "HIGH",
"payments": FailedPaymentDetailsInput
}Input fields
| Name | Description |
|---|---|
| The priority with which this information needs to be resolved. |
| A list of payments that are pending. |
Example
{
"noticePriority": "HIGH",
"payments": PaymentDetailsInput
}Input fields
| Name | Description |
|---|---|
| The priority with which this information needs to be resolved. |
| A list of payments that have succeeded. The list may contain at most 250 items. |
Example
{
"noticePriority": "HIGH",
"payments": SuccessfulPaymentDetailsInput
}RedeemLoyaltyPointsInput
The input type for redeeming Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The account user id. |
| The number of Loyalty Points to redeem. |
Example
{
"accountUserId": "abc123",
"accountNumber": "abc123",
"points": 1
}RedeemReferralClaimCodeInput
Required payload to redeem the benefit for partner reward referral scheme
Input fields
| Name | Description |
|---|---|
| The account number for the referred account. |
| Referral scheme claim code value. |
Example
{
"accountNumber": "abc123",
"code": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The amount to be repaid. |
| Unique constraint to prevent duplicate requests. |
| The ID of the payment to refund. |
| Reason for refunding the payment. |
Example
{
"accountNumber": "abc123",
"paymentId": "abc123",
"amountInMinorUnit": 1,
"idempotencyKey": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| A descriptive text about the flow event. |
| The ID of the flow. |
| The unique number of the lead. |
| The name of the flow event. It will be the label to show. |
| The status of the flow. |
Example
{
"name": "abc123",
"flowId": "abc123",
"description": "abc123",
"status": "abc123",
"leadNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| A descriptive text about the flow event. |
| The ID of the flow. |
| The name of the flow event. It will be the label to show. |
| The unique number of the opportunity. |
| The status of the flow. |
Example
{
"name": "abc123",
"flowId": "abc123",
"description": "abc123",
"status": "abc123",
"opportunityNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| Register a push notification binding. A push notification binding connects an account user to a specific application running on a specific device through a 'registration token' (Android) or 'device token' (iOS). Using this binding we can send push notifications to the account user's devices. |
| The time at which the push notification binding expires. |
| The push notification service the application is registered with. For iOS applications this will be 'APNS' and for Android applications this will be 'GCM'. For iOS Sandbox applications, the value is 'APNS_SANDBOX'. |
| Device push notification token. |
Example
{
"token": "abc123",
"bundleId": "abc123",
"service": "abc123",
"expiresAt": "2020-01-01T00:00:00.000Z"
}RegularTriggeredScheduleInput
A payment schedule which triggers a payment at regular intervals.
Input fields
| Name | Description |
|---|---|
| The based unit of frequency at which payments are to be taken. |
| The multiple of the frequency at which payment are taken; should be between 1 and 11. |
| The day of the month/week at which to take payment; allowed values: -28 to 28 (excl. 0) for 'MONTHLY', -7 to 7 (excl. 0) for 'WEEKLY'. Negative values count backwards from the end of the month/week. |
Example
{
"paymentDay": 1,
"frequency": "WEEKLY",
"frequencyMultiplier": 1
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The name of the campaign to be removed. |
| The expiry date of the campaign to be removed if prior to today's date. Defaults to today. |
Example
{
"accountNumber": "abc123",
"campaignName": "abc123",
"expireAt": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The campaign ID. |
| The IDs of the items to remove. |
Example
{
"campaignId": "abc123",
"campaignItemIds": "abc123"
}RemovePropertyFromHierarchyInput
Input for removing a property from a hierarchy.
Input fields
| Name | Description |
|---|---|
| The name of the hierarchy to remove the property from. |
| The ID of the property to remove from the hierarchy. |
Example
{
"propertyId": "abc123",
"hierarchyName": "abc123"
}RepaymentInput
Input fields for Repayment Intervention.
Input fields
| Name | Description |
|---|---|
| The Repayment Intervention reason. |
| The repayment ID. |
Example
{
"repaymentId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| Reporter category. |
| Reporter email address. Must be blank if category='customer'. |
| Reporter name. Must be blank if category='customer'. |
| Reporter phone number. Must be blank if category='customer'. |
Example
{
"category": "CUSTOMER",
"name": "abc123",
"phoneNumber": "abc123",
"email": "abc123"
}RequestPasswordResetInput
Input type for the RequestPasswordReset mutation.
Input fields
| Name | Description |
|---|---|
| The URL from which the reset was requested. If supported, it is used as the base URL to generate the reset link in the email sent to the user. |
| The email requesting a password reset email. Provide either this or the userNumber. |
| The number of the user requesting a password reset email. Provide either this or the email. |
Example
{
"email": "abc123",
"userNumber": "abc123",
"baseUrl": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ID of the billing document to request a printed bill for. |
Example
{
"billingDocumentId": "abc123",
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| A valid ICP number, which may be from the ICP Discovery results. |
Example
{
"icpNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number for the requested ledger's account. |
| The amount to be repaid. |
| Unique constraint to prevent duplicate requests. |
| |
| The ledger id from which the repayment will be requested. Deprecated The 'ledgerId' field is deprecated. |
| The ledger number from which the repayment will be requested. |
| The method by which the money will be transferred to the customer. |
| The reason for the repayment. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"amountInMinorUnit": 1,
"method": "BANK_TRANSFER",
"instructionReference": "abc123",
"idempotencyKey": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number to query usage data for. |
| End date of requested usage data (inclusive). |
| |
| Start date of requested usage data (inclusive). |
Example
{
"accountNumber": "abc123",
"icpNumber": "abc123",
"startDate": "2020-01-01",
"endDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
|
Example
{
"password": "abc123",
"userId": "abc123",
"token": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The new password. |
| The token from the presigned url. |
| A base64 bytestring representing the user's unique id. |
Example
{
"newPassword": "abc123",
"userId": "abc123",
"token": "abc123"
}Input fields
| Name | Description |
|---|---|
| Collection process number to resume. |
| Reason for resuming collection process. |
Example
{
"number": "abc123",
"reason": "abc123"
}ReverseEnrollmentInput
Input required to reverse an enrollment (Join Supplier process).
Input fields
| Name | Description |
|---|---|
| The identifier of the enrollment process to reverse. |
| The reason for the reversal. |
Example
{
"number": "abc123",
"reversalReason": "abc123"
}ReverseLeaveSupplierInput
Input required to reverse a LeaveSupplier journey.
Input fields
| Name | Description |
|---|---|
| The ID of the LeaveSupplier process to reverse. Deprecated The 'leaveSupplierProcessId' field is deprecated. |
| The ID of the LeaveSupplier process to reverse. |
| The reason for the reversal. |
Example
{
"number": NonEmptyID,
"leaveSupplierProcessId": NonEmptyID,
"reversalReason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The ID of the agreement to be revoked. |
| The reason for revoking the agreement. |
Example
{
"accountNumber": "abc123",
"agreementId": "abc123",
"reason": "abc123"
}Input fields
| Name | Description |
|---|---|
| The unique identifier of the contract to revoke. |
Example
{
"identifier": NonEmptyString
}Input fields
| Name | Description |
|---|---|
| The ID of the business that will revoke access. |
| The code of the role that will be revoked. |
| The number of the user that will lose access. |
Example
{
"userNumber": "abc123",
"businessId": "abc123",
"roleCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| Top-level administrative subdivision, e.g. NZ region. |
| ISO 3166-1 alpha-2 code of the country this address belongs
to, e.g. |
| Identifier used by the local postal service for this address, e.g. AU DPID, GB postcode + Delivery Point Suffix, US Zip-9 + Delivery Point. This is the value that gets encoded in the barcode printed on the envelope by large-volume bulk mail providers. |
| UK dependent localities, or neighbourhoods or boroughs in some other locations. |
| City or town portion of an address, e.g. NZ suburb or town. |
| A personal name. |
| The name of a business or organisation. |
| The post code associated with the address. |
| Sorting code, e.g. FR CEDEX code. This field is not used in many countries. |
| At most one of this field and This is a divergence from |
| At most, only one of this field and
|
Example
{
"name": "abc123",
"organization": "abc123",
"streetAddress": "abc123",
"structuredStreetAddress": NzlRichStructuredAddressInput,
"dependentLocality": "abc123",
"locality": "abc123",
"administrativeArea": "abc123",
"postalCode": "abc123",
"sortingCode": "abc123",
"country": "abc123",
"deliveryPointIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| The type of the risk identifier to be added or removed from the risk list. |
| The value of the risk identifier to be added or removed from the risk list. |
| The date and time until which the risk identifier is valid. If not provided, the risk identifier will be valid indefinitely. |
Example
{
"identifierValue": "abc123",
"identifierTypeName": "abc123",
"validTo": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Number of the agreement rollover that is going to be executed. |
Example
{
"agreementRolloverNumber": "abc123"
}SalesDetailsInput
Input type for specifying sales details.
Input fields
| Name | Description |
|---|---|
| The sales record associated with the contract. |
Example
{
"salesRecord": SalesRecordInput
}Input fields
| Name | Description |
|---|---|
| The code of the funnel to get the schema for. |
| Whether to include deprecated fields in the schema. |
Example
{
"funnelCode": "abc123",
"includeDeprecatedFields": true
}Input fields
| Name | Description |
|---|---|
| The type of the funnels to get the schema for. |
| Whether to include deprecated fields in the schema. |
Example
{
"funnelType": "LEAD",
"includeDeprecated": true
}SalesInformationInput
Information about the sale to associate with the account.
Input fields
| Name | Description |
|---|---|
| Optional ID of the affiliate session. |
| Unique identifier for the offer group. |
| Optional ID of the affiliate organisation. Deprecated The 'organisationId' field is deprecated. |
| Optional number of the affiliate organisation. |
| The referral code used by the customer when signing up. |
| Sales channel. |
| Sales subchannel. Deprecated The 'salesSubchannel' field is deprecated. |
| Unique reference number. |
Example
{
"organisationId": "abc123",
"organisationNumber": "abc123",
"affiliateSessionId": "abc123",
"salesChannel": "abc123",
"salesSubchannel": "abc123",
"urn": "abc123",
"offerGroupIdentifier": NonEmptyString,
"referralCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The name of the affiliate organisation associated with the sales record. |
| The opportunity code associated with the sales record. |
| The sales channel associated with the sales record. |
Example
{
"opportunityNumber": "abc123",
"salesChannel": "abc123",
"affiliateOrganisationName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The unique reference to the scheme. |
| The value for the scheme. |
Example
{
"reference": "abc123",
"value": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the internal company to retrieve. |
Example
{
"id": "abc123"
}Input fields
| Name | Description |
|---|---|
| The email address to be used for the lead. |
| The national ID of the lead. |
| The telephone number to be used for the lead. |
Example
{
"nationalId": "abc123",
"email": "abc123",
"telephone": "abc123"
}SecurityDepositInput
Input type for security deposit details.
This is used to set up a security deposit as part of the enrollment process.
Input fields
| Name | Description |
|---|---|
| The amount of the security deposit. |
| The idempotency key used to identify the security deposit. |
| The reason for the security deposit. |
Example
{
"key": NonEmptyString,
"amount": 1,
"reason": NonEmptyString
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| Whether the |
| Quote code. |
| IDs of the quoted products to be selected. |
Example
{
"quoteCode": "abc123",
"selectedQuotedProductIds": "abc123",
"partial": true
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}SelectVehicleOrChargePointInput
Options for selecting the user's vehicle or charge point.
Input fields
| Name | Description |
|---|---|
| User selected integration option. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedIntegration": "ELECTRIC_VEHICLE"
}Input fields
| Name | Description |
|---|---|
| The ID of the selected option from the list. |
| The ID of the SmartFlex onboarding step to complete. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"selectedOption": "abc123"
}Input fields
| Name | Description |
|---|---|
| Expected Transfer Date. |
| The ICP number of the supply point to SendAcknowledgeSwitch for. |
| Market process ID. |
| User reference. |
Example
{
"icpNumber": "abc123",
"expectedTransferDate": "2020-01-01",
"userReference": "abc123",
"marketProcessId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Input fields
| Name | Description |
|---|---|
| Actual Transfer Date. |
| The ICP number of the supply point to SendCompleteSwitchMessage for. |
| Market Process ID. |
| The type of the supply point to SendCompleteSwitchMessage for. |
| User reference. |
Example
{
"icpNumber": "abc123",
"switchType": "MI",
"actualTransferDate": "2020-01-01",
"userReference": "abc123",
"marketProcessId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}Input fields
| Name | Description |
|---|---|
| Possible values: 000000: RESIDENTIAL A01: A01 A011: A011 A011100: A011100 A011200: A011200 A011300: A011300 A011400: A011400 A011500: A011500 A012: A012 A012100: A012100 A012200: A012200 A012300: A012300 A013: A013 A013100: A013100 A013200: A013200 A013300: A013300 A013400: A013400 A013500: A013500 A013600: A013600 A013700: A013700 A013900: A013900 A014: A014 A014100: A014100 A014200: A014200 A014300: A014300 A014400: A014400 A014500: A014500 A014600: A014600 A014900: A014900 A015: A015 A015100: A015100 A015200: A015200 A015900: A015900 A016: A016 A016000: A016000 A017: A017 A017100: A017100 A017200: A017200 A018: A018 A018000: A018000 A019: A019 A019100: A019100 A019200: A019200 A019300: A019300 A019900: A019900 A02: A02 A020: A020 A020100: A020100 A020200: A020200 A020300: A020300 A03: A03 A030: A030 A030100: A030100 A030200: A030200 A04: A04 A041: A041 A041100: A041100 A041200: A041200 A041300: A041300 A041400: A041400 A041900: A041900 A042: A042 A042000: A042000 A05: A05 A051: A051 A051000: A051000 A052: A052 A052100: A052100 A052200: A052200 A052900: A052900 B06: B06 B060: B060 B060000: B060000 B07: B07 B070: B070 B070000: B070000 B08: B08 B080: B080 B080100: B080100 B080200: B080200 B080300: B080300 B080400: B080400 B080500: B080500 B080600: B080600 B080700: B080700 B080900: B080900 B09: B09 B091: B091 B091100: B091100 B091900: B091900 B099: B099 B099000: B099000 B10: B10 B101: B101 B101100: B101100 B101200: B101200 B109: B109 B109000: B109000 C11: C11 C111: C111 C111100: C111100 C111200: C111200 C111300: C111300 C112: C112 C112000: C112000 C113: C113 C113100: C113100 C113200: C113200 C113300: C113300 C114: C114 C114000: C114000 C115: C115 C115000: C115000 C116: C116 C116100: C116100 C116200: C116200 C117: C117 C117100: C117100 C117200: C117200 C117300: C117300 C117400: C117400 C118: C118 C118100: C118100 C118200: C118200 C119: C119 C119100: C119100 C119200: C119200 C119900: C119900 C12: C12 C121: C121 C121100: C121100 C121200: C121200 C121300: C121300 C121400: C121400 C122: C122 C122000: C122000 C13: C13 C131: C131 C131100: C131100 C131200: C131200 C131300: C131300 C132: C132 C132000: C132000 C133: C133 C133100: C133100 C133200: C133200 C133300: C133300 C133400: C133400 C134: C134 C134000: C134000 C135: C135 C135100: C135100 C135200: C135200 C14: C14 C141: C141 C141100: C141100 C141200: C141200 C141300: C141300 C149: C149 C149100: C149100 C149200: C149200 C149300: C149300 C149400: C149400 C149900: C149900 C15: C15 C151: C151 C151000: C151000 C152: C152 C152100: C152100 C152200: C152200 C152300: C152300 C152400: C152400 C152900: C152900 C16: C16 C161: C161 C161100: C161100 C161200: C161200 C162: C162 C162000: C162000 C17: C17 C170: C170 C170100: C170100 C170900: C170900 C18: C18 C181: C181 C181100: C181100 C181200: C181200 C181300: C181300 C182: C182 C182100: C182100 C182900: C182900 C183: C183 C183100: C183100 C183200: C183200 C184: C184 C184100: C184100 C184200: C184200 C185: C185 C185100: C185100 C185200: C185200 C189: C189 C189100: C189100 C189200: C189200 C189900: C189900 C19: C19 C191: C191 C191100: C191100 C191200: C191200 C191300: C191300 C191400: C191400 C191500: C191500 C191600: C191600 C191900: C191900 C192: C192 C192000: C192000 C20: C20 C201: C201 C201000: C201000 C202: C202 C202100: C202100 C202900: C202900 C203: C203 C203100: C203100 C203200: C203200 C203300: C203300 C203400: C203400 C209: C209 C209000: C209000 C21: C21 C211: C211 C211000: C211000 C212: C212 C212100: C212100 C212200: C212200 C213: C213 C213100: C213100 C213200: C213200 C213300: C213300 C213900: C213900 C214: C214 C214100: C214100 C214200: C214200 C214900: C214900 C22: C22 C221: C221 C221000: C221000 C222: C222 C222100: C222100 C222200: C222200 C222300: C222300 C222400: C222400 C222900: C222900 C223: C223 C223100: C223100 C223900: C223900 C224: C224 C224000: C224000 C229: C229 C229100: C229100 C229200: C229200 C229300: C229300 C229900: C229900 C23: C23 C231: C231 C231100: C231100 C231200: C231200 C231300: C231300 C231900: C231900 C239: C239 C239100: C239100 C239200: C239200 C239300: C239300 C239400: C239400 C239900: C239900 C24: C24 C241: C241 C241100: C241100 C241200: C241200 C241900: C241900 C242: C242 C242100: C242100 C242200: C242200 C242900: C242900 C243: C243 C243100: C243100 C243200: C243200 C243900: C243900 C244: C244 C244100: C244100 C244900: C244900 C245: C245 C245100: C245100 C245200: C245200 C246: C246 C246100: C246100 C246200: C246200 C246300: C246300 C246900: C246900 C249: C249 C249100: C249100 C249900: C249900 C25: C25 C251: C251 C251100: C251100 C251200: C251200 C251300: C251300 C251900: C251900 C259: C259 C259100: C259100 C259200: C259200 C259900: C259900 D26: D26 D261: D261 D261100: D261100 D261200: D261200 D261900: D261900 D262: D262 D262000: D262000 D263: D263 D263000: D263000 D264: D264 D264000: D264000 D27: D27 D270: D270 D270000: D270000 D28: D28 D281: D281 D281100: D281100 D281200: D281200 D29: D29 D291: D291 D291100: D291100 D291900: D291900 D292: D292 D292100: D292100 D292200: D292200 E30: E30 E301: E301 E301100: E301100 E301900: E301900 E302: E302 E302000: E302000 E31: E31 E310: E310 E310100: E310100 E310900: E310900 E32: E32 E321: E321 E321100: E321100 E321200: E321200 E322: E322 E322100: E322100 E322200: E322200 E322300: E322300 E322400: E322400 E323: E323 E323100: E323100 E323200: E323200 E323300: E323300 E323400: E323400 E323900: E323900 E324: E324 E324100: E324100 E324200: E324200 E324300: E324300 E324400: E324400 E324500: E324500 E329: E329 E329100: E329100 E329200: E329200 E329900: E329900 F33: F33 F331: F331 F331100: F331100 F331200: F331200 F331900: F331900 F332: F332 F332100: F332100 F332200: F332200 F332300: F332300 F333: F333 F333100: F333100 F333200: F333200 F333900: F333900 F34: F34 F341: F341 F341100: F341100 F341900: F341900 F349: F349 F349100: F349100 F349200: F349200 F349300: F349300 F349400: F349400 F349900: F349900 F35: F35 F350: F350 F350100: F350100 F350200: F350200 F350300: F350300 F350400: F350400 F350500: F350500 F36: F36 F360: F360 F360100: F360100 F360200: F360200 F360300: F360300 F360400: F360400 F360500: F360500 F360600: F360600 F360900: F360900 F37: F37 F371: F371 F371100: F371100 F371200: F371200 F372: F372 F372000: F372000 F373: F373 F373100: F373100 F373200: F373200 F373300: F373300 F373400: F373400 F373500: F373500 F373600: F373600 F373900: F373900 F38: F38 F380: F380 F380000: F380000 G39: G39 G391: G391 G391100: G391100 G391200: G391200 G391300: G391300 G392: G392 G392100: G392100 G392200: G392200 G40: G40 G400: G400 G400000: G400000 G41: G41 G411: G411 G411000: G411000 G412: G412 G412100: G412100 G412200: G412200 G412300: G412300 G412900: G412900 G42: G42 G421: G421 G421100: G421100 G421200: G421200 G421300: G421300 G421400: G421400 G422: G422 G422100: G422100 G422200: G422200 G422900: G422900 G423: G423 G423100: G423100 G423200: G423200 G424: G424 G424100: G424100 G424200: G424200 G424300: G424300 G424400: G424400 G424500: G424500 G425: G425 G425100: G425100 G425200: G425200 G425300: G425300 G425900: G425900 G426: G426 G426000: G426000 G427: G427 G427100: G427100 G427200: G427200 G427300: G427300 G427400: G427400 G427900: G427900 G43: G43 G431: G431 G431000: G431000 G432: G432 G432000: G432000 H44: H44 H440: H440 H440000: H440000 H45: H45 H451: H451 H451100: H451100 H451200: H451200 H451300: H451300 H452: H452 H452000: H452000 H453: H453 H453000: H453000 I46: I46 I461: I461 I461000: I461000 I462: I462 I462100: I462100 I462200: I462200 I462300: I462300 I47: I47 I471: I471 I471000: I471000 I472: I472 I472000: I472000 I48: I48 I481: I481 I481000: I481000 I482: I482 I482000: I482000 I49: I49 I490: I490 I490000: I490000 I50: I50 I501: I501 I501000: I501000 I502: I502 I502100: I502100 I502900: I502900 I51: I51 I510: I510 I510100: I510100 I510200: I510200 I52: I52 I521: I521 I521100: I521100 I521200: I521200 I521900: I521900 I522: I522 I522000: I522000 I529: I529 I529100: I529100 I529200: I529200 I529900: I529900 I53: I53 I530: I530 I530100: I530100 I530900: I530900 J54: J54 J541: J541 J541100: J541100 J541200: J541200 J541300: J541300 J541400: J541400 J541900: J541900 J542: J542 J542000: J542000 J55: J55 J551: J551 J551100: J551100 J551200: J551200 J551300: J551300 J551400: J551400 J552: J552 J552100: J552100 J552200: J552200 J56: J56 J561: J561 J561000: J561000 J562: J562 J562100: J562100 J562200: J562200 J57: J57 J570: J570 J570000: J570000 J58: J58 J580: J580 J580100: J580100 J580200: J580200 J580900: J580900 J59: J59 J591: J591 J591000: J591000 J592: J592 J592100: J592100 J592200: J592200 J60: J60 J601: J601 J601000: J601000 J602: J602 J602000: J602000 K62: K62 K621: K621 K621000: K621000 K622: K622 K622100: K622100 K622200: K622200 K622300: K622300 K622900: K622900 K623: K623 K623000: K623000 K624: K624 K624000: K624000 K63: K63 K631: K631 K631000: K631000 K632: K632 K632100: K632100 K632200: K632200 K633: K633 K633000: K633000 K64: K64 K641: K641 K641100: K641100 K641900: K641900 K642: K642 K642000: K642000 L66: L66 L661: L661 L661100: L661100 L661900: L661900 L662: L662 L662000: L662000 L663: L663 L663100: L663100 L663200: L663200 L663900: L663900 L664: L664 L664000: L664000 L67: L67 L671: L671 L671100: L671100 L671200: L671200 L672: L672 L672000: L672000 M69: M69 M691: M691 M691000: M691000 M692: M692 M692100: M692100 M692200: M692200 M692300: M692300 M692400: M692400 M692500: M692500 M693: M693 M693100: M693100 M693200: M693200 M694: M694 M694000: M694000 M695: M695 M695000: M695000 M696: M696 M696100: M696100 M696200: M696200 M697: M697 M697000: M697000 M699: M699 M699100: M699100 M699900: M699900 M70: M70 M700: M700 M700000: M700000 N72: N72 N721: N721 N721100: N721100 N721200: N721200 N722: N722 N722000: N722000 N729: N729 N729100: N729100 N729200: N729200 N729300: N729300 N729400: N729400 N729900: N729900 N73: N73 N731: N731 N731100: N731100 N731200: N731200 N731300: N731300 N732: N732 N732000: N732000 O75: O75 O751: O751 O751000: O751000 O752: O752 O752000: O752000 O753: O753 O753000: O753000 O754: O754 O754000: O754000 O755: O755 O755100: O755100 O755200: O755200 O76: O76 O760: O760 O760000: O760000 O77: O77 O771: O771 O771100: O771100 O771200: O771200 O771300: O771300 O771400: O771400 O771900: O771900 O772: O772 O772000: O772000 P80: P80 P801: P801 P801000: P801000 P802: P802 P802100: P802100 P802200: P802200 P802300: P802300 P802400: P802400 P81: P81 P810: P810 P810100: P810100 P810200: P810200 P82: P82 P821: P821 P821100: P821100 P821200: P821200 P821900: P821900 P822: P822 P822000: P822000 Q84: Q84 Q840: Q840 Q840100: Q840100 Q840200: Q840200 Q85: Q85 Q851: Q851 Q851100: Q851100 Q851200: Q851200 Q852: Q852 Q852000: Q852000 Q853: Q853 Q853100: Q853100 Q853200: Q853200 Q853300: Q853300 Q853400: Q853400 Q853900: Q853900 Q859: Q859 Q859100: Q859100 Q859900: Q859900 Q86: Q86 Q860: Q860 Q860100: Q860100 Q860900: Q860900 Q87: Q87 Q871: Q871 Q871000: Q871000 Q879: Q879 Q879000: Q879000 R89: R89 R891: R891 R891000: R891000 R892: R892 R892100: R892100 R892200: R892200 R90: R90 R900: R900 R900100: R900100 R900200: R900200 R900300: R900300 R91: R91 R911: R911 R911100: R911100 R911200: R911200 R911300: R911300 R911400: R911400 R912: R912 R912100: R912100 R912900: R912900 R913: R913 R913100: R913100 R913900: R913900 R92: R92 R920: R920 R920100: R920100 R920200: R920200 R920900: R920900 S94: S94 S941: S941 S941100: S941100 S941200: S941200 S941900: S941900 S942: S942 S942100: S942100 S942200: S942200 S942900: S942900 S949: S949 S949100: S949100 S949900: S949900 S95: S95 S951: S951 S951100: S951100 S951200: S951200 S952: S952 S952000: S952000 S953: S953 S953100: S953100 S953200: S953200 S953300: S953300 S953400: S953400 S953900: S953900 S954: S954 S954000: S954000 S955: S955 S955100: S955100 S955200: S955200 S955900: S955900 S96: S96 S960: S960 S960100: S960100 S960200: S960200 S960300: S960300 T99: T99 T994: T994 T994000: T994000 T995: T995 T995000: T995000 T997: T997 T997000: T997000 T998: T998 T998000: T998000 T999: T999 T999999: T999999 |
| The ICP number of the supply point to SendNotificationOfTransfer for. |
| Whether it is a move-in request or not. |
| Market Process ID. |
| Proposed Transfer Date. |
| User reference. |
Example
{
"icpNumber": "abc123",
"isMovedIn": true,
"anzsicCode": "abc123",
"userReference": "abc123",
"proposedTransferDate": "2020-01-01",
"marketProcessId": "500c164d-38c7-4f74-9ac6-be210197e9e4"
}SetLoyaltyPointsUserInput
The input type for setting the Loyalty Points user.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The account user receiving the points. |
Example
{
"accountNumber": "abc123",
"newLoyaltyPointsUserId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The unique number of the opportunity. |
| The opportunity final outcome. |
Example
{
"opportunityNumber": "abc123",
"outcome": "WON"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The date from which this method is preferred. |
| The ledgers for which this is the preference. |
| The ID of the preferred payment method for automatic preferences. |
Example
{
"accountNumber": "abc123",
"paymentMethod": "abc123",
"ledgerNumbers": "abc123",
"fromDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The details with which to set up the instruction (these will be sent to the vendor). |
| The business ID. |
| The date-time that the instruction is valid from. |
Example
{
"businessId": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"bankDetails": BankDetailsInput
}Input fields
| Name | Description |
|---|---|
| The number of the account. |
| The number of the ledger on which the instruction should be created. |
| The owners of the financial account this instruction represents. |
| Reference returned when storing bank details (StoredPaymentMethodDetails.reference). |
| The date-time that the instruction is valid from. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"storedPaymentMethodDetailsReference": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"owners": OwnerInput
}Input fields
| Name | Description |
|---|---|
| The number of the account. |
| The details with which to set up the instruction (these will be sent to the vendor). |
| The id of the ledger on which the instruction should be created (or "main"). Deprecated The 'ledgerId' field is deprecated. |
| The number of the ledger on which the instruction should be created. |
| The owners of the financial account this instruction represents. |
| Set newly created payment instruction as the active payment preference. |
| The date-time that the instruction is valid from. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"validFrom": "2020-01-01T00:00:00.000Z",
"bankDetails": BankDetailsInput,
"owners": OwnerInput,
"useForAutomatedPayments": true
}Input fields
| Name | Description |
|---|---|
| The email to share the quote with. |
| The quote to share. |
Example
{
"quoteCode": "abc123",
"email": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number to transfer agreements from. |
| The product code for the agreement to be transferred. |
Example
{
"accountNumber": "abc123",
"productCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The market supply point identification number. |
| The source of market data for the enrollment. |
| The requested supply start date for the enrollment. |
Example
{
"requestedSupplyStartDate": "2020-01-01",
"marketDataSource": SimpleServicesMarketDataSourceInput,
"externalIdentifier": "abc123"
}SimpleServicesMarketDataSourceInput
Source of market data for Simple Services enrollment.
Exactly one of the following must be provided: - quotedsupplypointdata: Use a pre-created QuotedSupplyPoint - productcatalogdata: Use product catalog characteristics - agreementtransfer_data: Transfer existing agreements from another account
Input fields
| Name | Description |
|---|---|
| Data for enrollment via agreement transfer. Callers must include an associated account number and product code. If the account spans multiple properties, the group header property identifies the target property. |
| Data for enrollment using product catalog characteristics. |
| Data for enrollment using a pre-created QuotedSupplyPoint. |
Example
{
"quotedSupplyPointData": SimpleServicesQuotedSupplyPointInput,
"productCatalogData": SimpleServicesProductCatalogInput,
"agreementTransferData": SimpleServicesAgreementTransferInput
}Input fields
| Name | Description |
|---|---|
| The monthly payment amount to set for a regular payment schedule. |
| The code of the product to be enrolled. |
| List of product characteristics for the selected product. |
| The datetime when the rates of the product were agreed. This is usually the datetime corresponding to when the quote/offer was generated. |
| List of supply point characteristics. |
Example
{
"product": "abc123",
"ratesAgreedAt": "2020-01-01T00:00:00.000Z",
"productCharacteristicsList": CharacteristicValueInput,
"supplyPointCharacteristicsList": CharacteristicValueInput,
"monthlyPaymentAmount": 1
}Input fields
| Name | Description |
|---|---|
| The id of the QuotedSupplyPoint created for the supply point. |
Example
{
"quotedSupplyPointId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The smart control action, i.e. suspend or unsuspend. |
| The ID of the device. |
Example
{
"deviceId": "abc123",
"action": "SUSPEND"
}Input fields
| Name | Description |
|---|---|
| The ID of the device. |
| The mode of the schedule. |
| The schedule with the preference details. |
| The unit of the min and max values in the preferences schedule. |
Example
{
"deviceId": "abc123",
"mode": "CHARGE",
"unit": "CELSIUS",
"schedules": PreferencesScheduleInput
}Input fields
| Name | Description |
|---|---|
| Account number for the collection process. |
| Identifier for billing document, required only for billing document level collection process. |
| Collection process config code. |
| Ledger number, required only for ledger level collection process. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"billingDocumentIdentifier": "abc123",
"configCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The code for the brand that transactional trigger will use. |
| The number of the user that needs verification. |
| The type of verification to start. |
Example
{
"userNumber": "abc123",
"verificationType": "EMAIL",
"brandCode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number associated with the device. |
| The ID of the device to re-authenticate. |
| The property where the device is located/charged. |
Example
{
"accountNumber": "abc123",
"propertyId": 1,
"deviceId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account to which the device should be registered. |
| The property where the device is located/charged. |
Example
{
"accountNumber": "abc123",
"propertyId": 1
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The date from which automated payments should not be collected. |
| The ledgers for which this is the preference. |
Example
{
"accountNumber": "abc123",
"ledgerNumbers": "abc123",
"fromDate": "2020-01-01"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| |
| |
| Measurement of kWh. |
| |
| |
| |
| |
| |
| The link for the session. It can be a URL. |
| |
|
Example
{
"linkId": "abc123",
"accountNumber": "abc123",
"retailerAccountId": "abc123",
"sessionId": "abc123",
"sessionLink": "abc123",
"sessionStartTime": "2020-01-01T00:00:00.000Z",
"sessionEndTime": "2020-01-01T00:00:00.000Z",
"billToRetailerInclGst": "abc123",
"billToRetailerExclGst": "abc123",
"kWh": "abc123",
"location": ChargeNetLocationType,
"transactions": ChargeNetTransactionType
}Input fields
| Name | Description |
|---|---|
| The account number. |
| The details with which to set up the instruction (these will be sent to the vendor). |
| The id of the ledger on which the instruction should be created (or "main"). Deprecated The 'ledgerId' field is deprecated. |
| The number of the ledger on which the instruction should be created. |
Example
{
"accountNumber": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"bankDetails": BankDetailsInput
}StorePaymentInstructionInput
The input for storing a new payment instruction created through the embedded process.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The type of the new payment instruction. |
| The ID of the ledger to which the instructions will be linked. Deprecated The 'ledgerId' field is deprecated. |
| WARNING: Will be mandatory in future versions The number of the ledger to which the instructions will be linked. |
| Set newly created payment instruction as the active payment preference. |
| The datetime from which the instruction is vaild. If not specified, defaults to the current datetime. |
| The vendor's reference for this payment method. |
Example
{
"accountNumber": "abc123",
"instructionType": "BPAY",
"validFrom": "2020-01-01T00:00:00.000Z",
"vendorReference": "abc123",
"ledgerId": "abc123",
"ledgerNumber": "abc123",
"useForAutomatedPayments": true
}Input fields
| Name | Description |
|---|---|
| The payment action intent details that identify the target for this payment. |
| The payment amount in the minor unit of currency. |
| The description of the payment, as shown to the customer. |
| The date when the payment was made. |
| The details of the payment method used for this payment. |
| The reference used to uniquely identify this payment. |
| The datetime when the payment succeeded. |
Example
{
"actionIntent": PaymentActionIntentOneOfInput,
"reference": "abc123",
"amount": 1,
"paymentDate": "2020-01-01",
"customerReference": "abc123",
"paymentMethod": PaymentMethodInput,
"succeededAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| Name of the market (GBRELECTRICITY, AUSELECTRICITY, etc...). |
| Supply point identifier (NMI, MPAN, MPRN, etc...). |
Example
{
"supplyPointExternalIdentifier": NonEmptyString,
"marketName": NonEmptyString
}Input fields
| Name | Description |
|---|---|
| The supply points external identifier. |
| The market of the supply point. |
Example
{
"marketName": "abc123",
"externalIdentifier": "abc123"
}SupplyPointTaxAdjustmentInput
Input type for a supply point tax adjustment.
Input fields
| Name | Description |
|---|---|
| The type of tax adjustment (e.g., EXEMPTION, REDUCTION). |
| When this adjustment becomes effective. |
| When this adjustment ends (null if open-ended). |
| The proportion of usage that qualifies for the adjustment (0-1). |
| The ID of the supply point. |
| The tax category for this adjustment. |
| The tax subcategory for this adjustment. |
Example
{
"supplyPointId": "abc123",
"taxCategory": "abc123",
"taxSubcategory": "abc123",
"qualifyingUsage": "1.0",
"adjustmentType": "abc123",
"effectiveFrom": "2020-01-01T00:00:00.000Z",
"effectiveTo": "2020-01-01T00:00:00.000Z"
}SwitchAccountToVariablePaymentScheduleInput
Input type for switching an account to a variable payment schedule. Requires an account_number and ledger_number to be provided.
Input fields
| Name | Description |
|---|---|
| Number of the account for which to update the schedule. |
| If true, any conflicting future payment schedules on the ledger will be deleted before creating the new variable schedule. |
| Number of the ledger associated with the current payment schedule. |
| A note to be added to the payment schedule to explain the change. |
| The date from which the variable payment schedule should start. Defaults to today. |
Example
{
"accountNumber": "abc123",
"ledgerNumber": "abc123",
"targetChangeDate": "2020-01-01",
"note": "abc123",
"cancelConflictingSchedules": true
}TaxAdjustmentConfigurationInput
Input type for the TaxAdjustmentConfiguration term.
Input fields
| Name | Description |
|---|---|
| List of supply point tax adjustments. |
| Whether the term is variable. |
Example
{
"isVariable": true,
"adjustments": SupplyPointTaxAdjustmentInput
}Input fields
| Name | Description |
|---|---|
| The ID of the agreement to be terminated. |
| The reason for terminating the agreement. |
| The date and time when the agreement should be terminated. |
| The datetime when the request to terminate was filed. Defaults to 'now'. |
Example
{
"agreementId": "abc123",
"terminateAt": "2020-01-01T00:00:00.000Z",
"reason": "abc123",
"terminatedAt": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The unique identifier of the contract to terminate. |
| The day and time until the contract remains valid. Must not be beyond the current contract end date. |
| Whether to waive any exit fees associated with the contract or not. |
Example
{
"identifier": NonEmptyString,
"validTo": "2020-01-01T00:00:00.000Z",
"waiveExitFee": true
}Input fields
| Name | Description |
|---|---|
| Datetime when the credit transfer permission is valid. |
| Source ledger number of the credit transfer permission. |
| Target ledger number of the credit transfer permission. |
Example
{
"sourceLedgerNumber": "abc123",
"targetLedgerNumber": "abc123",
"activeAt": "2020-01-01T00:00:00.000Z"
}TerminationFeeInput
Input type for the TerminationFeeTerm.
Input fields
| Name | Description |
|---|---|
| The amount of the termination fee. |
| The type of termination fee. |
| Whether the term is variable. |
| The market associated with the termination fee. |
Example
{
"isVariable": true,
"amount": "1.0",
"feeType": NonEmptyString,
"marketName": NonEmptyString
}TimeOfUseOverrideInput
Input type for the TimeOfUseOverrideTerm.
Input fields
| Name | Description |
|---|---|
| Whether the term is variable. |
Example
{
"isVariable": true
}TimeSeriesEntryInput
Input data to represent prices for particular moments and characteristics values.
Input fields
| Name | Description |
|---|---|
| All params that can be associated to the value. |
| The value end of validity. |
| The value start of validity. |
| The time series value. |
| All characteristics and schemes that can be associated to the value. |
Example
{
"periodStart": "2020-01-01T00:00:00.000Z",
"periodEnd": "2020-01-01T00:00:00.000Z",
"value": "1.0",
"params": {"key": "value"},
"variant": VariantProfileInput
}TimeSeriesSpecificationEligibilityScheduleInput
Input type for defining a time series specification eligibility schedule.
This input type is used to specify the details of a time series specification eligibility schedule, including the associated product code, time series specification code, eligibility status, and effective period.
Input fields
| Name | Description |
|---|---|
| The period during which this eligibility is effective. |
| Indicates if the time series specification is eligible. |
| The product code associated with the time series specification. |
| The time series specification code. |
Example
{
"productCode": "abc123",
"timeSeriesSpecificationCode": "abc123",
"isEligible": true,
"effectivePeriod": RateGroupEligibilityPeriodInput
}Input fields
| Name | Description |
|---|---|
| The number of the destination lead. |
| The number of the source lead. |
Example
{
"sourceLeadNumber": "abc123",
"destinationLeadNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The amount ( in lowest unit ) to transfer. If the amount is negative,the effect is reversed (the source ledger's balance increases and the destination ledger's balance decreases). |
| Optional short note about transfer reason. |
| Account's ledger from which the requested amount is debited. |
| Account's ledger to which the requested amount is credited. |
Example
{
"sourceAccountLedger": AccountLedgerInput,
"targetAccountLedger": AccountLedgerInput,
"amount": 1,
"note": "abc123"
}TransferLoyaltyPointsBetweenUsersInput
The input type for transferring Loyalty Points.
Input fields
| Name | Description |
|---|---|
| The account number. |
| The number of Loyalty Points to transfer. |
| The account user receiving the points. |
| The account user sending the points. If not provided, the current viewer will be used. |
Example
{
"accountNumber": "abc123",
"sendingUserId": "abc123",
"receivingUserId": "abc123",
"points": 1
}Input fields
| Name | Description |
|---|---|
| The unique number of the collection process. |
| Whether to run withdrawal and pause assessments just before sending. |
| The identifier for the specific communication step. |
Example
{
"collectionProcessNumber": "abc123",
"stepIdentifier": "abc123",
"runAssessments": true
}Input fields
| Name | Description |
|---|---|
| The ICP number of the supply point to trigger ICP discovery for. |
| Whether this is the initial reading event or not. |
Example
{
"icpNumber": "abc123",
"initial": true
}UnenrollAccountFromLoyaltyProgramInput
The input type used to unenroll an account from the loyalty program.
Input fields
| Name | Description |
|---|---|
| The account number to enroll. |
Example
{
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number associated with this exception. If none is provided, the field won't be updated. |
| The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception. |
| The new category. If none is provided, the field won't be updated. |
| The new context. If none is provided, the field won't be updated. This will completely replace the existing context by the new one. |
| The ID of the API Exception that will be updated. |
| The new key date. If none is provided, the field won't be updated. |
| The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception. |
| The new priority. If none is provided, the field won't be updated. |
| The new resolution status. If none is provided, the field won't be updated. |
| The new resolution type. If none is provided, the field won't be updated. |
| The updated list of tags. If none is provided, the field won't be updated. |
Example
{
"id": 1,
"resolutionStatus": "ASSIGNED",
"resolutionType": "AUTOMATIC",
"priority": "LOW",
"context": {"key": "value"},
"category": "UNKNOWN",
"tags": "MOVE_IN",
"keyDate": "2020-01-01",
"assignedUserId": 1,
"operationsTeamId": 1,
"accountNumber": "abc123"
}Input fields
| Name | Description |
|---|---|
| The ID of the API Exception note being updated. |
| The body of the note. |
Example
{
"body": "abc123",
"apiExceptionNoteId": "abc123"
}UpdateAccountBillingEmailInput
Input fields for updating billing email for an account.
Input fields
| Name | Description |
|---|---|
| Account number for account. |
| The billingemail which can be up to 512 characters. Use null to unset billingemail. |
Example
{
"accountNumber": "abc123",
"billingEmail": "abc123"
}UpdateAccountReferralStatusInput
Required information for updating the status of an account referral
Input fields
| Name | Description |
|---|---|
| The ID of the account referral to update. |
| The new status for the account referral. Status can only move forward: Pending -> Paid or Cancelled. |
Example
{
"referralId": 1,
"status": "PENDING"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"emailFormat": "TEXT",
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"preferredHoldMusic": "NO_SONG_PREFERRED",
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"isOptedInToClientMessages": true,
"isOptedInToOfferMessages": true,
"isOptedInToRecommendedMessages": true,
"isOptedInToUpdateMessages": true,
"isOptedInToThirdPartyMessages": true,
"isOptedInMeterReadingConfirmations": true,
"isOptedInToSmsMessages": true,
"isUsingInvertedEmailColours": true,
"fontSizeMultiplier": 1.0,
"emailFormat": "abc123",
"preferredHoldMusic": "abc123",
"clientMutationId": "abc123"
}Input fields
| Name | Description |
|---|---|
| |
| |
| |
| |
| |
| |
| |
|
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"mobile": "abc123",
"email": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"clientMutationId": "abc123"
}Example
{
"lines": ["abc123"],
"postcode": "abc123"
}Input fields
| Name | Description |
|---|---|
| The contact email for the link. |
| The contact name for the link. |
| Is this link for business customers. |
| The landing URL for the link. |
| The id of the affiliate link that is going to be edited. |
| The organisation for whom to update the affiliate link for. |
| Will be validated as follows:
|
| The training status for the link. |
Example
{
"linkId": "abc123",
"organisationId": "abc123",
"subdomain": "abc123",
"contactName": "abc123",
"contactEmail": "abc123",
"isBusiness": true,
"landingUrl": "abc123",
"trainingStatus": "abc123"
}Input fields
| Name | Description |
|---|---|
| Is this partner allowed to specify payment methods other than Direct Debit in the import csv or API. |
| Are meter point registrations limited for profile classes 1 and 2 for registrations from csv or API. |
| Allow registration requests with customers without an email address. |
| Allow registration requests with exiting account user emails to add to the portfolio belonging to the account user. |
| Allow performing tariff renewals via API. |
| Allow this partner access to the IVR support API (modify their own IVR handling through third party 'IVR Flow Editor'). |
| The primary contact email for the organisation, used to send notifications about API usage such as authentication and permissions. |
| Default Account Type. |
| Restrict to field-sales-only products? This is only allowed for the 'field-sales' and 'events' sales channels. |
| The name of the organisation. |
| The organisation that is going to be edited. |
| Sales Channel. Deprecated The 'salesChannel' field is deprecated. |
| Sales Channel Code. |
| Allow this partner to skip validation that ensures all meter points belong to the same address. |
Example
{
"organisationId": "abc123",
"name": "abc123",
"contactEmail": "abc123",
"salesChannel": "DIRECT",
"salesChannelCode": "abc123",
"defaultAccountType": "BUSINESS",
"canRegisterBusinessMeterPoints": true,
"canRegisterPortfolioAccounts": true,
"canRegisterCustomersWithoutEmailAddress": true,
"skipMeterPointAddressValidation": true,
"allowAlternativePaymentMethods": true,
"canRenewTariffs": true,
"canUseIvrSupportApi": true,
"isFieldSalesOnlyProduct": true
}Input fields
| Name | Description |
|---|---|
| The auxiliary status string. |
| The email address of the support user. |
Example
{
"supportUserEmail": "abc123",
"auxiliaryStatus": "abc123"
}Input fields
| Name | Description |
|---|---|
| A code that uniquely identifies the account. |
| A code that uniquely identifies the agreement. |
| The reason for the change. |
| The start date of the agreement. |
| The end date of the agreement (exclusive). The agreement will end on midnight of this date, such that the previous day is the last day covered by this agreement. |
Example
{
"agreementId": "abc123",
"accountNumber": "abc123",
"validFrom": "2020-01-01",
"validTo": "2020-01-01",
"reason": "abc123"
}UpdateAgreementRescissionInput
Required information for updating an agreement rescission.
Input fields
| Name | Description |
|---|---|
| The reason for failure if the rescission failed. |
| The ID of the agreement rescission to update. |
| The new status for the agreement rescission. |
| The name of the current step in the rescission process. |
| The slug of the current step in the rescission process. |
Example
{
"id": "abc123",
"status": "IN_PROGRESS",
"failureReason": "abc123",
"stepSlug": "abc123",
"stepName": "abc123"
}Input fields
| Name | Description |
|---|---|
| Number of the agreement rollover that is going to be updated. |
| The new expected send date for the agreement rollover. |
| A JSON object containing additional parameters for the agreement rollover. Ensure it's properly encoded. |
| The new product code for the agreement rollover. |
| The new rollover date for the agreement rollover. |
| The new status for the agreement rollover. |
| Suppress Agreement Rollover communications. |
| List of comma-separated tags to be set on the rollover. |
Example
{
"agreementRolloverNumber": "abc123",
"status": "PENDING",
"renewProductCode": "abc123",
"rolloverDate": "2020-01-01",
"expectedSendDate": "2020-01-01",
"suppressComms": true,
"tags": ["abc123"],
"params": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}UpdateAutoTopUpAmountInput
Input type for updating the schedule auto top up amount for for an account. Requires an account_number, ledger_id or ledger_number, and payment_amount to be provided.
Input fields
| Name | Description |
|---|---|
| Account number to update the schedule auto top up amount for. |
| Specifies the ledger ID associated with the current schedule for updates. Deprecated The 'ledgerId' field is deprecated. |
| Specifies the ledger number associated with the current schedule for updates. |
| The new auto-top-up amount for the payment schedule. |
Example
{
"accountNumber": "abc123",
"ledgerId": 1,
"ledgerNumber": "abc123",
"paymentAmount": 1
}Input fields
| Name | Description |
|---|---|
| The boost action. |
| Device ID. |
Example
{
"deviceId": "abc123",
"action": "BOOST"
}Input fields
| Name | Description |
|---|---|
| The reference code for the active flow. |
| External system name. |
| The Collection Process Record Number. |
Example
{
"number": "abc123",
"externalReference": "abc123",
"externalSourceName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The Completion details for the Collection Process. |
| The Completion reason for the Collection Process. |
| The Collection Process Record Number. |
Example
{
"number": "abc123",
"completionReason": "ENDED",
"completionDetails": "abc123"
}UpdateCommsDeliveryPreferenceInput
Input fields for updating comms delivery preferences for an account
Input fields
| Name | Description |
|---|---|
| |
|
Example
{
"accountNumber": "abc123",
"commsDeliveryPreference": "EMAIL"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| Amount of debt. |
| The campaign. |
| Notes for the commencement. |
Example
{
"accountNumber": "abc123",
"campaign": "abc123",
"amount": 1,
"notes": "abc123"
}Input fields
| Name | Description |
|---|---|
| Device ID. |
| Whether or not the device grid export is enabled. |
Example
{
"deviceId": "abc123",
"enabled": true
}UpdateDocumentAccessibilityPreferenceInput
Input fields for updating document accessibility preference for an account
Input fields
| Name | Description |
|---|---|
| Account number for account. |
| Document accessibility preference option. Use null to reset to standard format. |
Example
{
"accountNumber": "abc123",
"documentAccessibilityPreference": "LARGE_PRINT"
}Input fields
| Name | Description |
|---|---|
| The keys and values to be updated. |
| The unique number of the opportunity to update. |
Example
{
"opportunityNumber": "abc123",
"items": ExtraDetailsItem
}Input fields
| Name | Description |
|---|---|
| The ID of the device to update. |
| Whether to enable charging duration capping. |
Example
{
"deviceId": "abc123",
"enabled": true
}Input fields
| Name | Description |
|---|---|
| The name of th team the lead is assigned to. |
| The username of the user to assign the lead to. |
| The unique number of the lead to update. |
Example
{
"leadNumber": "abc123",
"assignedToUsername": "abc123",
"assignedToTeamName": "abc123"
}Input fields
| Name | Description |
|---|---|
| The account number for the lead. |
| The billing address for the lead. |
| The funnel fields for the lead. |
| The unique number of the lead to update. |
| The national ID for the lead. |
Example
{
"leadNumber": "abc123",
"extraDetails": ExtraDetailsItem,
"accountNumber": "abc123",
"nationalId": "abc123",
"billingAddress": RichAddressInput
}Input fields
| Name | Description |
|---|---|
| The current stage of the lead to validate the transition. |
| The unique number of the lead to update. |
| The stage that the lead should be updated to. |
Example
{
"leadNumber": "abc123",
"stage": "abc123",
"currentStage": NonEmptyString
}Input fields
| Name | Description |
|---|---|
| Future billing address. |
| The ID of the LeaveSupplier process to update. Deprecated The 'leaveSupplierProcessId' field is deprecated. |
| |
| The number of the LeaveSupplier process to update. |
| The requested last day of supply. |
| The type of leave supplier process to initiate. |
Example
{
"marketData": LeaveSupplierMarketInputType,
"futureBillingAddress": RichAddressInput,
"subtype": "MOVE_OUT",
"requestedSupplyEndDate": "2020-01-01",
"leaveSupplierProcessId": NonEmptyID,
"number": NonEmptyID
}Input fields
| Name | Description |
|---|---|
| The message to set the tags on. |
| The tag names to set on the message. |
| The tag code to set on the message. |
| The tag version to set on the message. |
Example
{
"messageRelayId": "abc123",
"tagNames": "abc123",
"taggerCode": "abc123",
"taggerVersion": "abc123"
}Input fields
| Name | Description |
|---|---|
| The note to update on the opportunity. |
| The unique number of the opportunity to update the notes for. |
Example
{
"opportunityNumber": "abc123",
"notes": "abc123"
}Input fields
| Name | Description |
|---|---|
| The identifier of the offer group for the opportunity. |
| The unique number of the opportunity. |
Example
{
"opportunityNumber": "abc123",
"offerGroupId": "abc123"
}Input fields
| Name | Description |
|---|---|
| The name of th team the opportunity is assigned to. |
| The username of the user to assign the opportunity to. |
| The unique number of the opportunity to update. |
Example
{
"opportunityNumber": "abc123",
"assignedToUsername": "abc123",
"assignedToTeamName": "abc123"
}Input fields
| Name | Description |
|---|---|
| New supply points on the opportunity. |
| The new address for the opportunity. |
| The funnel fields for the opportunity. |
| The unique number of the opportunity to update. |
| Remove supply points on the opportunity. |
Example
{
"opportunityNumber": "abc123",
"address": RichAddressInput,
"extraDetails": ExtraDetailsItem,
"addSupplyPoints": LeadSupplyPoint,
"removeSupplyPoints": LeadSupplyPoint
}Input fields
| Name | Description |
|---|---|
| The current stage of the opportunity. |
| The unique number of the opportunity to update. |
| The stage that the opportunity should be updated to. |
Example
{
"opportunityNumber": "abc123",
"stage": "abc123",
"currentStage": NonEmptyString
}Input fields
| Name | Description |
|---|---|
| New password. |
| Confirm new password. |
| Old password. |
Example
{
"oldPassword": "abc123",
"newPassword": "abc123",
"newPasswordConfirmed": "abc123"
}UpdateProductPricesInput
Rate group prices for a product.
Input fields
| Name | Description |
|---|---|
| The period for the price. |
| The period for the price. |
| The rate group prices. |
| The product code. |
Example
{
"product": "abc123",
"prices": RateGroupPricesInput,
"periodStart": "2020-01-01T00:00:00.000Z",
"periodEnd": "2020-01-01T00:00:00.000Z"
}Input fields
| Name | Description |
|---|---|
| The account number. |
| A JSON object containing client parameters to store on the purchase. |
| A JSON object containing market parameters to store on the purchase. |
| The purchase ID. |
| Products being purchased. |
Example
{
"accountNumber": "abc123",
"purchaseId": "abc123",
"saleItems": ProductToPurchaseInput,
"marketParams": {"key": "value"},
"clientParams": {"key": "value"}
}Input fields
| Name | Description |
|---|---|
| |
| User details. |
| |
| |
| |
| A free text field to help identifying the customer (e.g. for a job title). |
| Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| How the user would like us to address them (e.g. 'she/her', 'they/them'). Because this field is clearable, null and the empty string are treated differently; passing null or omitting the field leaves the value as-is, but explicitly passing an empty string clears this value. |
| The user's title. |
| The user for whom to perform the update. This is only needed when using an Organisation role. |
Example
{
"givenName": "abc123",
"familyName": "abc123",
"pronouns": "abc123",
"email": "abc123",
"mobile": "abc123",
"dateOfBirth": "2020-01-01",
"landline": "abc123",
"userId": "abc123",
"title": "abc123",
"label": "abc123",
"details": DetailsInputType
}Input fields
| Name | Description |
|---|---|
| The ID of the SmartFlex onboarding step to complete. |
| A json object of user input key-value pairs where the key should match the key of the requested input. |
| The ID of the SmartFlex onboarding wizard. |
Example
{
"wizardId": "abc123",
"stepId": "abc123",
"userInputs": {"key": "value"}
}UtilityFiltersInput
Filter measurements by the given utility parameters.
Input fields
| Name | Description |
|---|---|
| Filter measurements by electricity parameters. |
Example
{
"electricityFilters": ElectricityFiltersInput
}ValidateEmailInput
Input required to validate email address via Kickbox
Input fields
| Name | Description |
|---|---|
| Check if an email is already in use. |
| The user's email address. |
Example
{
"email": "abc123",
"checkUniqueness": true
}Input fields
| Name | Description |
|---|---|
| MFA method. |
| Token sent to the user via the MFA method. |
Example
{
"mfaMethod": "EMAIL",
"token": "abc123"
}Input fields
| Name | Description |
|---|---|
| The user's phone number. |
Example
{
"phoneNumber": "abc123"
}VariantProfileInput
Object representing a variant profile.
Input fields
| Name | Description |
|---|---|
| The characteristic values for the variant. |
| The scheme labels for the variant. |
Example
{
"characteristicValues": {"key": "value"},
"schemeLabels": {"key": "value"}
}VaryContractTermsInput
Input type for varying contract terms.
Input fields
| Name | Description |
|---|---|
| The date from which the varied terms will apply. |
| The unique identifier of the contract to vary. |
| The terms to be varied in the contract. |
Example
{
"identifier": NonEmptyString,
"applicableAt": "2020-01-01T00:00:00.000Z",
"terms": OneOfTermInput
}Input fields
| Name | Description |
|---|---|
| Account number. |
| |
| |
| |
| |
|
Example
{
"accountNumber": "abc123",
"weekdayTargetTime": "abc123",
"weekdayTargetSoc": 1,
"weekendTargetTime": "abc123",
"weekendTargetSoc": 1,
"targetType": "abc123"
}Input fields
| Name | Description |
|---|---|
| The verification code sent to the customer. |
| The type of verification to be checked. |
Example
{
"verificationCode": "abc123",
"verificationType": "EMAIL"
}Input fields
| Name | Description |
|---|---|
| The number of the account belonging to the user (e.g. A-12345678). |
| The first line of the user's address (this could be the energy supply property address or the billing address on the account). |
| The user's full name. |
| The user's postcode (this could be the postcode of the energy supply property address or of the billing address on the account). |
Example
{
"accountNumber": "abc123",
"postcode": "abc123",
"fullName": "abc123",
"firstLineOfAddress": "abc123"
}Input fields
| Name | Description |
|---|---|
| Account number for which to withdraw the dunning process. |
| An optional note for the withdraw. |
| The dunning process path name to withdraw. |
Example
{
"accountNumber": "abc123",
"pathName": "abc123",
"note": "abc123"
}Input fields
| Name | Description |
|---|---|
| The key of the extra detail item. |
| The value of the extra detail item. Can be a string or an integer. |
Example
{
"key": "abc123",
"value": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType
}Input fields
| Name | Description |
|---|---|
| Quoting parameter value. |
Example
{
"value": "2020-01-01T00:00:00.000Z"
}_DefaultMarketTerminationInput
Default input required to initiate a LeaveSupplier journey for a given market. This type should only be used when there are no configured markets while building the LeaveSupplierMarketInputType.
Input fields
| Name | Description |
|---|---|
| The market supply point identification number. |
Example
{
"supplyPointIdentifier": "abc123"
}Input fields
| Name | Description |
|---|---|
| Quoting parameter value of type DateTime. |
| Quoting parameter value of type Integer. |
| Quoting parameter name. |
| Quoting parameter value of type Float. |
| Quoting parameter value of type String. |
Example
{
"name": "abc123",
"string": _StringParam,
"integer": _IntegerParam,
"number": _FloatParam,
"datetime": _DateTimeParam
}Input fields
| Name | Description |
|---|---|
| Quoting parameter value. |
Example
{
"value": "abc123"
}