New API version v7.7.0 has been released! 🎉
REST Documentation
POST Create Customer

Create Customer

You can use this endpoint to create a new customer.

Request

POST /api/v1/customers
curl --request POST \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
         "customer_number": "CUST-2024-001",
         "name": "Acme Corporation",
         "additional_name": "ACME Corp.",
         "website": "https://www.acme.com",
         "email": "contact@acme.com",
         "phone": "+49 30 123456",
         "fax": "+49 30 123457",
         "currency": "EUR",
         "comments": "Important customer, handle with care",
         "industry_name": "Technology",
         "vat": 19.0,
         "tax_number": "DE123456789",
         "iban": "DE89370400440532013000",
         "bic": "COBADEFFXXX",
         "payment_target": 30,
         "payment_target_discount": 2,
         "status": "ACTIVE",
         "billing_procedure": true,
         "automated_invoicing": false,
         "department_id": 1
     }'

Response

{
    "data": {
        "id": 501,
        "customer_number": "CUST-2024-001",
        "name": "Acme Corporation",
        "status": "active",
        "email": "contact@acme.com",
        "phone": "+49 30 123456",
        "fax": "+49 30 123457",
        "comments": "Important customer, handle with care",
        "currency": "EUR",
        "vat": 19,
        "payment_target": 30,
        "industry_name": "Technology",
        "created": "2024-09-17T10:15:47.000000Z",
        "modified": "2024-09-17T10:15:47.000000Z"
    }
}

Required Parameters

  • Name
    customer_number
    Type
    string
    Description

    Unique customer number. Max 32 characters. Must be unique in the system.

  • Name
    name
    Type
    string
    Description

    Customer name. Max 120 characters.

  • Name
    currency
    Type
    string
    Description

    Currency code. Must exist in the currencies table. Defaults to base currency if not provided.

  • Name
    department_id
    Type
    integer
    Description

    Department ID. Must exist in departments table. Defaults to default department if not provided.

Optional Parameters

Basic Information

  • Name
    additional_name
    Type
    string
    Description

    Additional name or alias. Max 120 characters.

  • Name
    website
    Type
    string
    Description

    Customer website URL. Max 120 characters.

  • Name
    email
    Type
    string | email
    Description

    Customer email address. Max 320 characters.

  • Name
    phone
    Type
    string
    Description

    Customer phone number. Max 32 characters.

  • Name
    fax
    Type
    string
    Description

    Customer fax number. Max 32 characters.

  • Name
    comments
    Type
    string
    Description

    Internal comments about the customer.

  • Name
    industry_name
    Type
    string
    Description

    Industry or sector name. Max 32 characters.

  • Name
    status
    Type
    string | enum
    Description

    Customer status. Valid CustomerStatus enum values.

Financial Information

  • Name
    vat
    Type
    numeric
    Description

    VAT percentage.

  • Name
    tax_number
    Type
    string
    Description

    Tax number. Max 32 characters.

  • Name
    payment_target
    Type
    integer
    Description

    Payment terms in days.

  • Name
    payment_target_discount
    Type
    integer
    Description

    Early payment discount days.

Banking Information

  • Name
    iban
    Type
    string
    Description

    International Bank Account Number. Max 34 characters.

  • Name
    bic
    Type
    string
    Description

    Bank Identifier Code / SWIFT code. Max 11 characters.

Billing Settings

  • Name
    billing_procedure
    Type
    boolean
    Description

    Whether billing procedure is enabled.

  • Name
    automated_invoicing
    Type
    boolean
    Description

    Whether automated invoicing is enabled.

  • Name
    debit_payment
    Type
    boolean
    Description

    Whether debit payment is enabled.

Travel Expenses

  • Name
    travel_expense_flat_per_day
    Type
    integer
    Description

    Daily travel expense flat rate. Defaults to config value.

  • Name
    travel_expense_flat_per_journey
    Type
    integer
    Description

    Per journey travel expense flat rate. Defaults to config value.

Additional Data

  • Name
    dynamic_attributes
    Type
    array
    Description

    Array of dynamic attribute values.

  • Name
    categories
    Type
    array
    Description

    Array of category assignments.