get-entity-invoice-explainer
dci get-entity-invoice-explainer billingProfileId invoiceNumber
Returns invoiced cost changes for an invoice owned by the specified billing profile in the authenticated tenant.
Responses
200 (application/json)
Billing explainer returned.
{
"allOf": [
{
"type": "object",
"required": [
"summary",
"service",
"account"
],
"properties": {
"summary": {
"type": "object",
"additionalProperties": false,
"required": [
"aws",
"doit",
"awsWithoutDoit"
],
"properties": {
"aws": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
},
"doit": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
},
"awsWithoutDoit": {
"type": "object",
"additionalProperties": false,
"required": [
"serviceCharges",
"discounts",
"tax",
"supportCharges",
"credits",
"savings",
"otherCharges",
"refunds",
"total"
],
"properties": {
"serviceCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"discounts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"tax": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"supportCharges": {
"type": "object",
"additionalProperties": false,
"required": [
"cost",
"details"
],
"properties": {
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"details": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"projectId",
"serviceDescription",
"description",
"cost",
"baseCost"
],
"properties": {
"projectId": {
"type": "string"
},
"serviceDescription": {
"type": "string"
},
"description": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
},
"baseCost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
},
"credits": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"savings": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"otherCharges": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"refunds": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"costType",
"cost"
],
"properties": {
"costType": {
"type": "string"
},
"cost": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
},
"total": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
},
"service": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"doit",
"aws"
],
"properties": {
"doit": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
},
"aws": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
},
"account": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false,
"required": [
"doit",
"aws"
],
"properties": {
"doit": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
},
"aws": {
"type": "object",
"additionalProperties": {
"description": "Monetary value represented as a decimal string and an ISO 4217 currency code.",
"type": "object",
"additionalProperties": false,
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"type": "string",
"pattern": "^-?(0|[1-9][0-9]*)(\\.[0-9]+)?$",
"minLength": 1,
"maxLength": 30,
"description": "Decimal amount serialized at the currency's minor-unit precision.",
"example": "19.99"
},
"currency": {
"type": "string",
"pattern": "^[A-Z]{3}$",
"minLength": 3,
"maxLength": 3,
"description": "ISO 4217 three-letter uppercase currency code.",
"example": "USD"
}
},
"example": {
"amount": "19.99",
"currency": "USD"
}
}
}
}
}
}
}
},
{
"type": "object",
"required": [
"customerId",
"billingProfileId",
"invoiceNumber",
"invoiceMonth"
],
"properties": {
"customerId": {
"type": "string"
},
"billingProfileId": {
"type": "string"
},
"invoiceNumber": {
"type": "string"
},
"invoiceMonth": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
}
}
}
]
}
400 (application/problem+json)
Syntactically malformed request, missing required parameter, or unsupported parameter value.
{
"type": "object",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"code",
"retryable"
],
"additionalProperties": true,
"description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"example": "https://developer.doit.com/errors/not_found"
},
"title": {
"type": "string",
"example": "Resource not found"
},
"status": {
"type": "integer",
"example": 404
},
"detail": {
"type": "string",
"example": "customer not found"
},
"instance": {
"type": "string",
"format": "uri",
"example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"code": {
"type": "string",
"pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
"example": "not_found"
},
"retryable": {
"type": "boolean",
"example": false
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"issue"
],
"properties": {
"issue": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"field": {
"type": "string"
}
},
"additionalProperties": true
}
},
"docsUrl": {
"type": "string",
"format": "uri",
"nullable": true
}
}
}
401 (application/problem+json)
Missing or invalid credentials.
{
"type": "object",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"code",
"retryable"
],
"additionalProperties": true,
"description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"example": "https://developer.doit.com/errors/not_found"
},
"title": {
"type": "string",
"example": "Resource not found"
},
"status": {
"type": "integer",
"example": 404
},
"detail": {
"type": "string",
"example": "customer not found"
},
"instance": {
"type": "string",
"format": "uri",
"example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"code": {
"type": "string",
"pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
"example": "not_found"
},
"retryable": {
"type": "boolean",
"example": false
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"issue"
],
"properties": {
"issue": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"field": {
"type": "string"
}
},
"additionalProperties": true
}
},
"docsUrl": {
"type": "string",
"format": "uri",
"nullable": true
}
}
}
403 (application/problem+json)
Authenticated but not authorised to access the requested resource.
{
"type": "object",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"code",
"retryable"
],
"additionalProperties": true,
"description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"example": "https://developer.doit.com/errors/not_found"
},
"title": {
"type": "string",
"example": "Resource not found"
},
"status": {
"type": "integer",
"example": 404
},
"detail": {
"type": "string",
"example": "customer not found"
},
"instance": {
"type": "string",
"format": "uri",
"example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"code": {
"type": "string",
"pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
"example": "not_found"
},
"retryable": {
"type": "boolean",
"example": false
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"issue"
],
"properties": {
"issue": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"field": {
"type": "string"
}
},
"additionalProperties": true
}
},
"docsUrl": {
"type": "string",
"format": "uri",
"nullable": true
}
}
}
404 (application/problem+json)
The requested resource does not exist.
{
"type": "object",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"code",
"retryable"
],
"additionalProperties": true,
"description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"example": "https://developer.doit.com/errors/not_found"
},
"title": {
"type": "string",
"example": "Resource not found"
},
"status": {
"type": "integer",
"example": 404
},
"detail": {
"type": "string",
"example": "customer not found"
},
"instance": {
"type": "string",
"format": "uri",
"example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"code": {
"type": "string",
"pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
"example": "not_found"
},
"retryable": {
"type": "boolean",
"example": false
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"issue"
],
"properties": {
"issue": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"field": {
"type": "string"
}
},
"additionalProperties": true
}
},
"docsUrl": {
"type": "string",
"format": "uri",
"nullable": true
}
}
}
500 (application/problem+json)
Unexpected server error.
{
"type": "object",
"required": [
"type",
"title",
"status",
"detail",
"instance",
"code",
"retryable"
],
"additionalProperties": true,
"description": "RFC 9457 Problem Details — standard DoiT error envelope for all non-2xx responses.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"example": "https://developer.doit.com/errors/not_found"
},
"title": {
"type": "string",
"example": "Resource not found"
},
"status": {
"type": "integer",
"example": 404
},
"detail": {
"type": "string",
"example": "customer not found"
},
"instance": {
"type": "string",
"format": "uri",
"example": "https://api.doit.com/requests/req_01HX9P2KQVJ8Z3M4T5N6V7W8Y9"
},
"code": {
"type": "string",
"pattern": "^([a-z][a-z0-9_]*|[a-z][a-z0-9]*(?:-[a-z0-9]+)*\\.[a-z][a-z0-9_]*)$",
"example": "not_found"
},
"retryable": {
"type": "boolean",
"example": false
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"issue"
],
"properties": {
"issue": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"field": {
"type": "string"
}
},
"additionalProperties": true
}
},
"docsUrl": {
"type": "string",
"format": "uri",
"nullable": true
}
}
}
Aliases: getentityinvoiceexplainer