v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

Voucher

Update an existing voucher

Update a draft voucher using this method if you want to change simple values like the description. Complex changes like adding a position should use /Voucher/Factory/saveVoucher. You can not change the status using this endpoint.

put/Voucher/{voucherId}

Path parameters

voucherIdinteger required

ID of voucher to update

Request body

voucherDatestring date-time nullable

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

supplierNamestring nullable

The supplier name. The value you provide here will determine what supplier name is shown for the voucher in case you did not provide a supplier.

descriptionstring nullable

The description of the voucher. Essentially the voucher number.

payDatestring date-time nullable

Needs to be timestamp or dd.mm.yyyy

status50 | 100 | 1000

Not supported in sevdesk-Update 2.0. Please have a look in <a href='#tag/Voucher/Types-and-status-of-vouchers'>status of vouchers</a> to see what the different status codes mean

paidAmountnumber float nullable

Amount which has already been paid for this voucher by the customer

taxTypestring

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

Tax type of the voucher. 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.

creditDebit'C' | 'D'

Defines if your voucher is a credit (C) or debit (D)

voucherType'VOU' | 'RV'

Type of the voucher. For more information on the different types, check <a href='#tag/Voucher/Types-and-status-of-vouchers'>this</a>

currencystring nullable

specifies which currency the voucher should have. Attention: If the currency differs from the default currency stored in the account, then either the "propertyForeignCurrencyDeadline" or "propertyExchangeRate" parameter must be specified. If both parameters are specified, then the "propertyForeignCurrencyDeadline" parameter is preferred

propertyForeignCurrencyDeadlinestring date-time nullable

Defines the exchange rate day and and then the exchange rate is set from sevdesk. Needs to be provided as timestamp or dd.mm.yyyy

propertyExchangeRatenumber float nullable

Defines the exchange rate

paymentDeadlinestring date-time nullable

Payment deadline of the voucher.

deliveryDatestring date-time

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

deliveryDateUntilstring date-time nullable

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

Example request

{
  "voucherDate": "01.01.2022",
  "supplierName": "John Snow",
  "description": "Voucher-1000",
  "payDate": "01.01.2022",
  "status": 50,
  "taxType": "default",
  "creditDebit": "C",
  "voucherType": "VOU",
  "currency": "EUR",
  "propertyForeignCurrencyDeadline": "01.01.2022",
  "propertyExchangeRate": 0.8912,
  "taxSet": {
    "objectName": "TaxSet"
  },
  "paymentDeadline": "01.01.2022",
  "deliveryDate": "01.01.2022",
  "deliveryDateUntil": "22.02.2022",
  "document": {
    "objectName": "Document"
  },
  "costCentre": {
    "objectName": "CostCentre"
  }
}

Response

Successful operation - Returns changed voucher resource

idstring

The voucher id

objectNamestring

The voucher object name

mapAllboolean

createstring date-time

Date of voucher creation

updatestring date-time

Date of last voucher update

voucherDatestring date-time nullable

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

supplierNamestring nullable

The supplier name. The value you provide here will determine what supplier name is shown for the voucher in case you did not provide a supplier.

descriptionstring nullable

The description of the voucher. Essentially the voucher number.

payDatestring date-time nullable

Needs to be timestamp or dd.mm.yyyy

status'50' | '100' | '1000' nullable

Please have a look in <a href='#tag/Voucher/Types-and-status-of-vouchers'>status of vouchers</a> to see what the different status codes mean

sumNetstring

Net sum of the voucher

sumTaxstring

Tax sum of the voucher

sumGrossstring

Gross sum of the voucher

sumNetAccountingstring

Net accounting sum of the voucher. Is usually the same as sumNet

sumTaxAccountingstring

Tax accounting sum of the voucher. Is usually the same as sumTax

sumGrossAccountingstring

Gross accounting sum of the voucher. Is usually the same as sumGross

sumDiscountsstring

Sum of all discounts in the voucher

sumDiscountsForeignCurrencystring

Discounts sum of the voucher in the foreign currency

paidAmountnumber nullable

Amount which has already been paid for this voucher by the customer

taxTypestring nullable

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

Tax type of the voucher. 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.

creditDebit'C' | 'D' nullable

Defines if your voucher is a credit (C) or debit (D)

voucherType'VOU' | 'RV' nullable

Type of the voucher. For more information on the different types, check <a href='#tag/Voucher/Types-and-status-of-vouchers'>this</a>

currencystring nullable

propertyForeignCurrencyDeadlinestring date-time nullable

Defines the exchange rate day and and then the exchange rate is set from sevdesk. Needs to be provided as timestamp or dd.mm.yyyy

propertyExchangeRatestring nullable

Defines the exchange rate

The DateInterval in which recurring vouchers are generated. Necessary attribute for all recurring vouchers.

recurringStartDatestring date-time nullable

The date when the recurring vouchers start being generated. Necessary attribute for all recurring vouchers.

recurringNextVoucherstring date-time nullable

The date when the next voucher should be generated. Necessary attribute for all recurring vouchers.

recurringLastVoucherstring date-time nullable

The date when the last voucher was generated.

recurringEndDatestring date-time nullable

The date when the recurring vouchers end being generated. Necessary attribute for all recurring vouchers.

enshrinedstring date-time

Enshrined vouchers cannot be changed. Can only be set via Voucher/{voucherId}/enshrine. This operation cannot be undone.

paymentDeadlinestring date-time nullable

Payment deadline of the voucher.

deliveryDatestring date-time

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

deliveryDateUntilstring date-time nullable

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

Example response

{
  "id": "0",
  "mapAll": true,
  "create": "01.01.2020",
  "update": "01.01.2020",
  "sevClient": {
    "id": "0",
    "objectName": "SevClient"
  },
  "createUser": {
    "id": "0",
    "objectName": "SevUser"
  },
  "voucherDate": "01.01.2020",
  "supplier": {
    "id": "0",
    "objectName": "Contact"
  },
  "supplierName": "John Snow",
  "description": "Voucher-1000",
  "document": {
    "id": "0",
    "objectName": "Document"
  },
  "payDate": "01.01.2020",
  "status": "50",
  "sumNet": "0",
  "sumTax": "0",
  "sumGross": "0",
  "sumNetAccounting": "0",
  "sumTaxAccounting": "0",
  "sumGrossAccounting": "0",
  "sumDiscounts": "0",
  "sumDiscountsForeignCurrency": "0",
  "taxType": "default",
  "creditDebit": "C",
  "costCentre": {
    "id": "0"
  },
  "voucherType": "VOU",
  "currency": "EUR",
  "propertyForeignCurrencyDeadline": "01.01.2022",
  "propertyExchangeRate": "0.8912",
  "recurringStartDate": "01.01.2020",
  "recurringNextVoucher": "01.02.2020",
  "recurringLastVoucher": "01.01.2021",
  "recurringEndDate": "01.01.2021",
  "enshrined": "2024-04-08T00:00:00+02:00",
  "taxSet": {
    "id": "0",
    "objectName": "TaxSet"
  },
  "paymentDeadline": "01.01.2020",
  "deliveryDate": "01.01.2020",
  "deliveryDateUntil": "01.01.2020"
}