API Overview Resources Schemas

Schemas

BillingInfoDto

1
2
3
4


{
  "language": "es",
  "invoice_cycle_start_day": 22
}

Name	Type	Required	Description
language	string	true	Default language for the tenant. This follows IETF language tag, which combine sub-tags from other standards such as ISO 639, ISO 15924, ISO 3166-1 and UN M.49
invoice_cycle_start_day	integer	true	Day of the month in which the invoice cycle starts

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

AccountAdjustmentResponseDTO

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


{
  "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

CdrResponseDTO

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


{
  "id": "b0b007d221b62fb6443b5be9f8ef66222c2f2798",
  "originNumber": "666554433",
  "destinationNumber": "933008151",
  "initialDate": "2020-09-05T15:14:01Z",
  "usage": 150,
  "unit": "second",
  "costWithoutTaxes": 0,
  "taxPercentage": 21,
  "ratingCaseCategory": "VOICE_NATIONAL",
  "ratingCaseDescription": "NUMERACIÓN ESPECIAL",
  "debitCase": "bonus",
  "debitCatalogId": "4321",
  "debitCustomerId": "46789123",
  "additionalDetails": {
    "smsPremiumInfo": {
      "description": "A very short description",
      "supplierName": "PREMIUM SERVICE S.L."
    }
  }
}

Name	Type	Required	Description
id	string	true	CDR id
originNumber	string	true	CDR origin number
destinationNumber	string	true	CDR destination number (empty for “data” cdr type)
initialDate	string(date-time)	true	CDR date (start date of the call for “voice” cdr type)
usage	integer(int64)	true	Amount of usage of the CDR
unit	string	true	Unit of the CDR usage
costWithoutTaxes	number(double)	true	Cost of the CDR without taxes
taxPercentage	number(double)	true	Tax percentage that should be applied to CDR cost
ratingCaseCategory	string	true	Rating category of the CDR. In Prepaid is empty.
ratingCaseDescription	string	true	Description of the rating case. Empty for prepaid.
debitCase	string	true	Debit category of the CDR (if it was debited from a bonus or from a rating plan). In Prepaid is rating_plan.
debitCatalogId	string	true	Depending on ‘debitCase’ field, catalog rating plan id or catalog bonus id (MMId) used to debit the CDR
debitCustomerId	string	true	Customer bonus id (PackageSubscriptionServiceId) used to debit the CDR (empty if it was debited from rating plan). In Prepaid is empty.
additionalDetails	AdditionalDetailsDTO	false	Additional details of the consumption

Property	Values
unit	one of [byte, sms, second]
ratingCaseCategory	one of [VOICE_NATIONAL, SMS_NATIONAL, DATA_NATIONAL, VOICE_INTERNATIONAL, SMS_INTERNATIONAL, VOICE_ROAMING_UE, SMS_ROAMING_UE, DATA_ROAMING_UE, VOICE_ROAMING, SMS_ROAMING, DATA_ROAMING, VOICE_SPECIAL, SMS_SPECIAL, VOICE_PREMIUM, SMS_PREMIUM, UNKNOWN]
debitCase	one of [bonus, rating_plan]

SubscriptionResponseDTO

 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66


{
  "id": "123456789",
  "msisdn": "666554433",
  "tenant": "masmovil",
  "billingType": 2,
  "monetary": [
    {
      "id": "666554433-123456789-MONETARY_DEFAULT-2020-09-01T00:00:00+02:00",
      "currentValue": -4.7,
      "currentValueWithTaxes": -5.69,
      "unit": "EUR",
      "activationDatetime": "2020-08-31T22:00:00Z",
      "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
      "counters": [
        {
          "type": "internationalVoice",
          "value": -12.3
        }
      ]
    }
  ],
  "bonuses": {
    "data": [
      {
        "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
        "initialValue": 6000,
        "currentValue": 6000,
        "unit": "second",
        "activationDatetime": "2020-08-31T22:00:00Z",
        "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
        "renovationsCount": 3,
        "catalogBonusId": "4321",
        "customerBonusId": "46789123",
        "isShared": false
      }
    ],
    "sms": [
      {
        "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
        "initialValue": 6000,
        "currentValue": 6000,
        "unit": "second",
        "activationDatetime": "2020-08-31T22:00:00Z",
        "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
        "renovationsCount": 3,
        "catalogBonusId": "4321",
        "customerBonusId": "46789123",
        "isShared": false
      }
    ],
    "voice": [
      {
        "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
        "initialValue": 6000,
        "currentValue": 6000,
        "unit": "second",
        "activationDatetime": "2020-08-31T22:00:00Z",
        "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
        "renovationsCount": 3,
        "catalogBonusId": "4321",
        "customerBonusId": "46789123",
        "isShared": false
      }
    ]
  }
}

Name	Type	Required	Description
id	string	true	Subscription id
msisdn	string	true	Subscription msisdn
tenant	string	true	Subscription organization
billingType	integer(int64)	true	Subscription type id (prepaid: 1, postpaid: 2, landline: 4)
monetary	[MonetaryBalanceResponseDTO]	true	List of subscription monetary balances
bonuses	BonusBalancesByTypeResponseDTO	true	none

Property	Values
billingType	one of [1, 2, 4]

CdrsByTypeResponseDTO

 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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71


{
  "data": [
    {
      "id": "b0b007d221b62fb6443b5be9f8ef66222c2f2798",
      "originNumber": "666554433",
      "destinationNumber": "933008151",
      "initialDate": "2020-09-05T15:14:01Z",
      "usage": 150,
      "unit": "second",
      "costWithoutTaxes": 0,
      "taxPercentage": 21,
      "ratingCaseCategory": "VOICE_NATIONAL",
      "ratingCaseDescription": "NUMERACIÓN ESPECIAL",
      "debitCase": "bonus",
      "debitCatalogId": "4321",
      "debitCustomerId": "46789123",
      "additionalDetails": {
        "smsPremiumInfo": {
          "description": "A very short description",
          "supplierName": "PREMIUM SERVICE S.L."
        }
      }
    }
  ],
  "sms": [
    {
      "id": "b0b007d221b62fb6443b5be9f8ef66222c2f2798",
      "originNumber": "666554433",
      "destinationNumber": "933008151",
      "initialDate": "2020-09-05T15:14:01Z",
      "usage": 150,
      "unit": "second",
      "costWithoutTaxes": 0,
      "taxPercentage": 21,
      "ratingCaseCategory": "VOICE_NATIONAL",
      "ratingCaseDescription": "NUMERACIÓN ESPECIAL",
      "debitCase": "bonus",
      "debitCatalogId": "4321",
      "debitCustomerId": "46789123",
      "additionalDetails": {
        "smsPremiumInfo": {
          "description": "A very short description",
          "supplierName": "PREMIUM SERVICE S.L."
        }
      }
    }
  ],
  "voice": [
    {
      "id": "b0b007d221b62fb6443b5be9f8ef66222c2f2798",
      "originNumber": "666554433",
      "destinationNumber": "933008151",
      "initialDate": "2020-09-05T15:14:01Z",
      "usage": 150,
      "unit": "second",
      "costWithoutTaxes": 0,
      "taxPercentage": 21,
      "ratingCaseCategory": "VOICE_NATIONAL",
      "ratingCaseDescription": "NUMERACIÓN ESPECIAL",
      "debitCase": "bonus",
      "debitCatalogId": "4321",
      "debitCustomerId": "46789123",
      "additionalDetails": {
        "smsPremiumInfo": {
          "description": "A very short description",
          "supplierName": "PREMIUM SERVICE S.L."
        }
      }
    }
  ]
}

Name	Type	Required	Description
data	[CdrResponseDTO]	false	List of subscription data cdrs
sms	[CdrResponseDTO]	false	List of subscription sms cdrs
voice	[CdrResponseDTO]	false	List of subscription voice cdrs

MonetaryBalanceResponseDTO

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


{
  "id": "666554433-123456789-MONETARY_DEFAULT-2020-09-01T00:00:00+02:00",
  "currentValue": -4.7,
  "currentValueWithTaxes": -5.69,
  "unit": "EUR",
  "activationDatetime": "2020-08-31T22:00:00Z",
  "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
  "counters": [
    {
      "type": "internationalVoice",
      "value": -12.3
    }
  ]
}

Name	Type	Required	Description
id	string	true	Monetary balance id
currentValue	number(double)	true	Current value of the monetary balance
currentValueWithTaxes	number(double)	true	Current value with taxes of the monetary balance. In Prepaid is 0.
unit	string	true	Unit of the monetary balance value
activationDatetime	string(date-time)	true	Start date of the monetary balance period (UTC). Null date = 0001-01-01T00:00:00Z
expirationDatetime	string(date-time)	true	End date of the monetary balance period (UTC). Null date = 0001-01-01T00:00:00Z
counters	[MonetaryBalanceCountersResponseDTO]	true	List of available counters for that balance

Property	Values
unit	one of [EUR]

MonetaryBalanceCountersResponseDTO

1
2
3
4


{
  "type": "internationalVoice",
  "value": -12.3
}

Name	Type	Required	Description
type	string	true	counter type
value	number(double)	true	current value for that counter in the specified balance

BonusBalancesByTypeResponseDTO

 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
32
33
34
35
36
37
38
39
40
41
42
43
44


{
  "data": [
    {
      "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
      "initialValue": 6000,
      "currentValue": 6000,
      "unit": "second",
      "activationDatetime": "2020-08-31T22:00:00Z",
      "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
      "renovationsCount": 3,
      "catalogBonusId": "4321",
      "customerBonusId": "46789123",
      "isShared": false
    }
  ],
  "sms": [
    {
      "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
      "initialValue": 6000,
      "currentValue": 6000,
      "unit": "second",
      "activationDatetime": "2020-08-31T22:00:00Z",
      "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
      "renovationsCount": 3,
      "catalogBonusId": "4321",
      "customerBonusId": "46789123",
      "isShared": false
    }
  ],
  "voice": [
    {
      "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
      "initialValue": 6000,
      "currentValue": 6000,
      "unit": "second",
      "activationDatetime": "2020-08-31T22:00:00Z",
      "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
      "renovationsCount": 3,
      "catalogBonusId": "4321",
      "customerBonusId": "46789123",
      "isShared": false
    }
  ]
}

Name	Type	Required	Description
data	[BonusBalanceResponseDTO]	true	List of subscription data bonus balances
sms	[BonusBalanceResponseDTO]	true	List of subscription sms bonus balances
voice	[BonusBalanceResponseDTO]	true	List of subscription voice bonus balances

BonusBalanceResponseDTO

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


{
  "id": "666554433-123456789-BONUS_TEMPLATE-100-46789123-2020-09-01T00:00:00+02:00",
  "initialValue": 6000,
  "currentValue": 6000,
  "unit": "second",
  "activationDatetime": "2020-08-31T22:00:00Z",
  "expirationDatetime": "2021-09-30T21:59:59.999999999Z",
  "renovationsCount": 3,
  "catalogBonusId": "4321",
  "customerBonusId": "46789123",
  "isShared": false
}

Name	Type	Required	Description
id	string	true	Bonus balance id
initialValue	number(double)	true	Initial value of the bonus balance
currentValue	number(double)	true	Current value of the bonus balance
unit	string	true	Unit of the bonus balance value
activationDatetime	string(date-time)	true	Start date of the bonus balance period (UTC)
expirationDatetime	string(date-time)	true	End date of the bonus balance period (UTC)
renovationsCount	integer	true	Number of renovations of the bonus
catalogBonusId	string	true	Catalog bonus id of the bonus (MMId)
customerBonusId	string	true	Customer bonus id of the bonus (PackageSubscriptionServiceId)
isShared	boolean	true	Indicates if the bonus balance is shared or not

Property	Values
unit	one of [byte, sms, second]

AdditionalDetailsDTO

1
2
3
4
5
6


{
  "smsPremiumInfo": {
    "description": "A very short description",
    "supplierName": "PREMIUM SERVICE S.L."
  }
}

Name	Type	Required	Description
smsPremiumInfo	SmsPremiumInfoDTO	false	none

SmsPremiumInfoDTO

1
2
3
4


{
  "description": "A very short description",
  "supplierName": "PREMIUM SERVICE S.L."
}

Name	Type	Required	Description
description	string	false	Description of the premium SMS
supplierName	string	false	Name of the supplier

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	false	none

MovementResponseDTO

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


{
  "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

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	false	none

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	false	none

RefundResponseDTO

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


{
  "id": "36d64f0a-71c8-466b-be65-2b0e5adeead5",
  "refund_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",
  "external_refund_unique_id": "987654321",
  "billable": false,
  "description": "February invoice"
}

Name	Type	Required	Description
id	string	true	none
refund_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
external_refund_unique_id	string	true	none
billable	boolean	true	none
description	string	true	none

RefundRequestDTO

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


{
  "refund_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_refund_unique_id": "987654321",
  "billable": false,
  "description": "February invoice"
}

Name	Type	Required	Description
refund_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_refund_unique_id	string	true	none
billable	boolean	true	none
description	string	false	none

RefundNonSubscribableProductsRequestDTO

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


{
  "refund_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
  },
  "external_invoice_id": "123456789",
  "external_refund_unique_id": "987654321",
  "transaction_type_id": "5432167890",
  "description": "February invoice"
}

Name	Type	Required	Description
refund_datetime	string(date-time)	true	none
period_start_datetime	string(date-time)	false	none
period_end_datetime	string(date-time)	false	none
amount	BillableAmountRequestDTO	true	none
external_invoice_id	string	false	none
external_refund_unique_id	string	false	none
transaction_type_id	string	true	none
description	string	false	none

AmountResponseDTO

1
2
3
4
5
6
7
8


{
  "value_with_taxes": 12.1,
  "value_without_taxes": 10,
  "tax": {
    "type": "IVA",
    "percentage": 21
  }
}

Name	Type	Required	Description
value_with_taxes	number(float)	true	none
value_without_taxes	number(float)	true	none
tax	TaxDTO	true	none

AmountRequestDTO

1
2
3
4
5
6
7
8


{
  "value_with_taxes": 12.1,
  "value_without_taxes": 10,
  "tax": {
    "type": "IVA",
    "percentage": 21
  }
}

Name	Type	Required	Description
value_with_taxes	number(float)	false	none
value_without_taxes	number(float)	false	none
tax	TaxDTO	false	none

AdjustmentAmountRequestDTO

1
2
3
4


{
  "value_without_taxes": 10,
  "value_with_taxes": 12.1
}

Name	Type	Required	Description
value_without_taxes	number(float)	false	Amount without taxes. Only one of the two values should be provided.
value_with_taxes	number(float)	false	Amount with taxes. Only one of the two values should be provided.

Name	Type	Required	Description
anonymous	object	false	none

Name	Type	Required	Description
anonymous	object	false	none

BillableAmountRequestDTO

1
2
3


{
  "value_without_taxes": 10
}

Name	Type	Required	Description
value_without_taxes	number(float)	false	none

NonBillableAmountRequestDTO

1
2
3
4
5
6
7


{
  "value_without_taxes": 10,
  "tax": {
    "type": "IVA",
    "percentage": 21
  }
}

Name	Type	Required	Description
value_without_taxes	number(float)	false	none
tax	TaxDTO	false	none

InvoicesResponseDTO

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


{
  "invoices": [
    {
      "invoice_id": "OS220000000001",
      "issue_date": "2022-02-24T13:45:10Z",
      "due_date": "2022-02-24T13:45:10Z",
      "location_tax_type": "IVA",
      "invoice_amounts": {
        "tax_base": 10,
        "non_tax_base": 5,
        "tax_amount": 2.1,
        "total_amount_in_invoice": 17.1,
        "total_amount_out_of_invoice": 4.5,
        "total_amount": 21.6
      }
    }
  ]
}

Name	Type	Required	Description
invoices	[InvoiceResponseDTO]	true	none

InvoiceResponseDTO

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


{
  "invoice_id": "OS220000000001",
  "issue_date": "2022-02-24T13:45:10Z",
  "due_date": "2022-02-24T13:45:10Z",
  "location_tax_type": "IVA",
  "invoice_amounts": {
    "tax_base": 10,
    "non_tax_base": 5,
    "tax_amount": 2.1,
    "total_amount_in_invoice": 17.1,
    "total_amount_out_of_invoice": 4.5,
    "total_amount": 21.6
  }
}

Name	Type	Required	Description
invoice_id	string	true	none
issue_date	string(date-time)	true	Emission date of invoice in RFC3339 format
due_date	string(date-time)	true	Date of charge in RFC3339 format
location_tax_type	LocationTaxTypeDTO	true	none
invoice_amounts	InvoiceAmountsResponseDTO	true	none

InvoiceAmountsResponseDTO

1
2
3
4
5
6
7
8


{
  "tax_base": 10,
  "non_tax_base": 5,
  "tax_amount": 2.1,
  "total_amount_in_invoice": 17.1,
  "total_amount_out_of_invoice": 4.5,
  "total_amount": 21.6
}

Name	Type	Required	Description
tax_base	number(float)	true	Sum of amounts without taxes of all taxed concepts. Includes concepts with generic and exempted taxes.
non_tax_base	number(float)	true	Sum of amounts without taxes of all non-taxed concepts
tax_amount	number(float)	true	Sum of all tax amounts of all concepts (GENERIC + EXEMPTED)
total_amount_in_invoice	number(float)	true	Sum of all amounts with taxes of all taxed and non-taxed concepts (GENERIC + EXEMPTED + NOT_TAXED)
total_amount_out_of_invoice	number(float)	true	Sum of all amounts with taxes of all concepts out of invoice. Taxes do not apply to these concepts.
total_amount	number(float)	true	Sum of total amounts in and out of invoice, including taxes

InvoicePublicLinkResponseDTO

1
2
3


{
  "public_link": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
}

Name	Type	Required	Description
public_link	string	true	none

AccountBillingDetailsResponseDTO

1
2
3
4


{
  "next_billing_date": "2022-02-24T13:45:10Z",
  "billing_status": "ACTIVATED"
}

Name	Type	Required	Description
next_billing_date	string(date-time)	false	Next billing date in RFC3339 format
billing_status	string	true	Billing status of the account.

Property	Values
billing_status	one of [ACTIVATED, DEACTIVATED]

TaxDTO

1
2
3
4


{
  "type": "IVA",
  "percentage": 21
}

Name	Type	Required	Description
type	string	true	none
percentage	number(float)	true	none

Property	Values
type	one of [EXEMPTED, IGIC, IPSI_CEUTA, IPSI_MELILLA, IVA, NOT_APPLY, NOT_TAXED]

LocationTaxDTO

1
2
3
4


{
  "type": "IVA",
  "percentage": 21
}

Name	Type	Required	Description
type	string	true	none
percentage	number(float)	true	none

Property	Values
type	one of [IVA, IGIC, IPSI_CEUTA, IPSI_MELILLA]

LocationTaxTypeDTO

1

"IVA"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [IVA, IGIC, IPSI_CEUTA, IPSI_MELILLA]

MovementTypeDTO

1

"RECURRING_CHARGE"

Name	Type	Required	Description
anonymous	string	false	none

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

OperationTypeDTO

1

"DEBIT"

Name	Type	Required	Description
anonymous	string	false	none

Property	Values
anonymous	one of [CREDIT, DEBIT]

GenericResponseDTO

1
2
3
4
5


{
  "error": "string",
  "message": "string",
  "trace_id": "string"
}

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

GenericCreatedResponseDTO

1
2
3


{
  "id": "8da2b117-ef72-413d-98ce-36d1eb544e44"
}

Name	Type	Required	Description
id	string	false	none