v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

CreditNote

Update an existing creditNote

Update a creditNote

put/CreditNote/{creditNoteId}

Path parameters

creditNoteIdinteger required

ID of creditNote to update

Request body

idinteger

The creditNote id

objectNamestring

The creditNote object name

createstring date-time

Date of creditNote creation

updatestring date-time

Date of last creditNote update

creditNoteNumberstring nullable

The creditNote number

creditNoteDatestring date-time

Needs to be provided as timestamp or dd.mm.yyyy

status'100' | '200' | '750' | '1000'

Please have a look in <a href='#tag/CreditNote/Status-of-credit-notes'>status of credit note</a> to see what the different status codes mean

headerstring nullable

Normally consist of prefix plus the creditNote number

headTextstring nullable

Certain html tags can be used here to format your text

footTextstring nullable

Certain html tags can be used here to format your text

deliveryDatestring date-time

Timestamp. This can also be a date range if you also use the attribute deliveryDateUntil

smallSettlementboolean nullable

Defines if the client uses the small settlement scheme. If yes, the creditNote must not contain any vat

taxRatenumber float nullable

This is not used anymore. Use the taxRate of the individual positions instead.

taxTextstring nullable

A common tax text would be 'Umsatzsteuer 19%'

taxTypestring nullable

Use this in sevdesk-Update 1.0 (instead of taxRule).

Tax type of the creditNote. There are four tax types:

default - Umsatzsteuer ausweisen
eu - Steuerfreie innergemeinschaftliche Lieferung (Europäische Union)
noteu - Steuerschuldnerschaft des Leistungsempfängers (außerhalb EU, z. B. Schweiz)
custom - Using custom tax set
ss - Not subject to VAT according to §19 1 UStG Tax rates are heavily connected to the tax type used.

sendDatestring date-time nullable

The date the creditNote was sent to the customer

addressstring nullable

Complete address of the recipient including name, street, city, zip and country.<br> Line breaks can be used and will be displayed on the invoice pdf.

currencystring nullable

Currency used in the creditNote. Needs to be currency code according to ISO-4217

sumNetnumber float

Net sum of the creditNote

sumTaxnumber float

Tax sum of the creditNote

sumGrossnumber float

Gross sum of the creditNote

sumDiscountsnumber float

Sum of all discounts in the creditNote

sumNetForeignCurrencynumber float

Net sum of the creditNote in the foreign currency

sumTaxForeignCurrencynumber float

Tax sum of the creditNote in the foreign currency

sumGrossForeignCurrencynumber float

Gross sum of the creditNote in the foreign currency

sumDiscountsForeignCurrencynumber float

Discounts sum of the creditNote in the foreign currency

customerInternalNotestring nullable

Internal note of the customer. Contains data entered into field 'Referenz/Bestellnummer'

showNetboolean

If true, the net amount of each position will be shown on the creditNote. Otherwise gross amount

sendType'VPR' | 'VPDF' | 'VM' | 'VP' nullable

Type which was used to send the creditNote. IMPORTANT: Please refer to the creditNote section of the * API-Overview to understand how this attribute can be used before using it!

Example request

{
  "create": "2023-04-18T15:45:38+02:00",
  "update": "2023-04-18T15:45:38+02:00",
  "creditNoteNumber": "GU-1000",
  "contact": {
    "objectName": "Contact"
  },
  "creditNoteDate": "01.01.2020",
  "status": "100",
  "header": "My GU-1000",
  "addressCountry": {
    "id": 1,
    "objectName": "StaticCountry"
  },
  "createUser": {
    "objectName": "SevUser"
  },
  "sevClient": {
    "objectName": "SevClient"
  },
  "deliveryDate": "2023-04-18T15:45:38+02:00",
  "contactPerson": {
    "objectName": "SevUser"
  },
  "taxSet": {
    "objectName": "TaxSet"
  },
  "taxText": "Umsatzsteuer 19%",
  "taxType": "default",
  "sendDate": "01.01.2020",
  "currency": "EUR"
}

Response

Successful operation - Returns changed creditNote resource

idstring

The creditNote id

objectNamestring

The creditNote object name

createstring date-time

Date of creditNote creation

updatestring date-time

Date of last creditNote update

creditNoteNumberstring nullable

The creditNote number

creditNoteDatestring date-time

The credit note date

status'100' | '200' | '750' | '1000'

Please have a look in <a href='#tag/CreditNote/Status-of-credit-notes'>status of credit note</a> to see what the different status codes mean

headerstring nullable

Normally consist of prefix plus the creditNote number

headTextstring nullable

Certain html tags can be used here to format your text

footTextstring nullable

Certain html tags can be used here to format your text

deliveryDatestring date-time

Timestamp. This can also be a date range if you also use the attribute deliveryDateUntil

smallSettlementboolean nullable

Defines if the client uses the small settlement scheme. If yes, the creditNote must not contain any vat

taxRatestring nullable

This is not used anymore. Use the taxRate of the individual positions instead.

taxTextstring nullable

A common tax text would be 'Umsatzsteuer 19%'

taxTypestring nullable

Use this in sevdesk-Update 1.0 (instead of taxRule).

Tax type of the creditNote. There are four tax types:

default - Umsatzsteuer ausweisen
eu - Steuerfreie innergemeinschaftliche Lieferung (Europäische Union)
noteu - Steuerschuldnerschaft des Leistungsempfängers (außerhalb EU, z. B. Schweiz)
custom - Using custom tax set
ss - Not subject to VAT according to §19 1 UStG Tax rates are heavily connected to the tax type used.

sendDatestring date-time nullable

The date the creditNote was sent to the customer

addressstring nullable

Complete address of the recipient including name, street, city, zip and country.<br> Line breaks can be used and will be displayed on the invoice pdf.

currencystring nullable

Currency used in the creditNote. Needs to be currency code according to ISO-4217

sumNetstring

Net sum of the creditNote

sumTaxstring

Tax sum of the creditNote

sumGrossstring

Gross sum of the creditNote

sumDiscountsstring

Sum of all discounts in the creditNote

sumNetForeignCurrencystring

Net sum of the creditNote in the foreign currency

sumTaxForeignCurrencystring

Tax sum of the creditNote in the foreign currency

sumGrossForeignCurrencystring

Gross sum of the creditNote in the foreign currency

sumDiscountsForeignCurrencystring

Discounts sum of the creditNote in the foreign currency

customerInternalNotestring nullable

Internal note of the customer. Contains data entered into field 'Referenz/Bestellnummer'

showNetboolean

If true, the net amount of each position will be shown on the creditNote. Otherwise gross amount

sendType'VPR' | 'VPDF' | 'VM' | 'VP' nullable

Type which was used to send the creditNote. IMPORTANT: Please refer to the creditNote section of the * API-Overview to understand how this attribute can be used before using it!

Example response

{
  "id": "1",
  "objectName": "CreditNote",
  "create": "2023-04-18T15:45:38+02:00",
  "update": "2023-04-18T15:45:38+02:00",
  "creditNoteNumber": "GU-1000",
  "contact": {
    "id": "1",
    "objectName": "Contact"
  },
  "creditNoteDate": "2023-04-18T15:45:38+02:00",
  "status": "100",
  "header": "My GU-1000",
  "addressCountry": {
    "id": "1",
    "objectName": "StaticCountry"
  },
  "createUser": {
    "id": "1",
    "objectName": "SevUser"
  },
  "sevClient": {
    "id": "1",
    "objectName": "SevClient"
  },
  "deliveryDate": "2023-04-18T15:45:38+02:00",
  "contactPerson": {
    "id": "1",
    "objectName": "SevUser"
  },
  "taxRate": "0",
  "taxSet": {
    "id": "1",
    "objectName": "TaxSet"
  },
  "taxText": "Umsatzsteuer 19%",
  "taxType": "default",
  "sendDate": "2023-04-18T15:45:38+02:00",
  "currency": "EUR",
  "sumNet": "0",
  "sumTax": "0",
  "sumGross": "0",
  "sumDiscounts": "0",
  "sumNetForeignCurrency": "0",
  "sumTaxForeignCurrency": "0",
  "sumGrossForeignCurrency": "0",
  "sumDiscountsForeignCurrency": "0"
}