Return the BaseItem of the Contract with the given ID

GET/v2/contracts/{contractId}/base-items

API version

Request method

GET

Operation ID

contract-get-base-item-of-contract

Request

contractIdstringrequired
The uuid of the Contract from which the BaseItem is to be issued.

Responses

Format

application/json

Description

The BaseItem of the Contract.

activationDatestring (date-time)
aggregateReferenceobject
- aggregatestringrequired
- domainstringrequired
- idstringrequired
articlesarray of objectrequired
- Array[
  - *object
    - amountinteger (≥ 1)required
    - articleTemplateIdstringrequired
    - descriptionstring
    - idstringrequired
    - namestringrequired
    - unitPriceobjectrequired
      - currency"EUR"required
      - valueintegerrequired
        The value of the price in the smallest currency unit (e.g. cents)
  ]
contractPeriodnumber (≥ 0)required
descriptionstringrequired
freeTrialDaysnumber
groupByProjectIdstring (uuid)
invoiceStopstring (date-time)
If this attribute is set, the contract item will currently only be invoiced until this date.
invoicingPeriodnumber
isActivatedbooleanrequired
isBaseItembooleanrequired
isInFreeTrialboolean
isInclusiveboolean
itemIdstring (uuid)required
nextPossibleDowngradeDatestring (date-time)
If this attribute is not set, termination is not allowed.
nextPossibleTerminationDatestring (date-time)
If this attribute is not set, a tariff change is not allowed.
nextPossibleUpgradeDatestring (date-time)
If this attribute is not set, a tariff change is not allowed.
orderDatestring (date-time)
orderIdstring (uuid)
replacedByItemstring (uuid)
tariffChangeobject
- isForcedboolean
- newArticlesarray of objectrequired
  - Array[
    - *object
      - amountinteger (≥ 1)required
      - articleTemplateIdstringrequired
      - descriptionstring
      - idstringrequired
      - namestringrequired
      - unitPriceobjectrequired
        currency"EUR"required
        valueintegerrequired
        The value of the price in the smallest currency unit (e.g. cents)
    ]
- scheduledAtDatestring (date-time)required
- scheduledByUserIdstring
- targetDatestring (date-time)required
terminationobject
- cancellationForbiddenboolean
  Indicates whether the User is allowed to cancel the Termination.
- explanationstring
- reasonstring
- scheduledAtDatestring (date-time)required
- scheduledByUserIdstring
- targetDatestring (date-time)required
totalPriceobjectrequired
- currency"EUR"required
- valueintegerrequired
  The value of the price in the smallest currency unit (e.g. cents)

Content-Type: application/json

{
  "activationDate": "1985-10-26T01:21:00.000Z",
  "aggregateReference": {
    "aggregate": "project",
    "domain": "project",
    "id": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56"
  },
  "articles": [
    {
      "amount": 1,
      "articleTemplateId": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
      "description": "Musterbeschreibung",
      "id": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
      "name": "Musterartikel",
      "unitPrice": {
        "currency": "EUR",
        "value": 100
      }
    }
  ],
  "contractPeriod": 1,
  "description": "Space-Server: \"Mein Space-Server\"",
  "freeTrialDays": 10,
  "groupByProjectId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "invoiceStop": "1985-10-26T01:21:00.000Z",
  "invoicingPeriod": 1,
  "isActivated": true,
  "isBaseItem": true,
  "isInFreeTrial": true,
  "isInclusive": true,
  "itemId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "nextPossibleDowngradeDate": "1985-10-26T01:21:00.000Z",
  "nextPossibleTerminationDate": "1985-10-26T01:21:00.000Z",
  "nextPossibleUpgradeDate": "1985-10-26T01:21:00.000Z",
  "orderDate": "1985-10-26T01:21:00.000Z",
  "orderId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "replacedByItem": "f0f86186-0a5a-45b2-aa33-502777496347",
  "tariffChange": {
    "isForced": true,
    "newArticles": [
      {
        "amount": 1,
        "articleTemplateId": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
        "description": "Musterbeschreibung",
        "id": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
        "name": "Musterartikel",
        "unitPrice": {
          "currency": "EUR",
          "value": 100
        }
      }
    ],
    "scheduledAtDate": "1985-10-26T01:21:00.000Z",
    "scheduledByUserId": "string",
    "targetDate": "1985-10-26T01:21:00.000Z"
  },
  "termination": {
    "cancellationForbidden": true,
    "explanation": "Not needed anymore",
    "reason": "Not needed anymore",
    "scheduledAtDate": "1985-10-26T01:21:00.000Z",
    "scheduledByUserId": "string",
    "targetDate": "1985-10-26T01:21:00.000Z"
  },
  "totalPrice": {
    "currency": "EUR",
    "value": 100
  }
}

{
  "properties": {
    "activationDate": {
      "format": "date-time",
      "type": "string"
    },
    "aggregateReference": {
      "properties": {
        "aggregate": {
          "example": "project",
          "type": "string"
        },
        "domain": {
          "example": "project",
          "type": "string"
        },
        "id": {
          "example": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
          "type": "string"
        }
      },
      "required": [
        "id",
        "domain",
        "aggregate"
      ],
      "type": "object"
    },
    "articles": {
      "items": {
        "properties": {
          "amount": {
            "example": 1,
            "minimum": 1,
            "type": "integer"
          },
          "articleTemplateId": {
            "example": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
            "type": "string"
          },
          "description": {
            "example": "Musterbeschreibung",
            "type": "string"
          },
          "id": {
            "example": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
            "type": "string"
          },
          "name": {
            "example": "Musterartikel",
            "type": "string"
          },
          "unitPrice": {
            "properties": {
              "currency": {
                "enum": [
                  "EUR"
                ],
                "type": "string"
              },
              "value": {
                "description": "The value of the price in the smallest currency unit (e.g. cents)",
                "example": 100,
                "type": "integer"
              }
            },
            "required": [
              "value",
              "currency"
            ],
            "type": "object"
          }
        },
        "required": [
          "id",
          "name",
          "articleTemplateId",
          "amount",
          "unitPrice"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "contractPeriod": {
      "example": 1,
      "minimum": 0,
      "type": "number"
    },
    "description": {
      "example": "Space-Server: \"Mein Space-Server\"",
      "type": "string"
    },
    "freeTrialDays": {
      "example": 10,
      "type": "number"
    },
    "groupByProjectId": {
      "format": "uuid",
      "type": "string"
    },
    "invoiceStop": {
      "description": "If this attribute is set, the contract item will currently only be invoiced until this date.",
      "format": "date-time",
      "type": "string"
    },
    "invoicingPeriod": {
      "example": 1,
      "type": "number"
    },
    "isActivated": {
      "type": "boolean"
    },
    "isBaseItem": {
      "type": "boolean"
    },
    "isInFreeTrial": {
      "type": "boolean"
    },
    "isInclusive": {
      "type": "boolean"
    },
    "itemId": {
      "format": "uuid",
      "type": "string"
    },
    "nextPossibleDowngradeDate": {
      "description": "If this attribute is not set, termination is not allowed.",
      "format": "date-time",
      "type": "string"
    },
    "nextPossibleTerminationDate": {
      "description": "If this attribute is not set, a tariff change is not allowed.",
      "format": "date-time",
      "type": "string"
    },
    "nextPossibleUpgradeDate": {
      "description": "If this attribute is not set, a tariff change is not allowed.",
      "format": "date-time",
      "type": "string"
    },
    "orderDate": {
      "format": "date-time",
      "type": "string"
    },
    "orderId": {
      "format": "uuid",
      "type": "string"
    },
    "replacedByItem": {
      "format": "uuid",
      "type": "string"
    },
    "tariffChange": {
      "properties": {
        "isForced": {
          "type": "boolean"
        },
        "newArticles": {
          "items": {
            "properties": {
              "amount": {
                "example": 1,
                "minimum": 1,
                "type": "integer"
              },
              "articleTemplateId": {
                "example": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
                "type": "string"
              },
              "description": {
                "example": "Musterbeschreibung",
                "type": "string"
              },
              "id": {
                "example": "a1b8f0e9-904f-4716-a1c0-81ccf5342a56",
                "type": "string"
              },
              "name": {
                "example": "Musterartikel",
                "type": "string"
              },
              "unitPrice": {
                "properties": {
                  "currency": {
                    "enum": [
                      "EUR"
                    ],
                    "type": "string"
                  },
                  "value": {
                    "description": "The value of the price in the smallest currency unit (e.g. cents)",
                    "example": 100,
                    "type": "integer"
                  }
                },
                "required": [
                  "value",
                  "currency"
                ],
                "type": "object"
              }
            },
            "required": [
              "id",
              "name",
              "articleTemplateId",
              "amount",
              "unitPrice"
            ],
            "type": "object"
          },
          "type": "array"
        },
        "scheduledAtDate": {
          "format": "date-time",
          "type": "string"
        },
        "scheduledByUserId": {
          "type": "string"
        },
        "targetDate": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "scheduledAtDate",
        "targetDate",
        "newArticles"
      ],
      "type": "object"
    },
    "termination": {
      "properties": {
        "cancellationForbidden": {
          "description": "Indicates whether the User is allowed to cancel the Termination.",
          "type": "boolean"
        },
        "explanation": {
          "example": "Not needed anymore",
          "type": "string"
        },
        "reason": {
          "example": "Not needed anymore",
          "type": "string"
        },
        "scheduledAtDate": {
          "format": "date-time",
          "type": "string"
        },
        "scheduledByUserId": {
          "type": "string"
        },
        "targetDate": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "scheduledAtDate",
        "targetDate"
      ],
      "type": "object"
    },
    "totalPrice": {
      "properties": {
        "currency": {
          "enum": [
            "EUR"
          ],
          "type": "string"
        },
        "value": {
          "description": "The value of the price in the smallest currency unit (e.g. cents)",
          "example": 100,
          "type": "integer"
        }
      },
      "required": [
        "value",
        "currency"
      ],
      "type": "object"
    }
  },
  "required": [
    "itemId",
    "isActivated",
    "contractPeriod",
    "articles",
    "totalPrice",
    "description",
    "isBaseItem"
  ],
  "type": "object"
}

Format

application/json

Description

Validation Error caused by invalid input data in the request

type"ValidationError"required
messagestring
validationErrorsarray of objectrequired
- Array[
  - *object
    - messagestringrequired
      The standard error message
    - pathstringrequired
      The path to the part of the data that was validated. JavaScript property access notation (e.g., ".prop[1].subProp") is used.
    - typestringrequired
      ajv validation error type (e.g. "format", "required", "type") or own validation error types
    - contextobject
      The object with the additional information about the error that can be used to create custom error messages. Keys depend on the type that failed validation (e.g. "missingProperty" for type "required")
      - *string
  ]

Content-Type: application/json

{
  "type": "ValidationError",
  "message": "Validation failed",
  "validationErrors": [
    {
      "message": "should be string",
      "path": ".address.street",
      "type": "format",
      "context": {
        "format": "email"
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "type",
    "validationErrors"
  ],
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "ValidationError"
      ]
    },
    "message": {
      "type": "string",
      "example": "Validation failed"
    },
    "validationErrors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message",
          "path",
          "type"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "The standard error message",
            "example": "should be string"
          },
          "path": {
            "type": "string",
            "description": "The path to the part of the data that was validated. JavaScript property access notation (e.g., \".prop[1].subProp\") is used.\n",
            "example": ".address.street"
          },
          "type": {
            "type": "string",
            "description": "ajv validation error type (e.g. \"format\", \"required\", \"type\") or own validation error types",
            "example": "format"
          },
          "context": {
            "type": "object",
            "example": {
              "format": "email"
            },
            "description": "The object with the additional information about the error that can be used to create custom error messages. Keys depend on the\ntype that failed validation (e.g. \"missingProperty\" for type \"required\")\n",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Format

application/json

Description

An unexpected Error that occurred while handling the request

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Format

application/json

Description

The requested resource was not found

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Format

application/json

Description

Your request ran into a rate limit. You have to wait until rate limit expires

messagestring
typestring

Content-Type: application/json

{
  "message": "too many requests",
  "type": "RateLimitError"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "too many requests"
    },
    "type": {
      "type": "string",
      "example": "RateLimitError"
    }
  }
}

Format

application/json

Description

An unexpected Error that occurred while handling the request

messagestringrequired
typestringrequired

Content-Type: application/json

{
  "message": "Something went wrong",
  "type": "InternalServerError"
}

{
  "type": "object",
  "required": [
    "type",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "example": "Something went wrong"
    },
    "type": {
      "type": "string",
      "example": "InternalServerError"
    }
  }
}

Usage examples

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/contracts/string/base-items

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.getBaseItemOfContract({
  "contractId": "string"
});

assertStatus(response, 200);
  

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\GetBaseItemOfContract\GetBaseItemOfContractRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetBaseItemOfContractRequest(
  contractId: "string"
));
$response = $client->contract()->getBaseItemOfContract($request);

var_dump($response->getBody();
  

Return the BaseItem of the Contract with the given ID

Request​

Path parametersrequired

Responses​

OK200

Bad Request400

Forbidden403

Not Found404

Too Many Requests429

default

Usage examples​

On this page

Request

Responses

Usage examples