Skip to main content

Return the BaseItem of the Contract with the given ID

GET/contracts/{contractId}/base-items/
v2
GET
contract-get-base-item-of-contract

Request​

  • contractIdstring (uuid)
    required

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

    Example:"97cecfa0-2c3c-4272-a510-c775fcaade01"

Responses​

application/json

The BaseItem of the Contract.

  • activationDatestring (date-time)
  • aggregateReferenceobject
    • aggregatestring
      required
    • domainstring
      required
    • idstring
      required
  • articlesarray of object
    required
    • Array[
    • *object
      • amountinteger (≥ 1)
        required
      • articleTemplateIdstring
        required
      • descriptionstring
      • idstring
        required
      • namestring
        required
      • unitPriceobject
        required
        • currency"EUR"
          required
        • valueinteger
          required

          The value of the price in the smallest currency unit (e.g. cents)

      • ]
  • contractPeriodnumber (≥ 0)
    required
  • descriptionstring
    required
  • freeTrialDaysnumber
  • groupByProjectIdstring (uuid)
  • invoiceStopstring (date-time)

    If this attribute is set, the contract item will currently only be invoiced until this date.

  • invoicingPeriodnumber
  • isActivatedboolean
    required
  • isBaseItemboolean
    required
  • 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
    • newArticlesarray of object
      required
      • Array[
      • *object
        • amountinteger (≥ 1)
          required
        • articleTemplateIdstring
          required
        • descriptionstring
        • idstring
          required
        • namestring
          required
        • unitPriceobject
          required
          • currency"EUR"
            required
          • valueinteger
            required

            The value of the price in the smallest currency unit (e.g. cents)

        • ]
  • scheduledAtDatestring (date-time)
    required
  • scheduledByUserIdstring
  • targetDatestring (date-time)
    required
  • terminationobject
    • reasonstring
    • scheduledAtDatestring (date-time)
      required
    • scheduledByUserIdstring
    • targetDatestring (date-time)
      required
  • totalPriceobject
    required
    • currency"EUR"
      required
    • valueinteger
      required

      The value of the price in the smallest currency unit (e.g. cents)

    • Usage examples​

    $ curl \
        --fail \
        --location \
        -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
        https://api.mittwald.de/v2/contracts/f0f86186-0a5a-45b2-aa33-502777496347/base-items