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.
billingProfileId— Billing profile identifier shown on the invoice.invoiceNumber— Customer-facing invoice number.
Examples
# Explain the invoiced cost changes behind one invoice.
dci get-entity-invoice-explainer <billing-profile-id> <invoice-number>
# The full breakdown as JSON — accounts, services, and the summary of credits, discounts, refunds, and charges.
dci get-entity-invoice-explainer <billing-profile-id> <invoice-number> --output json
# When your credential can access more than one customer, name the tenant explicitly.
dci get-entity-invoice-explainer <billing-profile-id> <invoice-number> --x-tenant-id <customer-id>
Output
Billing explainer returned.
By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.
| Field | Type | Description |
|---|---|---|
customerId | string | |
billingProfileId | string | |
invoiceNumber | string | |
invoiceMonth | string | |
summary | object | |
summary.aws | object | |
summary.aws.serviceCharges | array of object | |
summary.aws.serviceCharges[].costType | string | |
summary.aws.serviceCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.discounts | array of object | |
summary.aws.discounts[].costType | string | |
summary.aws.discounts[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.tax | array of object | |
summary.aws.tax[].costType | string | |
summary.aws.tax[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.supportCharges | object | |
summary.aws.supportCharges.cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.supportCharges.details | array of object | Nested fields omitted — see the raw JSON schema. |
summary.aws.credits | array of object | |
summary.aws.credits[].costType | string | |
summary.aws.credits[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.savings | array of object | |
summary.aws.savings[].costType | string | |
summary.aws.savings[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.otherCharges | array of object | |
summary.aws.otherCharges[].costType | string | |
summary.aws.otherCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.refunds | array of object | |
summary.aws.refunds[].costType | string | |
summary.aws.refunds[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.aws.total | object | Monetary value represented as a decimal string and an ISO 4217 currency code. |
summary.aws.total.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
summary.aws.total.currency | string | ISO 4217 three-letter uppercase currency code. |
summary.doit | object | |
summary.doit.serviceCharges | array of object | |
summary.doit.serviceCharges[].costType | string | |
summary.doit.serviceCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.discounts | array of object | |
summary.doit.discounts[].costType | string | |
summary.doit.discounts[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.tax | array of object | |
summary.doit.tax[].costType | string | |
summary.doit.tax[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.supportCharges | object | |
summary.doit.supportCharges.cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.supportCharges.details | array of object | Nested fields omitted — see the raw JSON schema. |
summary.doit.credits | array of object | |
summary.doit.credits[].costType | string | |
summary.doit.credits[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.savings | array of object | |
summary.doit.savings[].costType | string | |
summary.doit.savings[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.otherCharges | array of object | |
summary.doit.otherCharges[].costType | string | |
summary.doit.otherCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.refunds | array of object | |
summary.doit.refunds[].costType | string | |
summary.doit.refunds[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.doit.total | object | Monetary value represented as a decimal string and an ISO 4217 currency code. |
summary.doit.total.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
summary.doit.total.currency | string | ISO 4217 three-letter uppercase currency code. |
summary.awsWithoutDoit | object | |
summary.awsWithoutDoit.serviceCharges | array of object | |
summary.awsWithoutDoit.serviceCharges[].costType | string | |
summary.awsWithoutDoit.serviceCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.discounts | array of object | |
summary.awsWithoutDoit.discounts[].costType | string | |
summary.awsWithoutDoit.discounts[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.tax | array of object | |
summary.awsWithoutDoit.tax[].costType | string | |
summary.awsWithoutDoit.tax[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.supportCharges | object | |
summary.awsWithoutDoit.supportCharges.cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.supportCharges.details | array of object | Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.credits | array of object | |
summary.awsWithoutDoit.credits[].costType | string | |
summary.awsWithoutDoit.credits[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.savings | array of object | |
summary.awsWithoutDoit.savings[].costType | string | |
summary.awsWithoutDoit.savings[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.otherCharges | array of object | |
summary.awsWithoutDoit.otherCharges[].costType | string | |
summary.awsWithoutDoit.otherCharges[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.refunds | array of object | |
summary.awsWithoutDoit.refunds[].costType | string | |
summary.awsWithoutDoit.refunds[].cost | object | Monetary value represented as a decimal string and an ISO 4217 currency code. Nested fields omitted — see the raw JSON schema. |
summary.awsWithoutDoit.total | object | Monetary value represented as a decimal string and an ISO 4217 currency code. |
summary.awsWithoutDoit.total.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
summary.awsWithoutDoit.total.currency | string | ISO 4217 three-letter uppercase currency code. |
service | map of object | |
service.*.doit | map of object | |
service.*.doit.*.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
service.*.doit.*.currency | string | ISO 4217 three-letter uppercase currency code. |
service.*.aws | map of object | |
service.*.aws.*.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
service.*.aws.*.currency | string | ISO 4217 three-letter uppercase currency code. |
account | map of object | |
account.*.doit | map of object | |
account.*.doit.*.amount | string | Decimal amount serialized at the currency's minor-unit precision. |
account.*.doit.*.currency | string | ISO 4217 three-letter uppercase currency code. |
注意
The field list above is truncated. Expand the raw JSON schema below for the full structure.
Raw JSON schema
{
"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])$"
}
}
}
]
}
Errors
On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.
HTTP status to exit code mapping
| HTTP status | Exit code | Error code | Meaning |
|---|---|---|---|
| 400 | 30 | VALIDATION_ERROR | The arguments or request body were rejected. Review the command's flags and payload. |
| 401 | 10 | AUTHENTICATION_FAILED | Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY. |
| 403 | 11 | PERMISSION_DENIED | The DoiT user or the active customer context does not have access. |
| 404 | 20 | RESOURCE_NOT_FOUND | The requested resource does not exist. Check the identifier argument. |
| 500 | 40 | API_SERVER_ERROR | The API failed to process the request. Retryable; contact DoiT support if it persists. |
Related
- get-billing-explainer-per-payer — Retrieve a per-payer billing explainer
- get-invoice — Retrieve an invoice
- list-invoices — List invoices
- API reference: GET /billing/v1/billing-profiles/{billingProfileId}/billing-explainers/{invoiceNumber}
Aliases: getentityinvoiceexplainer