Movements

Get a list of all account adjustments

Retrieve a list of all account adjustments for a given account.

GET /orgs/{orgId}/account/{accountId}/adjustment

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
accountId	path	string	true	Executes the request in the context of the given account

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/account/123456789/adjustment \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Retrieve a list of all account adjustments	[AccountAdjustmentResponseDTO]
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

200 - instance of AccountAdjustmentResponseDTO

Custom schema example

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


[
  {
    "id": "eca565cf-8c87-4be5-a189-0a320f5dd1cd",
    "adjustment_datetime": "2022-02-24T13:45:10Z",
    "period_start_datetime": "2022-01-31T23:00:00Z",
    "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
    "amount": {
      "value_with_taxes": 12.1,
      "value_without_taxes": 10,
      "tax": {
        "type": "IVA",
        "percentage": 21
      }
    },
    "operation_type": "DEBIT",
    "external_adjustment_unique_id": "987654321",
    "transaction_type_id": "5432167890",
    "invoice_cycle_date": "2022-02-28T23:00:00Z",
    "description": "February invoice"
  }
]

Name	Type	Required	Description
id	string	true	none
adjustment_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	true	none
period_end_datetime	string(date-time)	true	none
amount	AmountResponseDTO	true	none
operation_type	OperationTypeDTO	true	none
external_adjustment_unique_id	string	true	none
transaction_type_id	string	true	none
invoice_cycle_date	string(date-time)	true	If the invoice_id field is empty, this field indicates the expected invoice cycle date of the movement. On the other hand, if the invoice_id field is already filled, this field indicates the current invoice cycle date of the movement.
description	string	true	none

Create a new account adjustment

Create a new account adjustment.

POST /orgs/{orgId}/account/{accountId}/adjustment

Parameters

Name	In	Type	Required	Description
body	body	AccountAdjustmentRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
accountId	path	string	true	Executes the request in the context of the given account

Request body - instance of AccountAdjustmentRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "adjustment_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
  "amount": {
    "value_without_taxes": 10,
    "value_with_taxes": 12.1
  },
  "external_adjustment_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
adjustment_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AdjustmentAmountRequestDTO	true	Amount of an adjustment. It can be either value_without_taxes or value_with_taxes, but not both.
external_adjustment_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	none

Request example

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



curl -X POST https://billing.masstack.com/v1/orgs/masmovil/account/123456789/adjustment \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'adjustment_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T22:59:59.999999999Z',
  'amount': {
    'value_without_taxes': 10,
    'value_with_taxes': 12.1
  },
  'external_adjustment_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Resource created	GenericCreatedResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Get a single account adjustment

Retrieve a single account adjustment.

GET /orgs/{orgId}/account/{accountId}/adjustment/{adjustmentId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
accountId	path	string	true	Executes the request in the context of the given account
adjustmentId	path	string	true	Executes the request in the context of the given billing adjustment

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/account/123456789/adjustment/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Retrieve a single account adjustment	AccountAdjustmentResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Update a single account adjustment

Update an existing account adjustment.

PUT /orgs/{orgId}/account/{accountId}/adjustment/{adjustmentId}

Parameters

Name	In	Type	Required	Description
body	body	AccountAdjustmentRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
accountId	path	string	true	Executes the request in the context of the given account
adjustmentId	path	string	true	Executes the request in the context of the given billing adjustment

Request body - instance of AccountAdjustmentRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "adjustment_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
  "amount": {
    "value_without_taxes": 10,
    "value_with_taxes": 12.1
  },
  "external_adjustment_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
adjustment_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AdjustmentAmountRequestDTO	true	Amount of an adjustment. It can be either value_without_taxes or value_with_taxes, but not both.
external_adjustment_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	none

Request example

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



curl -X PUT https://billing.masstack.com/v1/orgs/masmovil/account/123456789/adjustment/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'adjustment_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T22:59:59.999999999Z',
  'amount': {
    'value_without_taxes': 10,
    'value_with_taxes': 12.1
  },
  'external_adjustment_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Delete a single account adjustment

Delete an existing account adjustment.

DELETE /orgs/{orgId}/account/{accountId}/adjustment/{adjustmentId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
accountId	path	string	true	Executes the request in the context of the given account
adjustmentId	path	string	true	Executes the request in the context of the given billing adjustment

Request example

1
2
3
4
5



curl -X DELETE https://billing.masstack.com/v1/orgs/masmovil/account/123456789/adjustment/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Create a new billing movement of type adjustment

Create a new billing movement of type adjustment.

POST /orgs/{orgId}/subscription/{subscriptionId}/adjustment

Parameters

Name	In	Type	Required	Description
body	body	AdjustmentRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Request body - instance of AdjustmentRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "adjustment_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
  "amount": {
    "value_without_taxes": 10,
    "value_with_taxes": 12.1
  },
  "external_adjustment_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
adjustment_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AdjustmentAmountRequestDTO	true	Amount of an adjustment. It can be either value_without_taxes or value_with_taxes, but not both.
external_adjustment_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	none

Request example

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



curl -X POST https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/adjustment \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'adjustment_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T22:59:59.999999999Z',
  'amount': {
    'value_without_taxes': 10,
    'value_with_taxes': 12.1
  },
  'external_adjustment_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Resource created	GenericCreatedResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Update a single billing movement of type adjustment

Update an existing billing movement of type adjustment. Adjustments can only be updated if they have not been invoiced, that is, if their invoice_id field is empty.

PUT /orgs/{orgId}/subscription/{subscriptionId}/adjustment/{adjustmentId}

Parameters

Name	In	Type	Required	Description
body	body	AdjustmentRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
adjustmentId	path	string	true	Executes the request in the context of the given billing adjustment

Request body - instance of AdjustmentRequestDTO

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


{
  "adjustment_datetime": "2022-02-24T13:45:10Z",
  "period_start_datetime": "2022-01-31T23:00:00Z",
  "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
  "amount": {
    "value_without_taxes": 10,
    "value_with_taxes": 12.1
  },
  "external_adjustment_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
adjustment_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AdjustmentAmountRequestDTO	true	Amount of an adjustment. It can be either value_without_taxes or value_with_taxes, but not both.
external_adjustment_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	none

Request example

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



curl -X PUT https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/adjustment/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'adjustment_datetime': '2022-02-24T13:45:10Z',
  'period_start_datetime': '2022-01-31T23:00:00Z',
  'period_end_datetime': '2022-02-28T22:59:59.999999999Z',
  'amount': {
    'value_without_taxes': 10,
    'value_with_taxes': 12.1
  },
  'external_adjustment_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Name	In	Type	Required	Description
fromDate	query	string(date-time)	false	From datetime used as filter
toDate	query	string(date-time)	false	To datetime used as filter
movementType	query	MovementTypeDTO	false	Movement type used as filter
operationType	query	OperationTypeDTO	false	Operation type used as filter
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Enumerated Values

Property	Values
movementType	one of [ADJUSTMENT, DISCOUNT, INSTALLATION_FEE, ONE_TIME_FEE, RECURRING_CHARGE, SUSPENSION_SERVICE_FEE, UNRETURNED_EQUIPMENT_FEE]
operationType	one of [CREDIT, DEBIT]

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement?fromDate='2021-10-10T22:00:00Z'&toDate='2021-10-20T22:00:00Z'&movementType='RECURRING_CHARGE'&operationType='DEBIT' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Code	Meaning	Description	Schema
200	OK	List of all subscription billing movements	[MovementResponseDTO]
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

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


[
  {
    "id": "8da2b117-ef72-413d-98ce-36d1eb544e44",
    "type": "RECURRING_CHARGE",
    "movement_datetime": "2022-02-24T13:45:10Z",
    "period_start_datetime": "2022-01-31T23:00:00Z",
    "period_end_datetime": "2022-02-28T22:59:59.999999999Z",
    "amount": {
      "value_with_taxes": 12.1,
      "value_without_taxes": 10,
      "tax": {
        "type": "IVA",
        "percentage": 21
      }
    },
    "invoice_id": "987654321",
    "external_invoice_id": "123456789",
    "invoice_cycle_date": "2022-02-28T23:00:00Z",
    "external_movement_unique_id": "987654321",
    "billable": false,
    "transaction_type_id": "100",
    "operation_type": "DEBIT",
    "description": "February invoice"
  }
]

Name	Type	Required	Description
id	string	true	none
type	MovementTypeDTO	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	true	none
period_end_datetime	string(date-time)	true	none
amount	AmountResponseDTO	true	none
invoice_id	string	true	none
external_invoice_id	string	true	none
invoice_cycle_date	string(date-time)	true	If the invoice_id field is empty, this field indicates the expected invoice cycle date of the movement. On the other hand, if the invoice_id field is already filled, this field indicates the current invoice cycle date of the movement.
external_movement_unique_id	string	true	none
billable	boolean	true	none
transaction_type_id	string	true	none
operation_type	OperationTypeDTO	true	none
description	string	true	none

Custom schema example

1
2
3


{
  "error": "subscriptionNotFound"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
trace_id	string	false	none

Custom schema example

1
2
3


{
  "error": "getMovements"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
trace_id	string	false	none

Custom schema example

1
2
3


{
  "error": "getMovements"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
trace_id	string	false	none

Create a new billing movement

Create a new billing movement.

POST /orgs/{orgId}/subscription/{subscriptionId}/movement

Parameters

Name	In	Type	Required	Description
body	body	MovementRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Request body - instance of MovementRequestDTO

 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-28T22:59:59.999999999Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "987654321",
  "billable": false,
  "description": "February invoice"
}

Name	Type	Required	Description
type	MovementTypeDTO	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AmountRequestDTO	true	none
external_invoice_id	string	false	none
external_movement_unique_id	string	true	none
billable	boolean	true	none
description	string	true	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://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --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-28T22:59:59.999999999Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '987654321',
  'billable': false,
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Resource created	GenericCreatedResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Get a single billing movement

Retrieves a single billing movement.

GET /orgs/{orgId}/subscription/{subscriptionId}/movement/{movementId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
movementId	path	string	true	Executes the request in the context of the given billing movement

Request example

1
2
3
4
5



curl -X GET https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Retrieve a billing movement	MovementResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Update a single billing movement

Update an existing billing movement. Movements can only be updated if they have not been invoiced, that is, if their invoice_id field is empty.

PUT /orgs/{orgId}/subscription/{subscriptionId}/movement/{movementId}

Parameters

Name	In	Type	Required	Description
body	body	MovementRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
movementId	path	string	true	Executes the request in the context of the given billing movement

Request body - instance of MovementRequestDTO

 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-28T22:59:59.999999999Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "987654321",
  "billable": false,
  "description": "February invoice"
}

Name	Type	Required	Description
type	MovementTypeDTO	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AmountRequestDTO	true	none
external_invoice_id	string	false	none
external_movement_unique_id	string	true	none
billable	boolean	true	none
description	string	true	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 PUT https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --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-28T22:59:59.999999999Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '987654321',
  'billable': false,
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Delete a single billing movement

Delete an existing billing movement. Movements can only be deleted if they have not been invoiced, that is, if their invoice_id field is empty.

DELETE /orgs/{orgId}/subscription/{subscriptionId}/movement/{movementId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
movementId	path	string	true	Executes the request in the context of the given billing movement

Request example

1
2
3
4
5



curl -X DELETE https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Create a new billing movement (for non subscribable products)

Create a new billing movement (for non subscribable products).

POST /orgs/{orgId}/subscription/{subscriptionId}/movement-non-subscribable-products

Parameters

Name	In	Type	Required	Description
body	body	MovementNonSubscribableProductsRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription

Request body - instance of MovementNonSubscribableProductsRequestDTO

 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-28T22:59:59.999999999Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	MovementTypeDTO	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AmountRequestDTO	true	none
external_invoice_id	string	false	none
external_movement_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	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://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement-non-subscribable-products \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --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-28T22:59:59.999999999Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Resource created	GenericCreatedResponseDTO
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Update a single billing movement (for non subscribable products)

Update an existing billing movement (for non subscribable products). Movements (for non subscribable products) can only be updated if they have not been invoiced, that is, if their invoice_id field is empty.

PUT /orgs/{orgId}/subscription/{subscriptionId}/movement-non-subscribable-products/{movementId}

Parameters

Name	In	Type	Required	Description
body	body	MovementNonSubscribableProductsRequestDTO	true	‘none’
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
movementId	path	string	true	Executes the request in the context of the given billing movement

Request body - instance of MovementNonSubscribableProductsRequestDTO

 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-28T22:59:59.999999999Z",
  "amount": {
    "value_with_taxes": 12.1,
    "value_without_taxes": 10,
    "tax": {
      "type": "IVA",
      "percentage": 21
    }
  },
  "external_invoice_id": "123456789",
  "external_movement_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
type	MovementTypeDTO	true	none
movement_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	AmountRequestDTO	true	none
external_invoice_id	string	false	none
external_movement_unique_id	string	true	none
transaction_type_id	string	true	none
description	string	true	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 PUT https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement-non-subscribable-products/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --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-28T22:59:59.999999999Z',
  'amount': {
    'value_with_taxes': 12.1,
    'value_without_taxes': 10,
    'tax': {
      'type': 'IVA',
      'percentage': 21
    }
  },
  'external_invoice_id': '123456789',
  'external_movement_unique_id': '987654321',
  'transaction_type_id': '5432167890',
  'description': 'February invoice'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Delete a single billing movement (for non subscribable products)

DEPRECATED

Delete an existing billing movement (for non subscribable products). Movements (for non subscribable products) can only be deleted if they have not been invoiced, that is, if their invoice_id field is empty.

DELETE /orgs/{orgId}/subscription/{subscriptionId}/movement-non-subscribable-products/{movementId}

Parameters

Name	In	Type	Required	Description
orgId	path	string	true	Executes the request in the context of the given organization
subscriptionId	path	string	true	Executes the request in the context of the given subscription
movementId	path	string	true	Executes the request in the context of the given billing movement

Request example

1
2
3
4
5



curl -X DELETE https://billing.masstack.com/v1/orgs/masmovil/subscription/123456789/movement-non-subscribable-products/eca565cf-8c87-4be5-a189-0a320f5dd1cd \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
204	No Content	Ok with empty body	None
400	Bad Request	The request could not be processed because it was malformed	GenericResponseDTO
401	Unauthorized	The user is not authorized	GenericResponseDTO
403	Forbidden	The user does not have permission to access that resource	GenericResponseDTO
404	Not Found	The specified resource was not found	GenericResponseDTO
500	Internal Server Error	The request failed to be processed by the server	GenericResponseDTO
502	Bad Gateway	A third party connection is not responding	GenericResponseDTO
504	Gateway Time-out	The request timed out	GenericResponseDTO

Movements

Get a list of all account adjustments

Parameters

Request example

Responses

200 - instance of AccountAdjustmentResponseDTO

Create a new account adjustment

Parameters

Request body - instance of AccountAdjustmentRequestDTO

Request example

Responses

Get a single account adjustment

Parameters

Request example

Responses

Update a single account adjustment

Parameters

Request body - instance of AccountAdjustmentRequestDTO

Request example

Responses

Delete a single account adjustment

Parameters

Request example

Responses

Create a new billing movement of type adjustment

Parameters

Request body - instance of AdjustmentRequestDTO

Request example

Responses

Update a single billing movement of type adjustment

Parameters

Request body - instance of AdjustmentRequestDTO

Request example

Responses

Get a list of all billing movements, related to a subscription

Parameters

Enumerated Values

Request example

Responses

200 - instance of MovementResponseDTO

400 - instance of GenericResponseDTO

500 - instance of GenericResponseDTO

502 - instance of GenericResponseDTO

Create a new billing movement

Parameters

Request body - instance of MovementRequestDTO

Request example

Responses

Get a single billing movement

Parameters

Request example

Responses

Update a single billing movement

Parameters

Request body - instance of MovementRequestDTO

Request example

Responses

Delete a single billing movement

Parameters

Request example

Responses

Create a new billing movement (for non subscribable products)

Parameters

Request body - instance of MovementNonSubscribableProductsRequestDTO

Request example

Responses

Update a single billing movement (for non subscribable products)

Parameters

Request body - instance of MovementNonSubscribableProductsRequestDTO

Request example

Responses

Delete a single billing movement (for non subscribable products)

Parameters

Request example

Responses