Accounts

Get account information

Returns all the info about a single account given by accountId.

GET /orgs/{orgId}/accounts/{accountId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364 \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	successful operation	AccountInfo
400	Bad Request	Invalid request body	ErrorMessage
404	Not Found	Resource not found	ErrorMessage
405	Method Not Allowed	Method not allowed	None

200 - instance of AccountInfo

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31


{
  "id": 214748364,
  "customer_id": 214748364,
  "account_number": "MM-5338507",
  "work_order_id": "FOO_XYZ",
  "work_orders": [
    {
      "work_order_id": "FOO_XYZ",
      "work_order_type": {
        "id": 1,
        "value": "ALTA"
      },
      "status": {
        "id": 32,
        "value": "PENDIENTE CREAR OT"
      },
      "created_date": "2019-12-09T09:58:34Z"
    }
  ],
  "activation_date": "2019-12-09T09:58:34Z",
  "billing_type": {
    "id": 1,
    "value": "POSPAGO"
  },
  "status": {
    "id": 3,
    "value": "ACTIVO"
  },
  "path": "string",
  "filename": "string"
}

Name	Type	Required	Description
id	integer(int64)	false	id de la cuenta
customer_id	integer(int64)	false	id del cliente
account_number	string	false	numero de contrato
work_order_id	string	false	work order identifier. DEPRECATED, this info is in work_orders list
work_orders	[WorkOrder]	false	list of ot associated to a package
activation_date	string(date-time)	false	account activation date
billing_type	BillingType	false	none
status	AccountStatus	false	none
path	string	false	none
filename	string	false	none

Get tax value

Return tax value by accountId

GET /orgs/{orgId}/accounts/{accountId}/tax

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier
include_historical_changes	query	boolean	false	true when you want to include historical changes
historical_changes_start_date	query	string(date-time)	false	start date that you want query historical changes with format yyyy-mm-ddThh:MM:ssZ
historical_changes_end_date	query	string(date-time)	false	end date that you want query historical changes with format yyyy-mm-ddThh:MM:ssZ

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/tax?include_historical_changes='true'&historical_changes_start_date='1970-01-01T00:00:00Z'&historical_changes_end_date='1970-01-01T00:00:00Z' \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	array of compatible bundles	TaxAccountInfo
400	Bad Request	Invalid request body	ErrorMessage
404	Not Found	Resource not found	ErrorMessage
405	Method Not Allowed	Method not allowed	None

200 - instance of TaxAccountInfo

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "id": 0,
  "tax_value": 21,
  "tax_terminal_value": 21,
  "state_id": 28,
  "description": "IVA",
  "start_date": "1970-01-01T00:00:00Z",
  "historical_changes": [
    {
      "tax_value": 21,
      "tax_terminal_value": 21,
      "state_id": 28,
      "description": "IVA",
      "start_date": "1970-01-01T00:00:00Z",
      "end_date": "1970-01-01T00:00:00Z"
    }
  ]
}

Name	Type	Required	Description
id	integer(int64)	true	account id
tax_value	integer(int32)	true	value tax
tax_terminal_value	integer(int32)	false	value terminal tax
state_id	integer(int32)	true	ID of the state
description	string	false	description of the type tax (IVA, IGIC, etc..)
start_date	string(date-time)	false	Date when the customer moved into the current state
historical_changes	[TaxAccountInfoHistoricalChange]	false	none

Get Account Contracts

Get account contracts

GET /orgs/{orgId}/accounts/{accountId}/contracts

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	organization name
accountId	path	integer(int64)	true	account identifier
signature_config	query	string	true	Signature config
account_bundle_id	query	number(int64)	false	‘none’
subscription_id	query	number(int64)	false	‘none’
subscription_terminal_id	query	number(int64)	false	‘none’
iccid	query	string	false	‘none’

Enumerated Values

Property	Values
signature_config	one of [CONVERGENTE, SOLOMOVIL, TV, TERMINAL, SIM_REPLACEMENT, CHANGE_ADDRESS, BUNDLE_MIGRATION, CHANGE_TECHNOLOGY, UNFINANCED_TERMINAL, FINANCED_TERMINAL, BUNDLE_ADDLINE, CHANGE_OWNER]

Request example

1
2
3
4
5



curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/contracts?signature_config='CONVERGENTE'&account_bundle_id='0'&subscription_id='0'&subscription_terminal_id='0'&iccid='string'?signature_config=CONVERGENTE \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code	Meaning	Description	Schema
200	OK	Successful operation	GetAccountContractsResponse
404	Not Found	Resource not found	ErrorMessage