[April 2025] Sunsetting of deprecated API operations in Billing API v2
With our production deployment on May 6th, the following deprecated API operations will be removed from our Billing API v2. These operations are no longer supported, or a designated replacement is available as stated below.
| Sunsetted API operation | Replacement |
|---|---|
Add item to closing invoicePOST/ orders/{orderIdent}/depositInvoice/purchaseItem | (none, see migration guide for purchase items below) |
Generate closing invoicePOST/orders/{orderIdent}/prepareInvoice | (none) |
Create closing invoicePOST/contracts/{contractId}/prepareInvoice | (none) |
Reissue invoicePOST/invoices/{invoiceIdent}/actions/reissue | Reissue documentPOST/documents/{documentIdent}/actions/reissue |
Cancel orderPATCH/orders | Cancel orderPOST/orders/{orderIdent}/actions/cancel |
Cancel contractPATCH/contracts/{contractId}/cancel | Cancel contractsPOST/contracts/actions/cancel |
Terminate contract by identPOST/contracts/{contractIdent}/terminateContract | Terminate contractPOST/contracts/{contractIdent}/actions/terminate |
Terminate contract by idPOST/contracts/{contractId}/terminateContractId | Terminate contractPOST/contracts/{contractIdent}/actions/terminate |
[March 2023] Migration required from Purchase Items to Line Items
With the addition of the "self billing" feature we decided to deprecate the purchase items and instead use more generically named line items.
These line items are categorized by a type to determine if they are relevant to a sales or self billing context. Additionally, we took this opportunity to also rename several other fields to be more in tune with our general API guidelines, you can see all changes below:
Purchase Items are still fully usable. We still suggest migration as soon as possible, with the latest sunsetting date of April 2024, when we will consider removing those endpoints completely.
Field name changes
| Purchase Item | Line Item | Comment |
|---|---|---|
| n/a | type | determines if the item is related to a sale, which would be equivalent the purchase items, or if it is a self-billing item |
| itemGroup | group | |
| debitCreditDetails | debitCreditIndicator | removed the object structure and only using an enum datatype |
| purchaseItemType | category | |
| itemOrigin | n/a | |
| durationValue | n/a | |
| durationType | n/a | |
| purchaseItemExtra | preTaxExtras | |
| purchasePostTaxExtras | postTaxExtras | |
| serviceItemType | n/a |
API changes
All previous /purchaseItem/ endpoints now have an equivalent /lineItems/ endpoint in our API. All purchaseItem endpoints have been deprecated.