Update InvoiceSettings of a Customer

PUT /v2/customers/{customerId}/invoice-settings/

API version

v2

Request method

PUT

Operation ID

invoice-update-invoice-settings

---

Request

• customerIdstring

  required
  Example:"edefeee4-e8e9-4e2d-ab95-9a2eb6104cfb"

Responses

Format

application/json

Description

Schema documentation

• additionalEmailRecipientsarray of string (email)
  • Array[
  • *string (email)
  ]

debitPaymentStopUntilstring (date-time)

idstring

required

invoicePeriodinteger

lastBankingInformationobject

• accountHolderstring

  required
• bicstring
• ibanstring

  required

paymentSettingsone of 2 alternatives

printedInvoicesboolean

recipientobject

• addressobject

  required
  • streetstring

    required
  • houseNumberstring

    required
  • citystring

    required
  • zipstring

    required
  • countryCodestring

    required

    ISO 3166-1 alpha-2 country code

  • addressPrefixstring
• companystring
• emailAddressstring (email)
• firstNamestring
• lastNamestring
• phoneNumbersarray of string
  • Array[
  • *string
  ]

salutationstring (one of: mr, ms, other)

required

titlestring

useFormalTermboolean

recipientSameAsOwnerboolean

statusarray of object

• Array[
• *object
  • messagestring

    required
  • severitystring (one of: success, info, warning, error)

    required
  • typestring (one of: returnDebitNote, returnDebitNoteWaitingForPayment, debtWrittenOff)

    required
]

targetDayinteger

Example

{
  "additionalEmailRecipients": [
    "email@mittwald.example"
  ],
  "debitPaymentStopUntil": "2024-09-16T00:26:43.830Z",
  "id": "5f9b9b9b-9b9b-9b9b-9b9b-9b9b9b9b9b9b",
  "invoicePeriod": 1,
  "lastBankingInformation": {
    "accountHolder": "Ada Lovelace",
    "bic": "DEUTDEDB123",
    "iban": "DE12345678901234567890"
  },
  "paymentSettings": {
    "accountHolder": "Ada Lovelace",
    "bic": "DEUTDEDB123",
    "iban": "DE12345678901234567890",
    "method": "debit"
  },
  "printedInvoices": true,
  "recipient": {
    "address": {
      "street": "Königsberger Straße",
      "houseNumber": "4-6",
      "city": "Espelkamp",
      "zip": "32339",
      "countryCode": "DE",
      "addressPrefix": "c/o Ada Lovelace"
    },
    "company": "Mittwald CM Service GmbH & Co. KG",
    "emailAddress": "email@mittwald.example",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "phoneNumbers": [
      "+49 123 4567890"
    ],
    "salutation": "mr",
    "title": "Dr.",
    "useFormalTerm": true
  },
  "recipientSameAsOwner": true,
  "status": [
    {
      "message": "Unfortunately, we were unable to debit your account. Please update your account details.",
      "severity": "success",
      "type": "returnDebitNote"
    }
  ],
  "targetDay": 15
}

JSON Schema

{
  "properties": {
    "additionalEmailRecipients": {
      "items": {
        "format": "email",
        "type": "string"
      },
      "type": "array"
    },
    "debitPaymentStopUntil": {
      "format": "date-time",
      "type": "string"
    },
    "id": {
      "example": "5f9b9b9b-9b9b-9b9b-9b9b-9b9b9b9b9b9b",
      "type": "string"
    },
    "invoicePeriod": {
      "example": 1,
      "type": "integer"
    },
    "lastBankingInformation": {
      "properties": {
        "accountHolder": {
          "example": "Ada Lovelace",
          "type": "string"
        },
        "bic": {
          "example": "DEUTDEDB123",
          "type": "string"
        },
        "iban": {
          "example": "DE12345678901234567890",
          "type": "string"
        }
      },
      "required": [
        "iban",
        "accountHolder"
      ],
      "type": "object"
    },
    "paymentSettings": {
      "oneOf": [
        {
          "properties": {
            "accountHolder": {
              "example": "Ada Lovelace",
              "type": "string"
            },
            "bic": {
              "description": "Optional. Required for payments outside of the European Union.",
              "example": "DEUTDEDB123",
              "type": "string"
            },
            "iban": {
              "example": "DE12345678901234567890",
              "type": "string"
            },
            "method": {
              "enum": [
                "debit"
              ],
              "type": "string"
            }
          },
          "required": [
            "method",
            "iban",
            "accountHolder"
          ],
          "type": "object"
        },
        {
          "properties": {
            "method": {
              "enum": [
                "invoice"
              ],
              "type": "string"
            }
          },
          "required": [
            "method"
          ],
          "type": "object"
        }
      ]
    },
    "printedInvoices": {
      "type": "boolean"
    },
    "recipient": {
      "properties": {
        "address": {
          "type": "object",
          "properties": {
            "street": {
              "type": "string",
              "example": "Königsberger Straße"
            },
            "houseNumber": {
              "type": "string",
              "example": "4-6"
            },
            "city": {
              "type": "string",
              "example": "Espelkamp"
            },
            "zip": {
              "type": "string",
              "example": "32339"
            },
            "countryCode": {
              "type": "string",
              "example": "DE",
              "description": "ISO 3166-1 alpha-2 country code"
            },
            "addressPrefix": {
              "type": "string",
              "example": "c/o Ada Lovelace"
            }
          },
          "required": [
            "street",
            "houseNumber",
            "city",
            "zip",
            "countryCode"
          ]
        },
        "company": {
          "example": "Mittwald CM Service GmbH & Co. KG",
          "type": "string"
        },
        "emailAddress": {
          "format": "email",
          "type": "string"
        },
        "firstName": {
          "example": "Ada",
          "type": "string"
        },
        "lastName": {
          "example": "Lovelace",
          "type": "string"
        },
        "phoneNumbers": {
          "items": {
            "example": "+49 123 4567890",
            "type": "string"
          },
          "type": "array"
        },
        "salutation": {
          "type": "string",
          "enum": [
            "mr",
            "ms",
            "other"
          ]
        },
        "title": {
          "example": "Dr.",
          "type": "string"
        },
        "useFormalTerm": {
          "type": "boolean"
        }
      },
      "required": [
        "address",
        "salutation"
      ],
      "type": "object"
    },
    "recipientSameAsOwner": {
      "type": "boolean"
    },
    "status": {
      "items": {
        "properties": {
          "message": {
            "example": "Unfortunately, we were unable to debit your account. Please update your account details.",
            "type": "string"
          },
          "severity": {
            "enum": [
              "success",
              "info",
              "warning",
              "error"
            ],
            "type": "string"
          },
          "type": {
            "enum": [
              "returnDebitNote",
              "returnDebitNoteWaitingForPayment",
              "debtWrittenOff"
            ],
            "type": "string"
          }
        },
        "required": [
          "severity",
          "type",
          "message"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "targetDay": {
      "example": 15,
      "type": "integer"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X PUT \
    -d '{"additionalEmailRecipients":["hallo@test.de"],"invoicePeriod":1,"paymentSettings":{"accountHolder":"Ada Lovelace","bic":"DEUTDEDB123","iban":"DE12345678901234567890","method":"debit"},"printedInvoices":true,"recipient":{"address":{"street":"Königsberger Straße","houseNumber":"4-6","city":"Espelkamp","zip":"32339","countryCode":"DE","addressPrefix":"c/o Ada Lovelace"},"company":"Mittwald CM Service GmbH & Co. KG","emailAddress":"email@mittwald.example","firstName":"Ada","lastName":"Lovelace","phoneNumbers":["+49 123 4567890"],"salutation":"mr","title":"Dr.","useFormalTerm":true},"recipientSameAsOwner":true,"targetDay":15}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/customers/string/invoice-settings

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.contract.invoiceUpdateInvoiceSettings({
  "customerId": "string",
  "data": {
    "additionalEmailRecipients": [
      "hallo@test.de"
    ],
    "invoicePeriod": 1,
    "paymentSettings": {
      "accountHolder": "Ada Lovelace",
      "bic": "DEUTDEDB123",
      "iban": "DE12345678901234567890",
      "method": "debit"
    },
    "printedInvoices": true,
    "recipient": {
      "address": {
        "street": "Königsberger Straße",
        "houseNumber": "4-6",
        "city": "Espelkamp",
        "zip": "32339",
        "countryCode": "DE",
        "addressPrefix": "c/o Ada Lovelace"
      },
      "company": "Mittwald CM Service GmbH & Co. KG",
      "emailAddress": "email@mittwald.example",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "phoneNumbers": [
        "+49 123 4567890"
      ],
      "salutation": "mr",
      "title": "Dr.",
      "useFormalTerm": true
    },
    "recipientSameAsOwner": true,
    "targetDay": 15
  }
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Contract\InvoiceUpdateInvoiceSettings\InvoiceUpdateInvoiceSettingsRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\Contract\InvoiceUpdateInvoiceSettings\InvoiceUpdateInvoiceSettingsRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// InvoiceUpdateInvoiceSettingsRequestBody to learn how to construct a valid instance
$body = new InvoiceUpdateInvoiceSettingsRequestBody(/* TODO: ... */);

$request = (new InvoiceUpdateInvoiceSettingsRequest(
  customerId: "string",
  body: $body
));
$response = $client->contract()->invoiceUpdateInvoiceSettings($request);

var_dump($response->getBody();