Sign in

v1

latestOpenAPI 3.0.02026-07-1315476656.4 KB
CreditNote

Send credit note via email

This endpoint sends the specified credit note to a customer via email.<br> This will automatically mark the credit note as sent.<br> Please note, that in production an credit note is not allowed to be changed after this happened!

post/CreditNote/{creditNoteId}/sendViaEmail

Path parameters

creditNoteIdinteger required

ID of credit note to be sent via email

Request body

toEmailstring required

The recipient of the email.

subjectstring required

The subject of the email.

textstring required

The text of the email. Can contain html.

copyboolean

Should a copy of this email be sent to you?

additionalAttachmentsstring

Additional attachments to the mail. String of IDs of existing documents in your * sevdesk account separated by ','

ccEmailstring

String of mail addresses to be put as cc separated by ','

bccEmailstring

String of mail addresses to be put as bcc separated by ','

Response

Created - Returns created mail object

Example response

{
  "objects": [
    {
      "id": 1,
      "objectName": "Email",
      "create": "2023-04-18T15:45:38+02:00",
      "update": "2023-04-18T15:45:38+02:00",
      "object": {
        "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"
      },
      "from": "example@mail.com",
      "to": "example2@mail.com",
      "subject": "subject",
      "text": "example",
      "sevClient": {
        "id": 1,
        "objectName": "SevClient"
      }
    }
  ]
}