Table of Contents

API : Internet Accounts Move

Introduction

This request will move a single Internet account from one customer to another (DSL only)

Request

URL https://api.telecomx.dk/internet/account/ACCOUNT_ID/move
Method POST
Access level RESELLER_ADMIN, ADMIN.
Property Type Description
Params ACCOUNT_ID Id Id of the Internet account.
Body address Id Id of new installation address (must be an address on the new customer)
customer Id Id of new customer

Query examples

{
  customer: '0123456789ABCD0123456789',
  address: '2123456789ABCD0123456789'
}

Response

Property Type Description
_id Id Unique id of the Internet account.
type String Type of circuit: DSL or FIBER.
state String State of product:
ORDERED - customer/reseller has ordered the account.
CONFIRMED - the account has been confirmed for delivery on the specified date.
ACTIVE - the account is in active use.
CANCELLED - the account has been cancelled and will terminate on the specified date.
customer Id Id of customer the account belongs to.
orderedBy Id Id of the employee who ordered the account.
address Id Id of installation address
address2 Id Id of installation address2 (if it is a point-2-point account).
circuit String Id of the circuit.
product Id Id of the product, that is invoiced.
initiationFeeProduct Id Id of the product invoiced for establishing the account.
takeover Boolean True if account is a takeover from another provider (type DSL only).
takeoverCustomer String Id of customer at provider the takeover is from (type DSL only).
orderDate Date Date the account was ordered.
startDate Date When state is ORDERED, the requested start date, otherwise the date the account will go/went live.
terminationDate Date If state is CANCELLED, the date the account will terminate.
requestedTerminationDate Date If state is CANCELLED, the date the customer wants the account to be terminated.
commitmentExpireDate Date The earliest date on which the account may be terminated.
invoicedUntil Date The date the account has been invoiced until.
installCallNumber String Number that technician will call 30 minutes before arriving to install the service.
installCallName String Name of person technician will call 30 minutes before arriving to install the service.
installTime String Time of day installation will be performed: 7_30_TO_16, 7_30_TO_12, 12_TO_16.
provider Object
provider.name String Name of the subcontractor providing the circuit (ADMIN only).
provider.orderId String Subcontractors order id (ADMIN only).
provider.invoicedUntil Date The date until when the provider has invoiced TCX for the account (ADMIN only).
provider.ipAddresses Number Number of IP addresses ordered for the account (ADMIN only).
fiber Object
fiber.initiationCost Number Installation cost (type FIBER only).
fiber.initiationWholesale Number Reseller installation price (type FIBER only).
fiber.initiationCustomer Number Customer installation price (type FIBER only).
fiber.monthlyCost Number Monthly fee cost (type FIBER only).
fiber.monthlyWholesale Number Monthly fee reseller (type FIBER only).
fiber.monthlyCustomer Number Monthly fee customer (type FIBER only).
changeRequest Object
changeRequest.state String State of change request: NONE, REQUESTED, ORDERED.
changeRequest.product Id New product/speed customer wishes to change to.
changeRequest.by Id Id of employee who requested the change and who will be notified.
changeRequest.date Date The date the change will happen.
changeRequest.feeProduct Id Id of product for change fee.
changeRequest.monthlyCost Number New monthly fee cost (type FIBER only).
changeRequest.monthlyWholesale Number New monthly fee reseller (type FIBER only).
changeRequest.monthlyCustomer Number New monthly fee customer (type FIBER only).
net Object
net.ipAddress String Assigned IP address.
net.subnet String Assigned subnet mask.
net.gateway String Assigned default gateway.
net.lanNet String If an additional network is assigned, this is the first IP address in the range.
net.lanSubnet String If an additional network is assigned, this is the subnet mask of the range.
net.failover Boolean True if this line has 3G/4G failover.
net.failoverNumber String Phone number of failover SIM, if net.failover is true.
net.up Boolean True if the accounts ipAddress is online/pingable.
notes String Note about the service (RESELLER/ADMIN only).
documents Array List of id's of documents related to the account.
custom Object Optional custom data that 3rd parties may append, max. 4Kb.
notify Array
notify._id Id Id of employee to notify when the account goes online/offline.
notify.email Boolean True to notify via e-mail.
notify.sms Boolean True to notify via SMS.

Note that properties holding no value may be omitted from the object.

Example

{
  _id: '12345678901234567890AAAA',
  type: 'FIBER',
  state: 'ACTIVE',
  customer: '12345678901234567890BBBB',
  orderedBy: '12345678901234567890FEDE',
  address: '12345678901234567890CCCC',
  circuit: 'HB123456',
  takeoverCustomer: null,
  provider: {
    name: 'TDC',
    orderId: '56326R47723',
    invoicedUntil: '2016-04-01T00:00:00Z',
    ipAddresses: 4
  },
  product: '12345678901234567890DDDD',
  fiber: {
    installCost: 800.00,
    installWholesale: 900.00,
    installPrice: 1000.00,
    monthlyCost: 1500.00,
    monthlyWholesale: 1600.00,
    monthlyPrice: 1700.00,
  },
  orderDate: '2016-01-01T00:00:00Z',
  startDate: '2016-01-14T00:00:00Z',
  terminationDate: null,
  requestedTerminationDate: null,
  commitmentExpireDate: '2016-06-14T00:00:00Z',
  invoicedUntil: '2016-03-01T00:00:00Z',
  installCallNumber: '71919999',
  installCallName: 'Donald Duck',
  changeRequest: {
    state: 'REQUESTED',
    product: '12345678901234567890AABB',
    by: '12345678901234567890EEEE',
    date: '2016-02-01T00:00:00Z',
    feeProduct: '12345678901234567890AACC',
    monthlyCost: 2300.00,
    monthlyWholesale: 2400.00,
    monthlyPrice: 2500.00
  },
  net: {
    ipAddress: '77.66.100.123',
    subnet: '255.255.255.128',
    gateway: '77.66.100.1',
    lanNet: '77.66.100.128',
    lanSubnet: '255.255.255.240',
    failover: true,
    failoverNumber: '+4571919930',
    up: true
  },
  notes: 'Very important customer',
  search: 'vallensbækvej 20a 3 th 2605 brøndby HB123456 464356236 81808888 per 77.66.100.123 77.66.100.1 77.66.100.128 very important customer',
  documents: [ '12345678901234567890FFFF' ],
  custom: null,
  notify: [
    {
      _id: '12345678901234567890FEDE',
      email: true,
      sms: false
    },
    {
      ...
    }
  }
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 not_found Account not found
404 address Address not found
404 customer Customer not found
404 internetAccount Internet account not found
409 id The old and new customer IDs are the same
409 parentReseller The customers do not have the same parentReseller
500 internal_error <Unspecified>