SEsevdesk
Order

Update an existing order

Changed on

Update an order

put/Order/{orderId}

Request

  • Base URL
    https://my.sevdesk.de/api/v1
  • Auth
    API key in header Authorization

Path parameters

orderIdinteger required

ID of order to update

Request body

idinteger

The order id

objectNamestring

The order object name

createstring date-time

Date of order creation

updatestring date-time

Date of last order update

orderNumberstring

The order number

orderDatestring date-time nullable

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

status100 | 200 | 300 | 500 | 750 | 1000 nullable

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

headerstring nullable

Normally consist of prefix plus the order 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

deliveryTermsstring nullable

Delivery terms of the order

paymentTermsstring nullable

Payment terms of the order

versioninteger nullable

Version of the order.<br> Can be used if you have multiple drafts for the same order.<br> Should start with 0

smallSettlementboolean nullable

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

taxRatenumber 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 order. There are four tax types:

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

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

sendDatestring date-time nullable

The date the order 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 order. Needs to be currency code according to ISO-4217

sumNetnumber

Net sum of the order

sumTaxnumber

Tax sum of the order

sumGrossnumber

Gross sum of the order

sumDiscountsnumber

Sum of all discounts in the order

sumNetForeignCurrencynumber

Net sum of the order in the foreign currency

sumTaxForeignCurrencynumber

Tax sum of the order in the foreign currency

sumGrossForeignCurrencynumber

Gross sum of the order in the foreign currency

sumDiscountsForeignCurrencynumber

Discounts sum of the order in the foreign currency

customerInternalNotestring nullable

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

showNetboolean nullable

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

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

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

Example request

{
  "orderNumber": "Offer-1000",
  "contact": {
    "objectName": "Contact"
  },
  "orderDate": "01.01.2020",
  "status": 100,
  "header": "My Offer-1000",
  "contactPerson": {
    "objectName": "SevUser"
  },
  "taxText": "Umsatzsteuer 19%",
  "taxType": "default",
  "orderType": "AN",
  "currency": "EUR"
}

Response

Successful operation - Returns changed order resource

idstring

The order id

objectNamestring

The order object name

createstring date-time

Date of order creation

updatestring date-time

Date of last order update

orderNumberstring

The order number

orderDatestring date-time

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

status'100' | '200' | '300' | '500' | '750' | '1000'

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

headerstring

Normally consist of prefix plus the order 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

deliveryTermsstring nullable

Delivery terms of the order

paymentTermsstring nullable

Payment terms of the order

versionstring

Version of the order.<br> Can be used if you have multiple drafts for the same order.<br> Should start with 0

smallSettlementboolean

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

taxRatestring

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

taxTextstring

A common tax text would be 'Umsatzsteuer 19%'

taxTypestring

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

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

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

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

sendDatestring date-time nullable

The date the order 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

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

sumNetstring

Net sum of the order

sumTaxstring

Tax sum of the order

sumGrossstring

Gross sum of the order

sumDiscountsstring

Sum of all discounts in the order

sumNetForeignCurrencystring

Net sum of the order in the foreign currency

sumTaxForeignCurrencystring

Tax sum of the order in the foreign currency

sumGrossForeignCurrencystring

Gross sum of the order in the foreign currency

sumDiscountsForeignCurrencystring

Discounts sum of the order 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 order. Otherwise gross amount

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

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

Example response

{
  "id": "0",
  "objectName": "Order",
  "orderNumber": "Offer-1000",
  "contact": {
    "id": "0",
    "objectName": "Contact"
  },
  "orderDate": "01.01.2020",
  "status": "100",
  "header": "My Offer-1000",
  "createUser": {
    "id": "0",
    "objectName": "SevUser"
  },
  "sevClient": {
    "id": "0",
    "objectName": "SevClient"
  },
  "origin": {
    "id": "0",
    "objectName": "Order"
  },
  "version": "0",
  "contactPerson": {
    "id": "0",
    "objectName": "SevUser"
  },
  "taxRate": "0",
  "taxSet": {
    "id": "0",
    "objectName": "TaxSet"
  },
  "taxText": "Umsatzsteuer 19%",
  "taxType": "default",
  "orderType": "AN",
  "currency": "EUR"
}

Changes

  • a32cec0feceaRevision changes
    • warning

      added the new 17 enum value to the / response property for the response status

    • warning

      added the new 18 enum value to the / response property for the response status

    • warning

      added the new 19 enum value to the / response property for the response status

    • warning

      added the new 20 enum value to the / response property for the response status

    • warning

      added the new 21 enum value to the / response property for the response status

    • info

      added the new 17 enum value to the request property /

    • info

      added the new 18 enum value to the request property /

    • info

      added the new 19 enum value to the request property /

    • info

      added the new 20 enum value to the request property /

    • info

      added the new 21 enum value to the request property /

  • a12897a73d08Revision changes
    • info

      the endpoint scheme security api_key was added to the API

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status