PUT
/
invoices
/
{id}
/
resend
curl -X PUT \
 /invoices/{id}/resend \
 --header "Authorization: Bearer <token>"
{
  "id": "00000000-0000-0000-0000-000000000000",
  "customer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "customerNumber": "CUSTOMER-000",
    "timeZone": "Europe/Berlin",
    "firstName": "John",
    "lastName": "Doe",
    "currencyCode": "EUR",
    "companyName": "Acme Inc.",
    "datevId": "123456789",
    "status": "STATUS_ACTIVE"
  },
  "paymentMethod": {
    "id": "<string>",
    "gatewayName": "wallet",
    "type": "sepa_debit",
    "referenceId": "<string>",
    "default": true,
    "status": "active",
    "source": "api",
    "enabled": true,
    "name": "<string>",
    "data": [
      "<string>"
    ],
    "creationDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "sepaMandate": {},
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expMonth": 12,
      "expYear": 2022,
      "cardHolder": "Max Mustermann"
    },
    "sepaDebit": {
      "iban": "DE8937*********3232",
      "bic": "COBADEFFXXX",
      "mandateReference": "MNDT-2021-123456",
      "signingDate": "2021-01-01T00:00:00+00:00"
    },
    "paypal": {
      "email": "max@mustermann.de",
      "billingAgreementId": "I-1J5gqz2eZvKYlo2C2X2X2X2X"
    }
  },
  "referencedInvoice": {},
  "type": "TYPE_INVOICE",
  "currencyCode": "EUR",
  "number": "RE-0000000001",
  "status": "STATUS_DRAFT",
  "creationDate": "2023-11-07T05:31:56Z",
  "finalizationDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "lastReminderDate": "2023-11-07T05:31:56Z",
  "lastSentAt": "2023-11-07T05:31:56Z",
  "dunningLevel": 123,
  "dunningStatus": "none",
  "payDate": "2023-11-07T05:31:56Z",
  "invoiceAddress": "<any>",
  "internalNote": "This invoice is with a special discount.",
  "title": "<string>",
  "introduction": "<string>",
  "closing": "<string>",
  "netAmount": {},
  "grossAmount": {},
  "taxAmount": {},
  "discountAmount": {},
  "file": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "xmlFile": {
    "id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
    "isPrivate": true,
    "mimeType": "image/jpeg",
    "fileExtension": "jpg",
    "fileName": "invoice.jpg",
    "storageFileName": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ.jpg",
    "createdAt": "2021-01-01T00:00:00+00:00"
  },
  "positions": [
    {
      "id": {},
      "position": 123,
      "quantity": 1,
      "unit": {
        "id": {},
        "name": "Stück"
      },
      "unitPrice": {},
      "netAmount": {},
      "grossAmount": {},
      "taxAmount": {},
      "discountAmount": {},
      "discountPercentage": 10,
      "name": "My subscription product",
      "description": "* my subscription product",
      "taxGroup": {
        "id": "00000000-0000-0000-0000-000000000000",
        "internalDescription": "19%",
        "reverseChargeType": "REVERSE_CHARGE",
        "type": "standard"
      },
      "tax": {
        "id": "00000000-0000-0000-0000-000000000000",
        "description": "19%",
        "code": "19",
        "rate": 19
      },
      "type": "product",
      "parent": {},
      "group": {
        "id": "ad8a3b9e-5b0a-4e1a-9c1a-0b9b2b8b0b0b",
        "ranking": 1,
        "name": "Subscription #12345"
      },
      "createdAt": "2020-01-01T00:00:00+00:00",
      "product": {
        "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
        "name": "Basic",
        "description": "For small teams.",
        "type": "product",
        "invoiceVisibility": "always",
        "customFields": {
          "field1": "value1",
          "field2": "value2"
        }
      },
      "subscriptionItem": {
        "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
        "name": "Fitness M",
        "description": "Everything included",
        "furtherInformation": "Additional agreements: The contract includes a free drink flatrate.",
        "status": "active",
        "subscriptionId": "<string>"
      },
      "serviceDateFrom": "2020-01-01T00:00:00+00:00",
      "serviceDateTo": "2020-01-01T00:00:00+00:00"
    }
  ],
  "applicatedExchangeRates": [
    {
      "sourceCurrencyCode": "EUR",
      "destinationCurrencyCode": "CHF",
      "exchangeRate": "1.135",
      "exchangeRateDate": "2023-11-07T05:31:56Z"
    }
  ],
  "eInvoiceType": "<any>",
  "leitwegId": "1234567890123",
  "customFields": {
    "field1": "value1",
    "field2": "value2"
  },
  "serviceDateFrom": "2023-11-07T05:31:56Z",
  "serviceDateTo": "2023-11-07T05:31:56Z",
  "unpaidAmount": {},
  "usageBreakdownUrl": "<string>",
  "cancellationDocument": {
    "number": "R2021-0001",
    "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
  },
  "dunningDisabled": true,
  "sourceType": "<any>"
}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

Invoice identifier

Response

200
application/json
Invoice resource updated
id
string

The unique identifier of the invoice.

Example:

"00000000-0000-0000-0000-000000000000"

customer
object

The customer of the invoice.

paymentMethod
object | null

The payment method which should be used to fullfill the payment of the invoice.

referencedInvoice
object | null

The referenced invoice of the invoice. This could be in case of a reminder, refund etc.

type
enum<string>

The type of the invoice.

Available options:
TYPE_INVOICE,
TYPE_CREDIT,
TYPE_REFUND,
TYPE_REMINDER,
TYPE_CANCEL,
TYPE_DUNNING
Example:

"TYPE_INVOICE"

currencyCode
string

The currency code of the invoice. If multiple currency codes will be used in the positions, they will be converted to that base currency.

Example:

"EUR"

number
string

The document id of the invoice. This will be generated, when the invoice will be finalized.

Example:

"RE-0000000001"

status
enum<string>
Available options:
STATUS_DRAFT,
STATUS_PAID,
STATUS_CANCELLED,
STATUS_CLOSED,
STATUS_REFUNDED,
STATUS_REMINDED,
STATUS_UNPAID,
STATUS_NEW,
STATUS_FINALIZING
creationDate
string
finalizationDate
string | null
dueDate
string | null
lastReminderDate
string | null
lastSentAt
string | null
dunningLevel
integer
dunningStatus
enum<string>
default:none
Available options:
reminder,
dunning,
none
Example:

"none"

payDate
string | null
invoiceAddress
any | null

The invoice address of the invoice.

internalNote
string | null
deprecated

The notice of the invoice.

Example:

"This invoice is with a special discount."

title
string | null
introduction
string | null
closing
string | null
netAmount
object

The net amount of the invoice.

grossAmount
object
taxAmount
object
discountAmount
object

The total net discount amount of the invoice.

file
object | null
xmlFile
object | null

The xml representation of the invoice in EN16931 or x-Rechnung format.

positions
object[]

The positions of the invoice.

applicatedExchangeRates
object[]

The applicated exchange rates of the invoice, fetched from the european central bank.

eInvoiceType
any

The einvoice generated xml file format.

leitwegId
string | null

The leitwegid used for einvoice. This is only set, when the eInvoiceType is not null.

Example:

"1234567890123"

customFields
object | null

Custom fields for the entity. The keys are the field names and the values are the field values. They need to be configured under "/custom-fields" in the API documentation. The input is validated against the configuration. For more details see Custom Fields Guide

Example:
{ "field1": "value1", "field2": "value2" }
serviceDateFrom
string | null

The earliest service date of all positions.

serviceDateTo
string | null

The latest service date of all positions.

unpaidAmount
object
usageBreakdownUrl
string | null

Public url to view the detailed usage breakdown of this invoice.

cancellationDocument
object | null

The referenced cancellation document.

Example:
{
  "number": "R2021-0001",
  "id": "8d6b0f9e-5b9a-4e1a-9f0a-5e8e1a0b1b1e"
}
dunningDisabled
boolean

Dunning is disabled for this invoice.

sourceType
any

Where the invoice was created from.

Possible values:

  • cart: The invoice was created from a cart.
  • subscription: The invoice was created from a subscription billing run.
  • manual: The invoice was created by a user.