v1
latestOpenAPI 3.0.02026-07-2455104.8 MBSupplier
🔒 Update supplier V3
This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.
This endpoint requires the following scopes: supplier:update.
Update an existing supplier.
patch/api/v3/suppliers/{id}
Path parameters
idstring required
Request body
Example request
{
"number": "800042",
"deviatingSupplierNumber": "811999",
"mainProject": {
"id": "13"
},
"primaryAddress": {
"name": "GlobalTech Logistics GmbH",
"type": "company",
"title": "Dr.",
"contactPerson": "Michael Weber",
"salutation": "Sehr geehrte Damen und Herren",
"department": "Procurement",
"subDepartment": "International Sourcing",
"addressSupplement": "Building C, 2nd Floor",
"street": "Industriestraße 42",
"zipCode": "70565",
"city": "Stuttgart",
"state": "BW",
"country": "DE",
"gln": "4012345000017",
"email": "m.weber@globaltech.com",
"phone": "+4971112345670",
"mobile": "+4917612345671",
"fax": "+4971112345672"
},
"deviatingBillingAddress": {
"name": "GlobalTech Logistics GmbH",
"type": "company",
"title": "Dr.",
"contactPerson": "Michael Weber",
"salutation": "Sehr geehrte Damen und Herren",
"department": "Procurement",
"subDepartment": "International Sourcing",
"addressSupplement": "Building C, 2nd Floor",
"street": "Industriestraße 42",
"zipCode": "70565",
"city": "Stuttgart",
"state": "BW",
"country": "DE",
"gln": "4012345000017",
"email": "m.weber@globaltech.com",
"phone": "+4971112345670",
"mobile": "+4917612345671",
"fax": "+4971112345672"
},
"communication": {
"language": "en",
"website": "https://globaltech-logistics.com",
"additionalContactInformation": [
{
"key": "linkedin",
"value": "linkedin.com/in/lschneider"
}
]
},
"financials": {
"primaryBankAccount": {
"bankName": "Commerzbank AG",
"accountHolder": "Xentral ERP Solutions GmbH",
"iban": "DE12500105170648489890",
"bic": "COBADEFFXXX",
"sepa": {
"isCompanySepa": true,
"mandateReference": "TN2025DE9876543210XYZ",
"mandateReferenceDate": "2025-03-01",
"usage": "recurring",
"isInitialMandate": true,
"remark": "Standard SEPA mandate for monthly invoice settlement"
}
},
"tax": {
"vatId": "DE112233445",
"taxNumber": "91/123/45678",
"taxDisplay": "alwaysGross",
"taxDeterminationType": "domestic",
"customsInformation": "HS-Code 8471.30; Preferential origin: EU"
},
"paymentTerms": {
"paymentTargetDays": 30,
"paymentTargetDiscount": 2,
"paymentTargetDiscountDays": 10
},
"paymentMethod": {
"id": "13"
},
"paypal": {
"accountHolder": "Global Tech Payments",
"paypalAccount": "billing@globaltech.com",
"currency": "EUR"
},
"customerNumberForSupplier": "CUST-99042-X",
"defaultCurrency": "EUR",
"creditLimit": 50000
},
"fulfillment": {
"deliveryMethod": {
"id": "13"
},
"deliveryTerms": "DAP",
"deliveryBlockDate": "2025-06-10",
"freeShippingEnabled": true,
"freeShippingThreshold": 500,
"commissionConsignmentWarehouse": {
"id": "13"
}
},
"documentDelivery": {
"documentRecipients": {
"offer": {
"to": "invoice-send@domain.tpl",
"cc": [
"invoice-send-cc@otherdomain.tpl"
]
},
"creditNote": {
"to": "invoice-send@domain.tpl",
"cc": [
"invoice-send-cc@otherdomain.tpl"
]
},
"deliveryNote": {
"to": "invoice-send@domain.tpl",
"cc": [
"invoice-send-cc@otherdomain.tpl"
]
},
"purchaseOrder": {
"to": "invoice-send@domain.tpl",
"cc": [
"invoice-send-cc@otherdomain.tpl"
]
}
}
},
"accountManager": {
"id": "13"
},
"groups": [
{
"id": "8"
}
],
"supplierRoles": [
{
"project": {
"id": "13"
},
"validFrom": "2025-01-01",
"expiresAt": "2026-12-31"
}
],
"customFields": [
{
"key": "customField1",
"label": "lifecycle",
"value": "prospect"
}
],
"notes": "Preferred supplier for electronic components.",
"supplierPurchaseNote": "Always confirm delivery dates before ordering.",
"tags": [
{
"title": "important"
}
]
}Response
Update an existing supplier.
Example response
{
"data": {
"id": "1",
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00",
"number": "800042",
"deviatingSupplierNumber": "811999",
"mainProject": {
"id": "1"
},
"primaryAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"deviatingBillingAddress": {
"name": "John",
"type": "mr",
"title": "Ms.",
"contactPerson": "Laura Schneider",
"department": "Research & Development",
"subDepartment": "CAI Lab",
"addressSupplement": "Gebäude B, 4. Etage",
"street": "Fuggerstraße 11",
"zipCode": "86150",
"city": "Augsburg",
"state": "BY",
"country": "DE",
"salutation": "Sehr geehrte Damen und Herren",
"gln": "1234567890123",
"email": "alice@example.com",
"phone": "+1-234-567-8900",
"fax": "+1-234-567-8901",
"mobile": "+1-234-567-8902"
},
"communication": {
"language": "DE",
"website": "https://www.supplier-example.com",
"additionalContactInformation": [
{
"key": "Skype",
"value": "supplier.contact"
},
{
"key": "LinkedIn",
"value": "https://www.linkedin.com/company/supplier"
}
]
},
"financials": {
"primaryBankAccount": {
"bankName": "XYZ***",
"accountHolder": "Sup******************",
"iban": "DE89**************3000",
"bic": "*******FXXX",
"sepa": {
"isCompanySepa": true,
"mandateReference": "TN2*********************",
"mandateReferenceChange": false,
"mandateReferenceDate": "2025-03-01",
"usage": "recurring",
"isInitialMandate": true,
"remark": "Standard SEPA mandate for monthly payments"
}
},
"tax": {
"vatId": "DE112233445",
"taxNumber": "l2/345/67890",
"taxDisplay": "alwaysGross",
"taxDeterminationType": "domestic",
"customsInformation": "HS-Code 8471.30; Preferential origin: EU"
},
"paymentTerms": {
"paymentTargetDays": 30,
"paymentTargetDiscount": 2,
"paymentTargetDiscountDays": 10
},
"paymentMethod": {
"id": "1"
},
"customerNumberForSupplier": "CUST-12345",
"defaultCurrency": "EUR",
"creditLimit": 50000,
"paypal": {
"accountHolder": "Supplier Company",
"paypalAccount": "supplier@example.com",
"currency": "EUR"
}
},
"fulfillment": {
"freeShippingEnabled": false,
"freeShippingThreshold": 3.99,
"deliveryTerms": "DAP",
"deliveryBlock": false,
"deliveryBlockDate": "2025-06-10",
"deliveryBlockReason": "",
"commissionConsignmentWarehouse": {
"id": "1"
}
},
"documentDelivery": {
"preferFax": false,
"documentRecipients": {
"offer": {
"to": "offer-send@domain.tpl",
"cc": [
"offer-send-cc@otherdomain.tpl"
]
},
"creditNote": {
"to": "creditNote-send@domain.tpl",
"cc": [
"creditNote-send-cc@otherdomain.tpl"
]
},
"deliveryNote": {
"to": "deliveryNote-send@domain.tpl",
"cc": [
"deliveryNote-send-cc@otherdomain.tpl"
]
},
"purchaseOrder": {
"to": "purchaseOrder-send@domain.tpl",
"cc": [
"purchaseOrder-send-cc@otherdomain.tpl"
]
}
}
},
"supplierRoles": [
{
"project": {
"id": "1"
},
"validFrom": "2024-10-23",
"expiresAt": "2026-10-23"
},
{
"project": {
"id": "2"
},
"validFrom": "2024-11-17",
"expiresAt": "2025-11-17"
}
],
"groups": [
{
"id": "1"
},
{
"id": "2"
}
],
"accountManager": {
"id": "1"
},
"customFields": [
{
"key": "supplier_category",
"value": "Premium",
"label": "Supplier Category"
},
{
"key": "priority_level",
"value": "High",
"label": "Priority Level"
}
],
"notes": "Preferred supplier for electronic components",
"supplierPurchaseNote": "Always confirm delivery dates before ordering",
"deliveryAddresses": [
{
"id": "1",
"type": "company",
"name": "Acme Logistics Hub Berlin",
"title": "Dr.",
"contactPerson": "Marco Schmidt",
"salutation": "Hallo Logistics Team",
"department": "Logistics",
"subDepartment": "Distribution Center",
"addressSupplement": "Hall B",
"street": "Lagerweg 22",
"zipCode": "10437",
"city": "Berlin",
"state": "BE",
"country": "DE",
"gln": "4012345000300",
"phone": "+491231234567",
"mobile": "+49170123456",
"fax": "+491231234567-1",
"email": "name@provider.com",
"deliveryDetails": {
"taxType": "domestic",
"defaultDeliveryAddress": true,
"termsOfDelivery": "EXW",
"vatId": "DE123456789",
"remark": "Main Berlin hub open 06:00 to 22:00",
"note": "Deliveries after 10am only"
}
}
],
"contactPersons": [
{
"id": "17",
"type": "mr",
"name": "Alice Smith",
"title": "Ms.",
"salutation": "Dear Alice,",
"department": "Sales",
"subDepartment": "Customer Service",
"street": "123 Main St",
"addressSupplement": "Suite 100",
"zipCode": "12345",
"city": "Springfield",
"country": "US",
"state": "CA",
"phone": "+1-234-567-8900",
"mobile": "+1-800-567-8900",
"fax": "+1-234-567-8901",
"email": "alice@example.com",
"contactPersonDetails": {
"position": "Head of Controlling",
"birthday": "1978-04-12",
"language": "DE",
"allowMarketingEmails": false,
"internalNote": "Key decision‑maker for raw‑material contracts; prefers email after 17:00 CET.",
"remarks": "Speaks fluent English, French and Mandarin. Holds a PhD in Economics."
},
"groups": [
{
"id": "1"
}
],
"createdAt": "2025-03-15T09:27:00+01:00",
"updatedAt": "2025-10-20T14:45:12+01:00"
}
],
"tags": [
{
"id": "1",
"title": "important"
}
]
}
}