v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB

Invoice

Mark invoice as sent

Marks an invoice as sent by a chosen send type.

put/Invoice/{invoiceId}/sendBy

Path parameters

invoiceIdinteger required

ID of invoice to mark as sent

Request body

sendType'VPR' | 'VP' | 'VM' | 'VPDF' required

Specifies the way in which the invoice was sent to the customer.<br> Accepts 'VPR' (print), 'VP' (postal), 'VM' (mail) and 'VPDF' (downloaded pfd).

sendDraftboolean required

To create a draft of an invoice for internal use. This operation will not alter the status of the invoice or create bookings for reports.

Response

Successful operation - Returns changed invoice log entry

idstring

The invoice id

objectNamestring

The invoice object name

invoiceNumberstring

The invoice number

createstring date-time

Date of invoice creation

updatestring date-time

Date of last invoice update

invoiceDatestring

The invoice date.

headerstring

Normally consist of prefix plus the invoice number

headTextstring

Certain html tags can be used here to format your text

footTextstring

Certain html tags can be used here to format your text

timeToPaystring

The time the customer has to pay the invoice in days

discountTimestring

If a value other than zero is used for the discount attribute, you need to specify the amount of days for which the discount is granted.

discountstring

If you want to give a discount, define the percentage here. Otherwise provide zero as value

payDatestring date-time

Needs to be timestamp or dd.mm.yyyy

deliveryDatestring date-time

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

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

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

smallSettlementboolean

Defines if the client uses the small settlement scheme. If yes, the invoice 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%'

dunningLevelstring

Defines how many reminders have already been sent for the invoice. Starts with 1 (Payment reminder) and should be incremented by one every time another reminder is sent.

taxType'default' | 'eu' | 'noteu' | 'custom'

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

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

The date the invoice was sent to the customer

invoiceType'RE' | 'WKR' | 'SR' | 'MA' | 'TR' | 'AR' | 'ER'

Type of the invoice. For more information on the different types, check <a href='#tag/Invoice/Types-and-status-of-invoices'>this</a> section

accountIntervallstring

The interval in which recurring invoices are due as ISO-8601 duration.<br> Necessary attribute for all recurring invoices.

accountNextInvoicestring

Timestamp when the next invoice will be generated by this recurring invoice.

reminderTotalstring

Total reminder amount

reminderDebitstring

Debit of the reminder

reminderDeadlinestring date-time

Deadline of the reminder as timestamp

reminderChargestring

The additional reminder charge

addressstring

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

currencystring

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

sumNetstring

Net sum of the invoice

sumTaxstring

Tax sum of the invoice

sumGrossstring

Gross sum of the invoice

sumDiscountsstring

Sum of all discounts in the invoice

sumNetForeignCurrencystring

Net sum of the invoice in the foreign currency

sumTaxForeignCurrencystring

Tax sum of the invoice in the foreign currency

sumGrossForeignCurrencystring

Gross sum of the invoice in the foreign currency

sumDiscountsForeignCurrencystring

Discounts sum of the invoice in the foreign currency

sumNetAccountingstring

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

sumTaxAccountingstring

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

sumGrossAccountingstring

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

paidAmountnumber float

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

customerInternalNotestring

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 invoice. Otherwise gross amount

enshrinedstring date-time

Enshrined invoices cannot be changed. Can only be set via Invoice/{invoiceId}/enshrine. This operation cannot be undone.

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

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

deliveryDateUntilstring

If the delivery date should be a time range, another timestamp can be provided in this attribute * to define a range from timestamp used in deliveryDate attribute to the timestamp used here.

datevConnectOnlineobject

Internal attribute

sendPaymentReceivedNotificationDatestring

Internal attribute

Example response

{
  "id": "1",
  "objectName": "Invoice",
  "invoiceNumber": "RE-1000",
  "contact": {
    "id": "1",
    "objectName": "Contact"
  },
  "create": "2024-04-08T00:00:00+02:00",
  "update": "2024-04-08T00:00:00+02:00",
  "sevClient": {
    "id": "1",
    "objectName": "SevClient"
  },
  "invoiceDate": "2024-04-08T00:00:00+02:00",
  "header": "My RE-1000",
  "headText": "header information",
  "footText": "footer information",
  "timeToPay": "10",
  "discountTime": "0",
  "discount": "0",
  "addressCountry": {
    "id": "1",
    "objectName": "StaticCountry"
  },
  "payDate": "2024-04-08T00:00:00+02:00",
  "createUser": {
    "id": "1",
    "objectName": "SevUser"
  },
  "deliveryDate": "2024-04-08T00:00:00+02:00",
  "status": "100",
  "contactPerson": {
    "id": "1",
    "objectName": "SevUser"
  },
  "taxRate": "0",
  "taxText": "Umsatzsteuer 19%",
  "dunningLevel": "0",
  "taxType": "default",
  "paymentMethod": {
    "id": "1",
    "objectName": "PaymentMethod"
  },
  "costCentre": {
    "id": "1",
    "objectName": "CostCentre"
  },
  "sendDate": "2024-04-08T00:00:00+02:00",
  "origin": {
    "id": "1"
  },
  "invoiceType": "RE",
  "accountIntervall": "2022-03-14",
  "accountNextInvoice": "1647259198",
  "reminderTotal": "0",
  "reminderDebit": "0",
  "reminderDeadline": "01.01.2020",
  "reminderCharge": "0",
  "taxSet": {
    "id": "1",
    "objectName": "TaxSet"
  },
  "address": "name\nstreet\npostCode city",
  "currency": "EUR",
  "sumNet": "100",
  "sumTax": "19",
  "sumGross": "119",
  "sumDiscounts": "0",
  "sumNetForeignCurrency": "0",
  "sumTaxForeignCurrency": "0",
  "sumGrossForeignCurrency": "0",
  "sumDiscountsForeignCurrency": "0",
  "sumNetAccounting": "0",
  "sumTaxAccounting": "0",
  "sumGrossAccounting": "0",
  "enshrined": "2024-04-08T00:00:00+02:00",
  "deliveryDateUntil": "2024-04-08T00:00:00+02:00",
  "sendPaymentReceivedNotificationDate": "0"
}