Rated items can be used to transfer invoice items to billwerk that have been named and priced in other systems. The invoice items transferred in this way are taken into account in the next settlement and included in the invoice together with the items generated by billwerk. Use this method to bill products and services for which there is no standard pricing and which are not part of the product catalog in your billwerk account.

Rated items can be passed to billwerk explicitly via POST /Contracts/{contractId}/ratedItems. Alternatively, a rated item can be billed via an order, by adding RatedItems to the cart of the Order. This will result in the rated item being billed immediately after the Order/{id}/commit.

Create Rated item

Sample request

POST /Contracts/{contractId}/ratedItems

{
  "Description": "I'm a RatedItem",
  "Quantity": 1,
  "PricePerUnit": 300,
  "TaxPolicyId": "5b61ba5081b1f012b0f14d21",
  "PeriodStart": "2020-03-04T06:44:24.7711657Z",
  "PeriodEnd": "2020-04-04T06:44:24.7711657Z"
}

The PeriodStart and PeriodEnd mark the beginning and end of the service period posted on the invoice line item created based on this Rated Item.

Sample Response

{
    "Id": "5e663e5d443e55256c60a435",
    "Description": "I'm a RatedItem",
    "Quantity": 1,
    "PricePerUnit": 300,
    "TaxPolicyId": "5b61ba5081b1f012b0f14d21",
    "PeriodStart": "2020-03-04T06:44:24.7710000Z",
    "PeriodEnd": "2020-04-04T06:44:24.7710000Z",
    "TransferredAt": "2020-03-09T13:02:21.0000000Z"
}