v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Customer

Update customer

Update an existing customer.

patch/api/v2/customers/{id}

Path parameters

idstring required

Resource identifier.

Example:17

The customer's identifier.

Request body

customerType'person' | 'company' nullable

Discriminator to create a company. If 'company' is used then 'name' is required. If 'person' is used then 'firstname' and 'lastname' are required.

firstnamestring nullable

Firstname of customer

lastnamestring nullable

Lastname of customer

namestring nullable

Name of the company

titlestring nullable

Title prefix for customer name. It will be used for communication.

birthdatestring date nullable

Birhtdate of customer

numberstring nullable

Customer number. if this is not provided default number ranges will be applied automatically

deviatingCustomerNumberstring nullable

Deviating Customer number.

salutation'mr' | 'mrs' | 'company' | 'other' nullable

Decide kind of person if necessary. This value is e.g. responsible to apply automatic rules for salutation

salutationPhrasestring nullable

You can specify a salutation how a customer/company should be addressed and override automatic rules.

departmentstring nullable

Specify a department for customer

subDepartmentstring nullable

Specify a sub-department for customer

isLeadboolean

Decides if customer is a lead

contactPersonstring nullable

Name of contact person

groupsinteger[] nullable

Specify the list of groups the customer should belong to

languagestring nullable

Language ISO code for customer communication

commissionnumber float

Commission percentage for this customer

identifierstring nullable

Custom identifier for the customer

logfilestring

Log entries of customer activities

latnumber float nullable

Latitude coordinate

lngnumber float nullable

Longitude coordinate

Example request

{
  "firstname": "Max",
  "lastname": "Mustmermann",
  "name": "General Cosmic Company",
  "title": "Prof. Dr.",
  "birthdate": "2024-03-01",
  "number": "C700001",
  "deviatingCustomerNumber": "C711223",
  "salutation": "mr",
  "salutationPhrase": "Dear Sir",
  "department": "Sales",
  "subDepartment": "Onlines Sales",
  "contactDetails": {
    "phone": "+49(30)12093756",
    "mobile": "+49(172)56565656",
    "fax": "+49(30)12093756-1",
    "email": "customer@domain.tpl",
    "additionalData": [
      {
        "label": "mobile2",
        "value": "+1(800)555 12235"
      }
    ]
  },
  "accountManager": {
    "id": "17"
  },
  "salesManager": {
    "id": "17"
  },
  "isLead": true,
  "contactPerson": "Milo Thatch",
  "customFields": [
    {
      "id": 1,
      "value": "HS Deal - Open"
    }
  ],
  "financials": {
    "tax": {
      "taxation": "eu-delivery",
      "taxDisplay": "always-gross",
      "useDeliveryThreshold": false,
      "taxNumber": "1234",
      "vatId": "1234"
    },
    "paymentTerms": {
      "fixedPaymentTerms": true,
      "paymentTargetDays": 99,
      "paymentTargetDiscount": 2.5,
      "paymentTargetDiscountDays": 5
    },
    "paymentMethod": {
      "id": "3"
    },
    "subscriptionPaymentMethod": "invoice",
    "customsInformation": "Remarks regarding customs",
    "creditLimit": 0,
    "defaultCurrency": "EUR"
  },
  "primaryBankAccount": {
    "bankName": "XYZ Bank",
    "owner": "Name of the owner",
    "iban": "DE89370400440532013000",
    "bic": "DEUTDEFFXXX",
    "sepa": {
      "companySepa": true,
      "mandateReference": "K21124DE60S21F2S09WX11G4FY",
      "mandateReferenceChange": false,
      "mandateReferenceDate": "2025-03-01",
      "usage": "recurring",
      "initial": true,
      "remark": "This is a comment"
    }
  },
  "documentDelivery": {
    "autoCreateDocuments": "both",
    "invoiceAlwaysPaper": true,
    "amountInvoicePrints": 2,
    "preferFax": true
  },
  "language": "de",
  "mainProject": {
    "id": "1"
  },
  "commission": 5.5,
  "identifier": "CUST-001",
  "logfile": "customer.log",
  "lat": 52.520008,
  "lng": 13.404954,
  "fromShop": {
    "id": "5"
  },
  "marketing": {
    "marketingBan": false,
    "showBirthdayInCalendar": true,
    "birthdayCard": true,
    "ageApproval": true
  },
  "shipping": {
    "freeShipping": true,
    "trackingMailBan": false,
    "deliveryBan": false,
    "freeShippingFrom": 50,
    "deliveryBanReason": "invalid address",
    "shippingMethod": {
      "id": "1"
    }
  }
}

Response

Operation completed successfully, no response body