Changing the status for invoices and credit notes

- 2 minutes read - 400 words

It will no longer be possible to change the status of invoices and credit notes manually. Instead, the respective endpoints must be used.

Status Quo:

  1. Invoice:
    1. It is possible to create an invoice with a status other than “Draft” (100) via /api/v1/Invoice/Factory/saveInvoice
    2. It is possible to reset or elevate the status of an invoice e.g. to “Open” (200) or “Paid” (1000) via /api/v1/Invoice/Factory/saveInvoice or /api/v1/Invoice/{invoiceId}/changeStatus
  2. Credit note:
    1. It is possible to create a credit note with a status other than “Draft” (100) via /api/v1/CreditNote/Factory/saveCreditNote
    2. It is possible to reset or elevate the status of a credit note e.g. to “Open” (200) or “Paid” (1000) via /api/v1/CreditNote/Factory/saveCreditNote or /api/v1/CreditNote/{creditNoteId}/changeStatus

Future:
  1. Invoice:
    1. Invoices must be created with the status “Draft” (100) or in case of recurring invoices ("invoiceType": "WKR") “Deactivated” (50) or “Draft” (100)
  2. Elevating the status must be done via our existing endpoints:
    1. POST /api/v1/Invoice/{invoiceId}/sendViaEmail
    2. PUT /api/v1/Invoice/{invoiceId}/sendBy
    3. PUT /api/v1/Invoice/{invoiceId}/bookAmount
  3. Resetting the status must be done via our new endpoints:
    1. PUT /api/v1/Invoice/{invoiceId}/resetToDraft (will be available in production on 16 April 2024 with release 4.176)
    2. PUT /api/v1/Invoice/{invoiceId}/resetToOpen (will be available in production on 16 April 2024 with release 4.176)
  4. Credit note:
    1. Credit notes must be created with the status “Draft” (100)
  5. Elevating the status must be done via our existing endpoints:
    1. POST /api/v1/CreditNote/{creditNoteId}/sendViaEmail
    2. PUT /api/v1/CreditNote/{creditNoteId}/sendBy
    3. PUT /api/v1/CreditNote/{creditNoteId}/bookAmount
  6. Resetting the status must be done via our new endpoints:
    1. PUT /api/v1/CreditNote/{creditNoteId}/resetToDraft (will be available in production on 16 April 2024 with release 4.176)
    2. PUT /api/v1/CreditNote/{creditNoteId}/resetToOpen (will be available in production on 16 April 2024 with release 4.176)
Affected endpoint:
  • POST /api/v1/Invoice/Factory/saveInvoice
  • POST /api/v1/Invoice/ and PUT /api/v1/Invoice (These endpoints are not official and should not be used, as they will be removed at some point)
  • /api/v1/Invoice/{invoiceId}/changeStatus (will be removed)
  • POST /api/v1/Invoice/{invoiceId} and PUT /api/v1/Invoice/{invoiceId} (These endpoints are not official and should not be used, as they will be removed at some point)
  • POST /api/v1/CreditNote/Factory/saveCreditNote
  • POST /api/v1/CreditNote/ and PUT /api/v1/CreditNote (These endpoints are not official and should not be used, as they will be removed at some point)
  • /api/v1/CreditNote/{creditNoteId}/changeStatus (will be removed)
  • POST /api/v1/CreditNote/{creditNoteId} and PUT /api/v1/CreditNote/{creditNoteId} (These endpoints are not official and should not be used, as they will be removed at some point)

Release:

  • The new endpoints will be released on 16 April 2024 (4.176)
  • Release of the breaking changes for users with sevDesk system version 1.0: June, 25th 2024 (4.182)
  • Release of the breaking changes for users with sevDesk-Update 2.0: May, 29th 2024 (4.180)