Customer/Account Move

Moves

Scenarios

Move end point is used to perform following scenarios on the specified account:

Move in new customer
Move in exising customer
move out and vacant
editing existing move

moving scenario will be detected using MoveScenarioCode property of the move model or type of properties passed, refer to documentation of the "MoveScenarioCode" below.

Optional properties

Move model contains many optional properties to facilitate keeping customer's information up to date while performing move process. for example following properties can be used optionally to update move in customer's information:

MoveInCustomer
MoveInCocustomers
MoveInAddresses
MoveInContactInformation
MoveInComments
MoveInDeposits
MoveInPaymentPlan
ServiceBasicMultipliers

and similary following properties exist for updating move out customer's information:

MoveOutCustomerAccount
MoveOutCocustomers
MoveOutAddresses
MoveOutContactInformation
MoveOutComment
BalanceTransfer

Feedback properties

There are some properties defined to indicate how the move process should be controled, for example passing proper value for the following properties indicates how the gap between move in date and move out date should be managed:

ResolveIsVacantBetweenMoves
ResolveIsAutoOwnerBetweenMoves

Complete list of properties and their explainations can be found in the move model.

FAQ

How should I build the move model?: Currently new call is not supported for the move end point and you need to build the model using separate new calls on different end points. for example making a NEW call to "/data/customer" will return an empty customer model that can be modified and passed a move in customer.
Can I pass "" instead of "_blank" for property values: Properties with defined enum values should be populated properly, passing empty string instead of _blank will cause validation error.
what is the customer number ‘99999999’?: Customer number should be a valid record exist in the system or the value ‘99999999’ as a place holder. ‘99999999’ will be replaced with valid customer number if no validation error happens during processing the move.

Move Model(Typescript)

Also available for C# and JavaScript

/**
 * A model that contains Move data.
 * The account number on which the move is done is not part of the data. It is
 * obtained from resource URL.
 */
export default class MoveModel extends ApiBase {
  /**
   * Account number is mandatory and should be a valid number already exist in the system. Required!
   */
  public AccountNumber: string = '';
  /**
   * Used to process the task based on the status, acceptable values: (N=New, U=Update, C=Cancel). Required only if
   * Task property is passed!
   */
  public Status: string = '';
  /**
   * The date when the Move Out Customer moves out from the account. If not provided, MoveInDate will be used as
   * MoveOutDate. Optional if MoveInDate is passed, otherwise required!
   */
  public MoveOutDate?: Date;
  /**
   * The date when the Move In Customer moves in into the account. If not provided, MoveOutDate will be used as
   * MoveInDate. Optional if MoveOutDate is passed, otherwise required!
   */
  public MoveInDate?: Date;
  /**
   * Occupancy code ('O' for Owner, 'T' for Tenant) for the Move In Customer. Required for MoveIn scenario!
   */
  public OccupancyCode: string = '';
  /**
   * Customer model contains information about the customer moving into the account. 
   * Notes:
   * Customer information will be updated during the move processes using provided information.
   * Customer number should be a valid record exist in the system or the value ‘99999999’ as a place holder. ‘99999999’ will be replaced with valid customer
   * number if no validation error happens during processing the move.
   * In other word, if customer number is ‘99999999’ a new customer will be created during the move process otherwise it will update the existing customer.
   * Required for MoveIn scenario!
   */
  public MoveInCustomer?: CustomerModel;
  /**
   * Optional list of related customers who move in into the account with the move in customer.If provided, they
   * will be saved as related customers of the move in customer.
   * Important notice:
   * If list is passed, it should contain aLL the co-customers for the move in customer. 
   * Any existing co-customers not included in the list will be deleted during the move process! 
   * If property is not passed or the list is empty, no data change will be made to co-customers linked to the move in customer!
   * Optional otherwise list of all co-customers linked with the move in customer!
   */
  public MoveInCocustomers: CocustomerModel[] = [];
  /**
   * Optional list of addresses for move in customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the supported addresses for the move in customer. 
   * Any existing address not included in the list will be deleted during the move process! 
   * Supported addresses can be configured in the move control and usually it contains mailing address and forwarding address. 
   * All the addresses not included in supported address will be ignored.
   * If property is not passed or the list is empty, no data change will be made to addresses for the move in customer!
   * Optional otherwise list of all supported addresses linked with the move in customer!
   */
  public MoveInAddresses: AddressModel[] = [];
  /**
   * Optional list of contact information for the move in customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the contact information for the move in customer. 
   * Any existing contact information not included in the list will be deleted during the move process! 
   * If property is not passed or list is empty, no data change will be made to addresses for the move in customer!
   * Optional otherwise list of all contact information for the move in customer
   */
  public MoveInContactInformation: ContactInformationModel[] = [];
  /**
   * Deprecated property, please use MoveInComments.
   */
  public MoveInComment?: CommentModel;
  /**
   * Customer moving out from the account, If not provided, active customer on the account will be used as
   * MoveOutCustomer. Optional!
   * Note: 
   * Currently changes being made to this model will be ignored however, this may change in 
   * later builds to support updating MoveOutCustomer during the move process.
   */
  public MoveOutCustomer?: CustomerModel;
  /**
   * Optional list of related customers linked with the move out customer.If provided, they will be saved as related
   * customers of the move out customer.
   * Important notice:
   * If list is passed, it should contain aLL the co-customers for the move out customer. 
   * Any existing co-customers not included in the list will be deleted during the move process! 
   * If property is not passed or the list is empty, no data change will be made to co-customers linked to the move out customer!
   * Optional otherwise list of all co-customers linked with the move out customer!
   */
  public MoveOutCocustomers: CocustomerModel[] = [];
  /**
   * Optional list of addresses for move out customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the supported addresses for the move out customer. 
   * Any existing address not included in the list will be deleted during the move process! 
   * Supported addresses can be configured in the move control and usually it contains mailing address and forwarding address. 
   * All the addresses not included in supported address will be ignored.
   * If property is not passed or the list is empty, no data change will be made to addresses for the move out customer!
   * Optional otherwise list of all supported addresses linked with the move out customer!
   */
  public MoveOutAddresses: AddressModel[] = [];
  /**
   * Optional list of contact information for the move out customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the contact information for the move out customer. 
   * Any existing contact information not included in the list will be deleted during the move process! 
   * If property is not passed or list is empty, no data change will be made to addresses for the move out customer!
   * Optional otherwise list of all contact information for the move out customer
   */
  public MoveOutContactInformation: ContactInformationModel[] = [];
  /**
   * Optional Move Out comment. If provided, it will be saved as the Move Out comment for the Move Out
   * customer/account
   */
  public MoveOutComment?: CommentModel;
  /**
   * Indicates whether to register move in customer for e-bills.
   */
  public ReceiveEbills: boolean = false;
  /**
   * Indicates whether to register move in customer for e-notices.
   */
  public ReceiveEnotices: boolean = false;
  /**
   * Indicates whether Transfer auto-pay for existing move in customer.
   */
  public TransferAutopay: boolean = false;
  /**
   * CustomerAccount object associated with the customer moving into the account.
   * This property needs to be provided "ONLY" for "EDITING" existing moveInOut scenario.
   * Note: 
   * If provided, CustomerAccount object will be updated with the provided properties during the move process.
   * Required for editing existing MoveInOut!
   */
  public MoveInCustomerAccount?: CustomerAccountModel;
  /**
   * CustomerAccount object associated with the customer moving out. Optional!
   * Note: 
   * If provided, CustomerAccount
   * object will be updated with the provided properties during the move process.
   */
  public MoveOutCustomerAccount?: CustomerAccountModel;
  /**
   * Optional Task object that will be stored in CIS to hold serialized move data. Optional!
   */
  public Task?: TaskModel;
  /**
   * Move scenario to process. Optional!
   * If no value is passed for this property following logic will be used to determine the move scenario:
   * If both MoveInCustomer and MoveOut customer are provided => MoveInMoveOut
   * If only MoveInCustomer is provided => MoveIn
   * If only MoveOutCustomer is provided => MoveOut
   * Note: It is recommended to pass the desired MoveScenarioCode.
   */
  public MoveScenarioCode: string = '';
  /**
   * Optional list of AccountServiceGroup object with updated vacant read activities. Optional!
   */
  public UpdatedAccountServiceGroups: AccountServiceGroupModel[] = [];
  /**
   * Optional list of comments for the move in customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the comments for the move in customer.
   * Any existing comment not included in the list will be deleted during the move process! 
   * If property is not passed or list is empty, no data change will be made to comments for the move in customer!
   * Optional otherwise list of all comments for the move in customer!
   */
  public MoveInComments: CommentModel[] = [];
  /**
   * List of Action ids to be performed during the move in process. Optional!
   */
  public SelectedMoveInActionsKeys: number[] = [];
  /**
   * List of service order keys linked with the account that needs to be canceled during the MoveIn process.
   * Optional!
   */
  public CancelledServiceOrderKeys: number[] = [];
  /**
   * [Optional otherwise list of all deposits for the move in customer]
   * Optional list of deposits for the move in customer.
   * Important notice:
   * If list is passed, it should contain "ALL" the deposits for the move in customer.
   * Any existing deposit not included in the list will be deleted during the move process! 
   * If property is not passed or list is empty, no data change will be made to deposits for the move in customer!
   */
  public MoveInDeposits: DepositModel[] = [];
  /**
   * Optional payment plan object for the MoveInCustomer. Optional!
   */
  public MoveInPaymentPlan?: MoveInPaymentPlanModel;
  /**
   * Indicates whether hold MoveIn customer's service orders
   */
  public HoldMoveInCustomerServiceOrders: boolean = false;
  /**
   * Optional list of all serviceBasicMultipliers for the move in customer.
   * Important notice:
   * If list is passed,
   * it should contain "ALL" the serviceBasicMultipliers for the move in customer.
   * Any existing serviceBasicMultipliers not included in the list will be deleted during the move process! 
   * If property is not passed or list is empty, no data change will be made to serviceBasicMultipliers for the move in customer!
   * Optional otherwise list of all serviceBasicMultipliers for the move in customer!
   */
  public ServiceBasicMultipliers: ServiceBasicMultiplierModel[] = [];
  /**
   * Optional balance transfer object for the MoveOutCustomer. Optional!
   */
  public BalanceTransfer?: MoveBalanceTransferModel;
  /**
   * FOR INTERNAL USE ONLY! SHOULD NOT BE USED BY THIRD PARTY COMPANIES!
   * Data/parameters used for validating Move
   * process pages/ business objects used in transactional mode
   */
  public ValidationParameters?: MoveValidationModel;
  /**
   * Indicates whether automatically resolve feedbacks have only one option to resolve
   */
  public ResolveOnlyOptionFeedbacks: boolean = false;
  /**
   * Indicates whether insert vacant period between move out date and move in date
   */
  public ResolveIsVacantBetweenMoves: boolean = false;
  /**
   * Indicates whether to move in auto move owner of the account for the period between move out date and move in
   * date
   */
  public ResolveIsAutoOwnerBetweenMoves: boolean = false;
  /**
   * Warns that the customer/account being moved out is in a billing batch. Confirm you want to proceed with the
   * move anyways by resolving with "0".
   */
  // tslint:disable-next-line:variable-name
  public Option_MoveOutCustomerInBillingBatch: number = 0;
  /**
   * Warns that the move out date is before the previous reading date on the account. Confirm you want to proceed
   * with the move anyways by resolving with "0".
   */
  // tslint:disable-next-line:variable-name
  public Option_MoveOutDateBeforePreviousReadingDate: number = 0;
  /**
   * Warns that the membership type of the move in customer does not match the default set for that name type.
   * Confirm how this should be handled. "0" changes the customer membership type, "1" leaves the membership type alone, and
   * "-1" rejects the move.
   */
  // tslint:disable-next-line:variable-name
  public Option_ChangeMoveInCustomerMembershipTypeToValueForNameType: number = 0;
  /**
   * Warns that the membership type of the move in customer does not match the default set for that account. Confirm
   * how this should be handled. "0" changes the customer membership type, "1" leaves the membership type alone, and
   * "-1" rejects the move.
   */
  // tslint:disable-next-line:variable-name
  public Option_ChangeMoveInCustomerMembershipTypeToDefaultValue: number = 0;
  /**
   * Warns that a final bill service order has already been created for this customer/account. Confirm what you want
   * to do with it. "0" keeps the service order, while option "1" cancels the service order. "-1" rejects the move
   * process.
   */
  // tslint:disable-next-line:variable-name
  public Option_ProcessFinalBillSO: number = 0;
  /**
   * Allow duplicate SSN for Customer
   */
  // tslint:disable-next-line:variable-name
  public Option_CustomerAllowDuplicateSIN: number = 0;
  /**
   * FOR INTERNAL USE ONLY! SHOULD NOT BE USED BY THIRD PARTY COMPANIES!
   * Data/parameters used to Inquiry move data for the passed model.
   * Note: If provided model will be used ONLY to inquiry the result and will not perform the move process.
   */
  public InquiryParameters?: MoveInquiryModel;
}

Sample json data

Move in new customer

javascript code used to generate following model can be downloaded from here.

{
  "MoveScenarioCode": "MI",
  "moveInDate": "2020-06-30T00:00:00.000Z",
  "AccountNumber": "0228500",
  "OccupancyCode": "T",
  "MoveInCustomer": {
    "_links": {},
    "_embedded": null,
    "Age": null,
    "CustomerNumber": "9999999999",
    "LastName": "Smith",
    "FirstName": "Bob",
    "MiddleName": "",
    "Suffix": "",
    "Prefix": "_blank",
    "SIN_SSN": "",
    "DriverLicenseNumber": "",
    "EmailAddress": "",
    "WebPageURL": "",
    "OldCustomerNumber": "",
    "DateOfBirth": "1980-01-01T00:00:00.000Z",
    "SendOptionalMail": false,
    "UDF_Char_1": "",
    "UDF_Char_2": "",
    "UDF_Char_3": "",
    "UDF_Char_4": "",
    "UDF_Char_5": "",
    "BalanceTransferAccount": "",
    "ExcludeFromBalanceTransfer": false,
    "Email2": "",
    "Email3": "",
    "IsValidated": false,
    "ValidationDatetime": null,
    "ValidationSource": "",
    "ValidationResult": "",
    "CareOfName": "",
    "Designee": "",
    "DriverLicenseJurisdiction": "",
    "Email2Type": "",
    "Email3Type": "",
    "FormattedName": "",
    "FullName": "",
    "Language": "",
    "Membership": "",
    "MembershipStatus": "",
    "NameType": "R",
    "SortName": ",   ()",
    "Option_AllowDuplicateSIN": -1,
    "Option_AllowInvalidCustomer": -1,
    "O_Code": "",
    "O_Description": "",
    "O_Key": 0,
    "O_SecurityId": 10511696,
    "O_CustomData": {}
  },
  "MoveInContactInformation": [
    {
      "_links": {},
      "_embedded": null,
      "Customer": "9999999999",
      "Account": "",
      "ContactTimes": "",
      "ContactDetails": "1234567890",
      "FormattedPhoneNumber": "",
      "DatetimeUpdated": "2021-03-24T10:11:51.4352718-04:00",
      "Preferred": false,
      "Notes": "",
      "CustomFlag1": false,
      "ContactInfoId": 0,
      "AddressType": "",
      "ContactType": "CE",
      "Option_ConfirmRemovePreferred": -1,
      "O_Code": "---",
      "O_Description": "",
      "O_Key": 0,
      "O_SecurityId": 13450562,
      "O_CustomData": {}
    }
  ],
  "MoveInAddresses": [
    {
      "_links": {},
      "_embedded": null,
      "Customer": "",
      "Account": "",
      "Address1": "",
      "Address2": "",
      "POBox": "",
      "StreetNumberOld": "",
      "StreetNumber": 123,
      "Street": "Bay",
      "Apt": "",
      "Town": "Toronto",
      "PostalCode": "A1A1A1",
      "Plan": "",
      "LotNumber": "",
      "Concession": "",
      "LastName": "",
      "FirstName": "",
      "MiddleName": "",
      "NameSuffix": "",
      "NamePrefix": "_blank",
      "EmailAddress": "",
      "Url": "",
      "Country": "",
      "DeliveryPoint": "",
      "IsValidated": false,
      "Pk": 0,
      "AllowSendBill": false,
      "AllowSendNotice": false,
      "AllowOverrideForwardingAddress": false,
      "AllowOverrideMoveFromAddress": false,
      "AllowOverrideMailingAddress": false,
      "StartDate": null,
      "EndDate": null,
      "AllowSeasonalOverride": false,
      "AllowOverrideServiceAddress": false,
      "ExternalReferenceId": "",
      "DatetimeUpdated": "2021-03-24T10:11:51.4482367-04:00",
      "LastExternalUpdate": null,
      "CustomFlag1": false,
      "DatetimeAddressValidated": null,
      "AddressValidationSource": "",
      "POBoxNumber": null,
      "DeliveryInstallationName": "",
      "ValidationResult": "",
      "AddressType": "MA",
      "DeliveryInstallationType": "",
      "DriverLicenseJurisdiction": "",
      "Empty": true,
      "FormattedAddress": "",
      "IsValidationApplied": false,
      "Name": "",
      "NameType": "",
      "O_IgnoreOnDeleteCheck": "BIF010",
      "Relationship": "",
      "State": "ON",
      "StreetNumberSuffix": "",
      "StreetPrefix": "",
      "StreetSuffix": "",
      "Option_AllowInvalidAddress": -1,
      "Option_ConfirmMatchedAddress": -1,
      "Option_ExceptionOnValidationMatchOverflow": -1,
      "Option_MultipleAddress": -1,
      "Option_OverrideExistingOverride": -1,
      "O_Code": "--",
      "O_Description": "",
      "O_Key": 0,
      "O_SecurityId": 16814188,
      "O_CustomData": {}
    }
  ]
}

Move out and vacant

javascript code used to generate following model can be downloaded from here.

{
  "MoveScenarioCode": "MO",
  "moveOutDate": "2020-05-30T00:00:00.000Z",
  "AccountNumber": "0202410",
  "MoveOutCustomer": {
    "_links": {
      "self": {
        "href": "https://trunkrest.advancedutility.com/data/customer/00001260"
      }
    },
    "_embedded": null,
    "Age": 62,
    "CustomerNumber": "00001260",
    "LastName": "ALSTON",
    "FirstName": "MARIE",
    "MiddleName": "ISABEL",
    "Suffix": "",
    "Prefix": "_blank",
    "SIN_SSN": "123456789",
    "DriverLicenseNumber": "G00001260",
    "EmailAddress": "",
    "WebPageURL": "",
    "OldCustomerNumber": "",
    "DateOfBirth": "1959-01-20T00:00:00",
    "SendOptionalMail": false,
    "UDF_Char_1": "",
    "UDF_Char_2": "220925498",
    "UDF_Char_3": "",
    "UDF_Char_4": "",
    "UDF_Char_5": "",
    "BalanceTransferAccount": "",
    "ExcludeFromBalanceTransfer": false,
    "Email2": "",
    "Email3": "",
    "IsValidated": false,
    "ValidationDatetime": null,
    "ValidationSource": "",
    "ValidationResult": "",
    "CareOfName": "",
    "Designee": "",
    "DriverLicenseJurisdiction": "NJ",
    "Email2Type": "",
    "Email3Type": "",
    "FormattedName": "MARIE ISABEL ALSTON",
    "FullName": "MARIE ISABEL ALSTON",
    "Language": "E",
    "Membership": "",
    "MembershipStatus": "",
    "NameType": "R",
    "SortName": "ALSTON, MARIE ISABEL (00001260)",
    "Option_AllowDuplicateSIN": -1,
    "Option_AllowInvalidCustomer": -1,
    "O_Code": "00001260",
    "O_Description": "00001260",
    "O_Key": 37,
    "O_SecurityId": 10511696,
    "O_CustomData": {}
  },
  "MoveOutContactInformation": [
    {
      "_links": {},
      "_embedded": null,
      "Customer": "00001260",
      "Account": "",
      "ContactTimes": "",
      "ContactDetails": "1234567890",
      "FormattedPhoneNumber": "",
      "DatetimeUpdated": "2021-03-24T10:08:47.9574935-04:00",
      "Preferred": false,
      "Notes": "",
      "CustomFlag1": false,
      "ContactInfoId": 0,
      "AddressType": "",
      "ContactType": "CE",
      "Option_ConfirmRemovePreferred": -1,
      "O_Code": "---",
      "O_Description": "",
      "O_Key": 0,
      "O_SecurityId": 13450562,
      "O_CustomData": {}
    }
  ],
  "MoveOutAddresses": [
    {
      "_links": {},
      "_embedded": null,
      "Customer": "",
      "Account": "",
      "Address1": "",
      "Address2": "",
      "POBox": "",
      "StreetNumberOld": "",
      "StreetNumber": 123,
      "Street": "Bay",
      "Apt": "",
      "Town": "Toronto",
      "PostalCode": "A1A1A1",
      "Plan": "",
      "LotNumber": "",
      "Concession": "",
      "LastName": "",
      "FirstName": "",
      "MiddleName": "",
      "NameSuffix": "",
      "NamePrefix": "_blank",
      "EmailAddress": "",
      "Url": "",
      "Country": "",
      "DeliveryPoint": "",
      "IsValidated": false,
      "Pk": 0,
      "AllowSendBill": false,
      "AllowSendNotice": false,
      "AllowOverrideForwardingAddress": false,
      "AllowOverrideMoveFromAddress": false,
      "AllowOverrideMailingAddress": false,
      "StartDate": null,
      "EndDate": null,
      "AllowSeasonalOverride": false,
      "AllowOverrideServiceAddress": false,
      "ExternalReferenceId": "",
      "DatetimeUpdated": "2021-03-24T10:08:47.9714567-04:00",
      "LastExternalUpdate": null,
      "CustomFlag1": false,
      "DatetimeAddressValidated": null,
      "AddressValidationSource": "",
      "POBoxNumber": null,
      "DeliveryInstallationName": "",
      "ValidationResult": "",
      "AddressType": "FA",
      "DeliveryInstallationType": "",
      "DriverLicenseJurisdiction": "",
      "Empty": true,
      "FormattedAddress": "",
      "IsValidationApplied": false,
      "Name": "",
      "NameType": "",
      "O_IgnoreOnDeleteCheck": "BIF010",
      "Relationship": "",
      "State": "ON",
      "StreetNumberSuffix": "",
      "StreetPrefix": "",
      "StreetSuffix": "",
      "Option_AllowInvalidAddress": -1,
      "Option_ConfirmMatchedAddress": -1,
      "Option_ExceptionOnValidationMatchOverflow": -1,
      "Option_MultipleAddress": -1,
      "Option_OverrideExistingOverride": -1,
      "O_Code": "--",
      "O_Description": "",
      "O_Key": 0,
      "O_SecurityId": 16814188,
      "O_CustomData": {}
    }
  ]
}