Sign in

v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB
CreditNote

Book a credit note

Booking the credit note with a transaction is probably the most important part in the bookkeeping process.<br> There are several ways on correctly booking a credit note, all by using the same endpoint.<br> Conveniently, the booking process is exactly the same as the process for invoices and vouchers.<br> For this reason, you can have a look at it in the <a href='#tag/Invoice/How-to-book-an-invoice'>invoice chapter</a> and all you need to do is to change "Invoice" into "CreditNote" in the URL.

put/CreditNote/{creditNoteId}/bookAmount

Path parameters

creditNoteIdinteger required

ID of credit note to book

Request body

amountnumber required

Amount which should be booked. Can also be a partial amount.

dateinteger required

The booking date. Most likely the current date.

type'FULL_PAYMENT' | 'N' | 'CB' | 'CF' | 'O' | 'OF' | 'MTC' required

Define a type for the booking.<br> The following type abbreviations are available (abbreviation <-> meaning).<br> <ul>

<li>FULL_PAYMENT <-> Normal booking</li><li>N <-> Partial booking (historically used for normal booking)</li> <li>CB <-> Reduced amount due to discount (skonto)</li> <li>CF <-> Reduced/Higher amount due to currency fluctuations (deprecated)</li> <li>O <-> Reduced/Higher amount due to other reasons</li> <li>OF <-> Higher amount due to reminder charges</li> <li>MTC <-> Reduced amount due to the monetary traffic costs</li> </ul>
createFeedboolean

Determines if a feed is created for the booking process.

Example request

{
  "checkAccount": {
    "objectName": "CheckAccount"
  },
  "checkAccountTransaction": {
    "objectName": "CheckAccountTransaction"
  }
}

Response

Successful operation - Returns changed invoice log entry

idstring
objectNamestring
additionalInformationstring
createstring date-time

Date of email creation

fromStatusstring
toStatusstring
ammountPayedstring
bookingDatestring date-time

Example response

{
  "objectName": "CreditNoteLog",
  "create": "2023-04-18T15:45:38+02:00",
  "creditNote": {
    "id": 2,
    "objectName": "CreditNote"
  },
  "bookingDate": "2023-04-18T15:45:38+02:00",
  "sevClient": {
    "id": 1,
    "objectName": "SevClient"
  }
}