Billing Operations

Create movement for non subscribable services

POST /{service_type}/{service_id}/billing/movements-non-subscribable-services

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for movement creation
body	body	movementNonSubscribableRequestDTO	true	Contains movement information to be created

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of movementNonSubscribableRequestDTO

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


{
  "type": "RECURRING_CHARGE",
  "movement_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "123456789",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	string	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_movement_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	false	none

Property	Values
type	one of [RECURRING_CHARGE, ONE_TIME_FEE, INSTALLATION_FEE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE, DISCOUNT]

Request 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



curl -X POST https://partners.sta.masstack.com/v3/mobile/612123456/billing/movements-non-subscribable-services \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'type': 'RECURRING_CHARGE',
  'movement_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T23:00:00Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '123456789',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successfully created the operation request, returned the result	movementSuccessResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Update movement for non subscribable services

PUT /{service_type}/{service_id}/billing/movements-non-subscribable-services/{movement_id}

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for movement update
movement_id	path	string	true	Movement to be updated identifier
body	body	movementNonSubscribableRequestDTO	true	Contains movement information to be updated

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of movementNonSubscribableRequestDTO

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


{
  "type": "RECURRING_CHARGE",
  "movement_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "123456789",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	string	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_movement_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	false	none

Property	Values
type	one of [RECURRING_CHARGE, ONE_TIME_FEE, INSTALLATION_FEE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE, DISCOUNT]

Request 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



curl -X PUT https://partners.sta.masstack.com/v3/mobile/612123456/billing/movements-non-subscribable-services/4d9d437f-ef3b-41e7-b474-067b1917cc4e \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'type': 'RECURRING_CHARGE',
  'movement_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T23:00:00Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '123456789',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successfully updated the movement.	movementUpdateResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Delete movement for non subscribable services

DELETE /{service_type}/{service_id}/billing/movements-non-subscribable-services/{movement_id}

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for the movement to be deleted
movement_id	path	string	true	Movement to be updated identifier

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request example

1
2
3
4
5



curl -X DELETE https://partners.sta.masstack.com/v3/mobile/612123456/billing/movements-non-subscribable-services/4d9d437f-ef3b-41e7-b474-067b1917cc4e \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully deleted de movement resource	movementUpdateResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Create refund for non subscribable services

POST /{service_type}/{service_id}/billing/refund-non-subscribable-services

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for refund creation
body	body	refundNonSubscribableRequestDTO	true	Contains refund information to be created

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of refundNonSubscribableRequestDTO

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


{
  "refund_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_refund_unique_id": "123456789",
  "transaction_type_id": "5432167890",
  "movement_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
refund_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_refund_unique_id	string	false	none
transaction_type_id	string	true	none
movement_id	string	true	none
description	string	false	none

Request 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



curl -X POST https://partners.sta.masstack.com/v3/mobile/612123456/billing/refund-non-subscribable-services \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'refund_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T23:00:00Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_refund_unique_id': '123456789',
  'transaction_type_id': '5432167890',
  'movement_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successfully accepted the operation request, returned the result	refundSuccessResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Create movement for services

POST /{service_type}/{service_id}/billing/movements

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for movement creation
body	body	movementRequestDTO	true	Contains movement information to be created

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of movementRequestDTO

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


{
  "type": "RECURRING_CHARGE",
  "movement_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "123456789",
  "billable": false,
  "concept_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	string	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_movement_unique_id	string	true	none
billable	boolean	true	none
concept_id	string	false	none
description	string	false	none

Property	Values
type	one of [RECURRING_CHARGE, ONE_TIME_FEE, INSTALLATION_FEE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE, DISCOUNT]

Request 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



curl -X POST https://partners.sta.masstack.com/v3/mobile/612123456/billing/movements \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'type': 'RECURRING_CHARGE',
  'movement_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T23:00:00Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '123456789',
  'billable': false,
  'concept_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successfully created the operation request, returned the result	movementSuccessResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Delete movement for services

DELETE /{service_type}/{service_id}/billing/movements/{movement_id}

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for the movement to be deleted
movement_id	path	string	true	Movement to be updated identifier

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request example

1
2
3
4
5



curl -X DELETE https://partners.sta.masstack.com/v3/mobile/612123456/billing/movements/4d9d437f-ef3b-41e7-b474-067b1917cc4e \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08"

Responses

Code	Meaning	Description	Schema
200	OK	Successfully deleted de movement resource	movementUpdateResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO

Create refund for services

POST /{service_type}/{service_id}/billing/refunds

Parameters

Name	In	Type	Required	Description
Request-Correlation-Id	header	string(uuid)	false	Correlation Id for tracing (unique identifier)
service_type	path	serviceTypeDTO	true	Service type indicator
service_id	path	string	true	Service identifier for refund creation
body	body	refundRequestDTO	true	Contains refund information to be created

Enumerated Values

Property	Values
service_type	one of [multisim, security, tv, datasharing, mobile, applewatch, deviceinsurance]

Request body - instance of refundRequestDTO

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


{
  "refund_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T23:00:00Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_refund_unique_id": "123456789",
  "billable": false,
  "movement_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
refund_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	Mandatory just if period_end_datetime is set
period_end_datetime	string(date-time)	false	Mandatory just if period_start_datetime is set
amount	amountDTO	true	none
external_invoice_id	string	false	this field is informative. We are not doing any further processing apart from persisting it
external_refund_unique_id	string	true	none
billable	boolean	true	none
movement_id	string	true	none
description	string	false	none

Request 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



curl -X POST https://partners.sta.masstack.com/v3/mobile/612123456/billing/refunds \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Request-Correlation-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \
 --data-raw "{
  'refund_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T23:00:00Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_refund_unique_id': '123456789',
  'billable': false,
  'movement_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successfully accepted the operation request, returned the result	refundSuccessResponseDTO
400	Bad Request	Bad Request	genericErrorResponseDTO
401	Unauthorized	Unauthorized request	genericErrorResponseDTO
403	Forbidden	Forbidden resource	genericErrorResponseDTO
404	Not Found	Not found	genericErrorResponseDTO
406	Not Acceptable	Not Acceptable	genericErrorResponseDTO
500	Internal Server Error	Internal Server Error	genericErrorResponseDTO