NAV Navbar
cURL

Introduction

Welcome to the Bilendo API-V2! You can use this API to access and modify data in your bilendo account.

This API uses the JSON-API Format.

Environments

Staging

You can request a Developer account via E-Mail at operations@bilendo.de

The API-Endpoints for this environment all start with https://apisandbox.bilendo.de

Production

The API-Endpoints for this environment all start with https://api.bilendo.de

Authentication

Bilendo uses API tokens to allow access to the API. You can get your API-Token in your Bilendo-Account under your account settings.

Header Name Header Value
Authorization Token token=YOUR-API-TOKEN

Customers

Customer Object

{
    "data": {
        "id": "<customer-id>",
        "type": "customer",
        "attributes": {
            "id": "<customer-id>",
            "external_id": "<your-customer-id>",
            "customer_number": "10001",
            "additional_number": "20002",
            "name": "New Company",
            "phone": "123456",
            "dunning_stop": false,
            "dunning_stop_date": null,
            "notice": "Lorem Ipsum",
            "shipping_mode": "email",
            "customer_group_id": "<customer-group-id>",
            "template_email_id": "<template-email-id>",
            "template_invoice_id": "<template-invoice-id>",
            "template_post_id": "<template-post-id>",
            "template_setting_id": "<template-setting-id>",
            "created_at": "2020-05-15T15:53:44+02:00",
            "updated_at": "2020-05-15T15:53:44+02:00"
        },
        "relationships": {
            "addresses": {
                "data": [],
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses"
                }
            },
            "contacts": {
                "data": [],
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts"
                }
            }
        }
    }
}
Attribute Type Description
id string Bilendo id of the customer
Example: 00000000-0000-0000-0000-000000000000
external_id string your id of the customer
customer_number string optional customer number
additional_number string optional additional customer number
name string name of the customer
phone string phone number of the customer
dunning_stop boolean prevents reminders
dunning_stop_date date the dunning_stop ends on this date
shipping_mode string shipping methods with values:
email
post
dual_shipping (email & post simultaneously)
unknown
We default to the company shipping mode settings if empty.
customer_group_id string the customer's group id
notice string optional note
template_setting_id string the customer's template setting id
template_invoice_id string the customer's template invoice id
template_email_id string the customer's template email id
template_post_id string the customer's template post id
created_at datetime datetime of creation
updated_at datetime datetime of last update

Get All Customers

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "name=New Companyname Inc." \

This endpoint will display all the customers for a company.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers

{
    "data": [
        {
            "id": "<customer-id>",
            "type": "customer",
            "attributes": {
                "id": "<customer-id>",
                "external_id": "<your-customer-id>",
                "customer_number": "10001",
                "additional_number": "20002",
                "name": "New Company",
                "phone": "123456",
                "dunning_stop": false,
                "dunning_stop_date": null,
                "notice": "Lorem Ipsum",
                "shipping_mode": "email",
                "customer_group_id": "<customer-group-id>",
                "template_email_id": "<template-email-id>",
                "template_invoice_id": "<template-invoice-id>",
                "template_post_id": "<template-post-id>",
                "template_setting_id": "<template-setting-id>",
                "created_at": "2020-05-15T15:53:44+02:00",
                "updated_at": "2020-05-15T15:53:44+02:00"
            },
            "relationships": {
                "addresses": {
                    "data": [],
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses"
                    }
                },
                "contacts": {
                    "data": [],
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/customers?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/customers?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/customers?page=1"
    }
}

Create New Customer

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "name=New Company" \
  -d "phone=123456" \
  -d "external_id=<your-customer-id>" \
  -d "customer_number=10001" \
  -d "additional_number=20002" \
  -d "note=Lorem Ipsum" \
  -d "customer_group_id=<customer-group-id>" \
  -d "customer_group_id=<customer-group-id>" \
  -d "template_email_id=<template-email-id>" \
  -d "template_invoice_id=<template-invoice-id>" \
  -d "template_post_id=<template-post-id>" \
  -d "template_setting_id=<template-setting-id>" \

This endpoint will create a new customer for a company.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/customers

Attribute Type Description
external_id optional your id of the customer
customer_number optional optional customer number
additional_number optional optional additional customer number
name mandatory name of the customer
phone optional phone number of the customer
notice optional optional note

Update Existing Customer

curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "name=New Companyname Inc." \

This endpoint will update the details of customer for a company.

API Endpoint

PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>

Attribute Type Description
id mandatory Bilendo id of the customer
external_id optional your id of the customer
customer_number optional optional customer number
additional_number optional optional additional customer number
name mandatory name of the customer
phone optional phone number of the customer
customer_group_id optional the customer's group id
notice optional optional note
template_setting_id optional the customer's template setting id
template_invoice_id optional the customer's template invoice id
template_email_id optional the customer's template email id
template_post_id optional the customer's template post id

Get a specific Customer

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display all the information of a particular customer.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>

Find a specific Customer

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/find/<your-customer-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to find a customer by your own id.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/find/<your-customer-id>

Add Dunning Stop for Customer

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/dunning_stop" \
  -H "Authorization: Token token=YOUR-API-TOKEN"
  -d "dunning_stop_type=external" \
  -d "dunning_stop_date=2020.01.01" \

Use this endpoint to add a dunning stop to a customer

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/dunning_stop

Attribute Type Description
dunning_stop_type mandatory values: manual or external
dunning_stop_date optional Date on which you want to stop the manual dunning stop
Optional, only for manual dunning stop

Remove Dunning Stop fro Customer

curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/dunning_stop" \
  -H "Authorization: Token token=YOUR-API-TOKEN"
  -d "dunning_stop_type=external" \

Use this endpoint to deactivate dunning stop service.

API Endpoint

DELETE https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/dunning_stop

Attribute Type Description
dunning_stop_type mandatory values: manual or external

Contacts

Contact Object

{
    "data": {
        "id": "<contact-id>",
        "type": "contact",
        "attributes": {
            "id": "<contact-id>",
            "name": "John",
            "gender": 1,
            "salutation": 1,
            "email": "john@bilendo.de",
            "external_id": "<your-contact-id>",
            "phone": "0123456789",
            "main_contact": true,
            "created_at": "2020-05-15T17:35:00+02:00",
            "updated_at": "2020-05-15T17:35:00+02:00"
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "<customer-id>",
                    "type": "customer"
                },
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>"
                }
            }
        }
    }
}
Attribute Type Description
id string Bilendo id of the contact
Example: 00000000-0000-0000-0000-000000000000
external_id string your id of the contact
name string name of the contact
phone string phone number of the contact
gender integer 0 = unknown
1 = male
2 = female
salutation integer 0 = formal
1 = informal
email string email
customer_id string the customer id
main_contact boolean true = main contact
false = not main contact

Get All Contacts

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the contacts for a customer.

API Endpoint

GET https://api.bilendo.de/api/v2/customers/<customer-id>/contacts

{
    "data": [
        {
            "id": "<contact-id>",
            "type": "contact",
            "attributes": {
                "id": "<contact-id>",
                "name": "John",
                "gender": 1,
                "salutation": 1,
                "email": "john@bilendo.de",
                "external_id": "<your-contact-id>",
                "phone": "0123456789",
                "main_contact": true,
                "created_at": "2020-05-15T17:35:00+02:00",
                "updated_at": "2020-05-15T17:35:00+02:00"
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "<customer-id>",
                        "type": "customer"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts?page=1"
    }
}

Create new Contact

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "name=John" \
  -d "phone=0123456789" \
  -d "external_id=<your-contact-id>" \
  -d "gender=1" \
  -d "salutation=1" \
  -d "email=john@bilendo.de" \

This endpoint allows you to create contact for a customer.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts

Parameter Type Description
name mandatory name of the contact
phone optional phone number of the contact
gender mandatory 0 = unknown
1 = male
2 = female
external_id optional your contact id
salutation mandatory 0 = formal
1 = informal
email optional email
main_contact optional true = make this contact a main contact,
false = make this contact not a main contact

Update existing Contact

curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customer/<customer-id>/contacts/<contact-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "name=New name" \

This endpoint allows you to update the information of a contact for a customer.

API Endpoint

PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>

Parameter Type Description
name mandatory name of the contact
phone optional phone number of the contact
gender mandatory 0 = unknown
1 = male
2 = female
external_id optional your contact id
salutation mandatory 0 = formal
1 = informal
email optional email
main_contact optional true = make this contact a main contact, false = make this contact not a main contact

Get a specific Contact

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display all the information of a particular contact for a customer.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>

Find a specific Contact

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/find/<your-contact-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to find a contact by your own id.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/find/<your-contact-id>

Addresses

Address Object

{
    "data": {
        "id": "<address-id>",
        "type": "address",
        "attributes": {
            "id": "<address-id>",
            "external_id": "<your-address-id>",
            "zip": "81735",
            "city": "Munich",
            "country": "Deutschland",
            "default_address": true,
            "line1": "New GmbH",
            "line2": null,
            "line3": "Sendlinger Str. 85",
            "line4": null,
            "created_at": "2020-05-15T18:22:10+02:00",
            "updated_at": "2020-05-15T18:22:10+02:00"
        },
        "relationships": {
            "customer": {
                "data": {
                    "id": "<customer-id>",
                    "type": "customer"
                },
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/customers/<address-id>"
                }
            }
        }
    }
}
Attribute Type Description
id string Bilendo id of the address
Example: 00000000-0000-0000-0000-000000000000
external_id string your id of the address
line1 string customer’s address line 1 (customer name)
line2 string customer’s address line 2 (contact name)
line3 string customer’s address line 3 (street and house number)
line4 string customer’s address line 4 (additional address)
zip string customer’s zip code
city string customer’s city
country string customer’s country
customer_id string the customer id
default_address boolean true = default address
false = not default address

Get All Addresses

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the addresses for a customer.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses

{
    "data": [
        {
            "id": "<address-id>",
            "type": "address",
            "attributes": {
                "id": "<address-id>",
                "external_id": "<your-address-id>",
                "zip": "81735",
                "city": "Munich",
                "country": "Deutschland",
                "default_address": true,
                "line1": "New GmbH",
                "line2": null,
                "line3": "Sendlinger Str. 85",
                "line4": null,
                "created_at": "2020-05-15T18:22:10+02:00",
                "updated_at": "2020-05-15T18:22:10+02:00"
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "<customer-id>",
                        "type": "customer"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<address-id>"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses?page=1"
    }
}

Create new Address

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "line1=New GmbH" \
  -d "line3=Sendlinger Str. 85" \
  -d "zip=81735" \
  -d "city=Munich" \
  -d "country_code=de" \

This endpoint allows you to create a new address for a customer.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses

Attribute Type Description
external_id optional your id of the address
line1 mandatory customer’s address line 1 (customer name)
line2 optional customer’s address line 2 (contact name)
line3 mandatory customer’s address line 3 (street and house number)
line4 optional customer’s address line 4 (additional address)
zip mandatory customer’s zip code
city mandatory customer’s city
country_code or
country
mandatory customer’s country isocode or name
default_address optional true = default address
false = not default address

Update existing Address

curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "city=Munich" \

This endpoint allows you to update the information of an address for a customer.

API Endpoint

PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>

Attribute Type Description
external_id optional your id of the address
line1 mandatory customer’s address line 1 (customer name)
line2 optional customer’s address line 2 (contact name)
line3 mandatory customer’s address line 3 (street and house number)
line4 optional customer’s address line 4 (additional address)
zip mandatory customer’s zip code
city mandatory customer’s city
country_code or
country
mandatory customer’s country isocode or name
default_address optional true = default address
false = not default address

Get a specific Address

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display all the information of a particular address for a customer.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>

Find a specific Address

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/find/<your-address-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to find an address by your own id.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/find/<your-address-id>

Customers Groups

Customers Group Object

{
    "data": [
        {
            "id": "<customer_group-id>",
            "type": "customer_group",
            "attributes": {
                "id": "<customer-group-id>",
                "external_id": "<your-customer-group-id>",
                "active": true,
                "name": "Example Group",
                "description": "Lorem ipsum",
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "<customer-id>",
                        "type": "customer"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>"
                    }
                },
                "template_email": {
                    "data": {
                        "id": "<template-email-id>",
                        "type": "template_email"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>"
                    }
                },
                "template_invoice": {
                    "data": {
                        "id": "<template-invoice-id>",
                        "type": "template_invoice"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>"
                    }
                },
                "template_post": {
                    "data": {
                        "id": "<template-post-id>",
                        "type": "template_post"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>"
                    }
                },
                "template_setting": {
                    "data": {
                        "id": "<template-setting-id>",
                        "type": "template_setting"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>"
                    }
                }
            }
        }
    ]
}
Attribute Type Description
id string Bilendo id of the customers group
Example: 00000000-0000-0000-0000-000000000000
external_id string Your id for the customers group
active boolean active or inactive groups. If a group is inactive, its settings are ignored and we fallback to the company settings
name text customers group name
description text customers group description

Get Customers Groups

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customer_groups

{
    "data": [
        {
            "id": "<customer_group-id>",
            "type": "customer_group",
            "attributes": {
                "id": "<customer-group-id>",
                "external_id": "<your-customer-group-id>",
                "active": true,
                "name": "Example Group",
                "description": "Lorem ipsum",
            },
            "relationships": {
                "customer": {
                    "data": {
                        "id": "<customer-id>",
                        "type": "customer"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>"
                    }
                },
                "template_email": {
                    "data": {
                        "id": "<template-email-id>",
                        "type": "template_email"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>"
                    }
                },
                "template_invoice": {
                    "data": {
                        "id": "<template-invoice-id>",
                        "type": "template_invoice"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>"
                    }
                },
                "template_post": {
                    "data": {
                        "id": "<template-post-id>",
                        "type": "template_post"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>"
                    }
                },
                "template_setting": {
                    "data": {
                        "id": "<template-setting-id>",
                        "type": "template_setting"
                    },
                    "links": {
                        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
                        "related": "https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/customer_groups?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/customer_groups?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/customer_groups?page=1"
    }
}

Get a specific Customers Group

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>

Find a specific Customers Group

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups/find/<your-customer-group-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to find a customer_group by your own id.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/customer_groups/find/<your-customer-group-id>

Add Customers

curl -X "PUT" "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/add" \
     -H "Authorization: Token token=YOUR-API-TOKEN" \
     -d $'{ "customers": [
            "<customer-id1>",
            "<customer-id2>"
          ]}'
Parameter Type Description
customers mandatory customers array
customer_id optional bilendo-customer-id (customer to be added)

API Endpoint

PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/add

Remove Customers

curl -X "PUT" "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/remove" \
     -H "Authorization: Token token=YOUR-API-TOKEN" \
     -d $'{ "customers": [
            "<customer-id1>",
            "<customer-id2>"
          ]}'
Parameter Type Description
customers mandatory customers array
customer_id optional bilendo-customer-id (customer to be removed)

API Endpoint

PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/remove

Journal Entries

Journal Entries Object

{
    "data": {
        "id" : "<journal-entry-id>",
        "type" : "journal_entry",
        "attributes" : {
            "amount": "123.45",
            "currency": "EUR",
            "due_date": "1998-02-19",
            "dunning_stop_date": null,
            "dunning_stop": false,
            "entry_date": "1998-02-01",
            "entry_key": "1234567890",
            "external_notice": null,
            "imported_doctype": "SaP123",
            "invoice_number": null,
            "journal_type": "receivable",
            "notice": null,
            "receipt_date": "1998-01-28",
            "imported_difference_reason": null,
            "source": "sap",
            "status": 200,
            "text": "This is a journal entry",
            "created_at": "2020-06-03T14:18:27+02:00",
            "updated_at": "2020-06-03T14:18:27+02:00"
        }
    }
}
Attribute Type Description
id string Bilendo id of the journal entry
Example: 00000000-0000-0000-0000-000000000000
entry_key string unique external id of the journal entry
amount decimal
currency string
due_date date
dunning_stop_date date the dunning_stop ends on this date
dunning_stop boolean prevents reminders
entry_date date the date of the creation of the Journal Entry in the external system
external_notice string
imported_doctype string
invoice_number string
journal_type string
notice string optional note
receipt_date date The date of the document
imported_difference_reason string
source string
status string
text string

Get All Journal Entries

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the journal entries.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/journal_entries

{
    "data": [
        {
            "id" : "<journal-entry-id>",
            "type" : "journal_entry",
            "attributes" : {
                "amount": "123.45",
                "currency": "EUR",
                "due_date": "1998-02-19",
                "dunning_stop_date": null,
                "dunning_stop": false,
                "entry_date": "1998-02-01",
                "entry_key": "1234567890",
                "external_notice": null,
                "imported_doctype": "SaP123",
                "invoice_number": null,
                "journal_type": "receivable",
                "notice": null,
                "receipt_date": "1998-01-28",
                "imported_difference_reason": null,
                "source": "sap",
                "status": 200,
                "text": "This is journal_entry",
                "created_at": "2020-06-03T14:18:27+02:00",
                "updated_at": "2020-06-03T14:18:27+02:00"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/journal_entries?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/journal_entries?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/journal_entries?page=1"
    }
}

Create new Journal Entry

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/journal_entries" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "sap_account_name=Account Name" \
  -d "sap_account_number=Account Number" \
  -d "sap_receipt_number=1418124854" \
  -d "imported_doctype=10" \
  -d "receipt_date=2020-05-08" \
  -d "amount=100" \
  -d "due_date=2020-05-22" \
  -d "invoice_number=12389" \

This endpoint allows you to create a new journal entry.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/journal_entries

Attribute Type Description
amount mandatory
due_date mandatory
dunning_stop mandatory
entry_date optional
external_last_dunning_date mandatory
receipt_date mandatory
account_name mandatory
account_number optional
receipt_number optional
sap_association mandatory
business_unit mandatory
clearing_number mandatory
imported_difference_reason optional
imported_doctype mandatory
notice optional
text optional
sap_reference mandatory
reference_key_1 mandatory
reference_key_2 mandatory
sap_reminder_stage optional
journal_type mandatory
source_document optional

Get a specific Journal Entry

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display all the information of a particular journal entry.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>

Find a specific Journal Entry

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/find/<entry-key>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to find a journal entry by entry key.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/journal_entries/find/<entry-key>

Add Dunning Stop for Journal Entry

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/dunning_stop" \
  -H "Authorization: Token token=YOUR-API-TOKEN"
  -d "dunning_stop_type=external" \
  -d "dunning_stop_date=2020.01.01" \

Use this endpoint to activate dunning stop service.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/dunning_stop

Attribute Type Description
dunning_stop_type mandatory values: manual or external
dunning_stop_date optional Date on which you want to stop the manual dunning stop
Optional, only for manual dunning stop

Remove Dunning Stop for Journal Entry

curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/dunning_stop" \
  -H "Authorization: Token token=YOUR-API-TOKEN"
  -d "dunning_stop_type=external" \

Use this endpoint to deactivate dunning stop service.

API Endpoint

DELETE https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/dunning_stop

Attribute Type Description
dunning_stop_type mandatory values: manual or external

Clearings

Clearing Object

{
    "data": {
        "id": "<clearing-id>",
        "type": "clearing",
        "attributes": {
            "id": "<clearing-id>",
            "booked_at": "2001-01-01T01:00:00.000+01:00",
            "clearing_type": "balanced",
            "receipt_number": "abc1234",
            "created_at": "2020-05-15T15:53:44+02:00",
            "updated_at": "2020-05-15T15:53:44+02:00"
        },
        "relationships": {
            "journal_entries": {
                "data": [
                    [0] {
                        "id": "<journal-entry-id>",
                        "type": "journal_entry"
                    },
                    [1] {
                        "id": "<journal-entry-id>",
                        "type": "journal_entry"
                    }
                ],
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>/journal_entries"
                }
            },
            "erp_file": {
                "data": [],
                "links": {
                    "self": "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>",
                    "related": "https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>"
                }
            }
        }
    }
}
Attribute Type Description
id string Bilendo id of the clearing
Example: 00000000-0000-0000-0000-000000000000
booked_at datetime Booked date and time
clearing_type string values: balanced, unbalanced
receipt_number string Receipt number of Journal entry

Get All Clearings

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/clearings" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the clearings.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/clearings

{
    "data": [
        {
            "id": "<clearing-id>",
            "type": "clearing",
            "attributes": {
                "id": "<clearing-id>",
                "booked_at": "2001-01-01T01:00:00.000+01:00",
                "clearing_type": "balanced",
                "receipt_number": "abc1234",
                "created_at": "2020-05-15T15:53:44+02:00",
                "updated_at": "2020-05-15T15:53:44+02:00"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/clearings?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/clearings?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/clearings?page=1"
    }
}

Create new Clearings

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/clearings" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "clearing_number=abc1234" \
  -d "journal_entry_ids=[<journal_entry1_id>, <journal_entry2_id>]" \

This endpoint allows you to create a clearing for the journal entries provided.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/clearings

Parameter Type Description
clearing_number mandatory Clearing Number.
journal_entry_ids mandatory Array of Journal Entry Ids

Get a specific Clearing

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display all the information of a clearing.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>

Delete a specific Clearing

curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to delete a clearing.

API Endpoint

DELETE https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>

Get all Journal Entires of a specific Clearing

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>/journal_entries" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to list all the journal entries of a clearing.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>/journal_entries

ERP Files

ERP File Object

{
    "data": {
        "id": "<erp-file-id>",
        "type": "erp_file",
        "attributes": {
            "id": "<erp-file-id>",
            "imported_file": {
                "url": "<link-to-file>"
            },
            "created_at": "2020-05-15T17:35:00+02:00",
            "updated_at": "2020-05-15T17:35:00+02:00"
        }
    }
}
Attribute Type Description
id string Bilendo id of the ERP file
Example: 00000000-0000-0000-0000-000000000000
imported_file file your ERP file

Get All ERP Files

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/erp_files" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the ERP files for a company.

API Endpoint

GET https://api.bilendo.de/api/v2/erp_files

{
    "data": [
        {
            "id": "<erp-file-id>",
            "type": "erp_file",
            "attributes": {
                "id": "<erp-file-id>",
                "imported_file": {
                    "url": "<link-to-file>"
                },
                "created_at": "2020-05-15T17:35:00+02:00",
                "updated_at": "2020-05-15T17:35:00+02:00"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/erp_files?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/erp_files?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/erp_files?page=1"
    }
}

Create new ERP File

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/erp_files" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "imported_file=customer.xlsx" \

This endpoint allows you to upload an ERP file.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/erp_files

Parameter Type Description
imported_file mandatory your ERP file

Get a specific ERP File

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display the details of an ERP file.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>

Delete a specific ERP File

curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to delete an ERP file.

API Endpoint

DELETE https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>

Media Files

Media File Object

{
    "data": {
        "id": "<media-file-id>",
        "type": "media_file",
        "attributes": {
            "id": "<media-file-id>",
            "purpose": "text",
            "file": {
                "url": "<link-to-file>"
            },
            "created_at": "2020-05-15T17:35:00+02:00",
            "updated_at": "2020-05-15T17:35:00+02:00"
        }
    }
}
Attribute Type Description
id string Bilendo id of the media file
Example: 00000000-0000-0000-0000-000000000000
purpose string purpose of the file upload
file file your file for journal entry.
Supported format: PDF, XML, PNG, JPG, JPEG

Get All Media Files

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \

This endpoint will display all the media files for a journal entry.

API Endpoint

GET https://api.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files

{
    "data": [
        {
            "id": "<media-file-id>",
            "type": "media_file",
            "attributes": {
                "id": "<media-file-id>",
                "purpose": "text",
                "file": {
                    "url": "<link-to-file>"
                },
                "created_at": "2020-05-15T17:35:00+02:00",
                "updated_at": "2020-05-15T17:35:00+02:00"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files?page=1"
    }
}

Create new Media File

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "file=customer.pdf" \

This endpoint allows you to upload media file for a journal entry.

API Endpoint

POST https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files

Parameter Type Description
purpose optional purpose of the file upload
file mandatory your file for journal entry

Update existing Media File

curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -d "file= new_file.pdf" \

This endpoint allows you to update a media file for a journal entry.

API Endpoint

PATCH https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>

Parameter Type Description
purpose optional purpose of the file upload
file mandatory you file for journal entry

Get a specific Media File

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

This endpoint will display the media file for a journal entry.

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>

Delete a specific Media File

curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

Use this endpoint to delete a media file of a journal entry.

API Endpoint

DELETE https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>

Template Emails

Template email (German: E-Mail-Design Vorlagen) are used to define the design of invoices and reminders emails.

Template Email Object

{
    "data": {
        "id": "<template-email-id>",
        "type": "template_email",
        "attributes": {
            "id": "<template-email-id>",
            "title": "Standard"
        }
    }
}
Attribute Type Description
id string Bilendo id of the template email
Example: 00000000-0000-0000-0000-000000000000
title string The name of the template

Get Template Emails

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_emails" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_emails

{
    "data": [
        {
            "id": "<template-email-id>",
            "type": "template_email",
            "attributes": {
                "id": "<template-email-id>",
                "title": "Standard"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/template_emails?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/template_emails?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/template_emails?page=1"
    }
}

Get a specific Template Email

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>

Template Invoices

Template invoices (German: Rechnungs- und Mahnungsvorlagen) are used to define the behaviour of invoices and reminders.

Template Invoice Object

{
    "data": {
        "id": "<template-invoice-id>",
        "type": "template_invoice",
        "attributes": {
            "id": "<template-invoice-id>",
            "title": "Standard"
        }
    }
}
Attribute Type Description
id string Bilendo id of the template invoice
Example: 00000000-0000-0000-0000-000000000000
title string The name of the template

Get Template Invoices

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_invoices" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_invoices

{
    "data": [
        {
            "id": "<template-invoice-id>",
            "type": "template_invoice",
            "attributes": {
                "id": "<template-invoice-id>",
                "title": "Standard"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/template_invoices?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/template_invoices?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/template_invoices?page=1"
    }
}

Get a specific Template Invoice

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>

Template Posts

Template posts (German: Post-Design Vorlagen) are used to define the design of reminders PDF files for postal shipping.

Template Post Object

{
    "data": {
        "id": "<template-post-id>",
        "type": "template_post",
        "attributes": {
            "id": "<template-post-id>",
            "title": "Standard"
        }
    }
}
Attribute Type Description
id string Bilendo id of the template post
Example: 00000000-0000-0000-0000-000000000000
title string The name of the template

Get Template Posts

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_posts" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_posts

{
    "data": [
        {
            "id": "<template-post-id>",
            "type": "template_post",
            "attributes": {
                "id": "<template-post-id>",
                "title": "Standard"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/template_posts?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/template_posts?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/template_posts?page=1"
    }
}

Get a specific Template Post

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>

Template Settings

Template settings (German: Modulvorlagen) are used to define the behaviour of Bilendo's modules, Skonto settings and Inkasso Connection.

Template Setting Object

{
    "data": {
        "id": "<template-setting-id>",
        "type": "template_setting",
        "attributes": {
            "id": "<template-setting-id>",
            "title": "Standard",
            "description": "Ihre Standardvorlage"
        }
    }
}
Attribute Type Description
id string Bilendo id of the template setting
Example: 00000000-0000-0000-0000-000000000000
title string The name of the template
description text A description of the template

Get Template Settings

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_settings" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_settings

{
    "data": [
        {
            "id": "<template-setting-id>",
            "type": "template_setting",
            "attributes": {
                "id": "<template-setting-id>",
                "title": "Standard",
                "description": "Ihre Standardvorlage"
            }
        }
    ],
    "meta": {
        "total_pages": 1,
        "total_entries": 1,
        "per_page": 100
    },
    "links": {
        "self": "https://apisandbox.bilendo.de/api/v2/template_settings?page=1",
        "first": "https://apisandbox.bilendo.de/api/v2/template_settings?page=1",
        "prev": null,
        "next": null,
        "last": "https://apisandbox.bilendo.de/api/v2/template_settings?page=1"
    }
}

Get a specific Template Setting

curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>" \
  -H "Authorization: Token token=YOUR-API-TOKEN"

API Endpoint

GET https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>

Errors

HTTP Status

The Bilendo API uses the following HTTP error status codes:

Status Code Meaning
400 Bad Request Your request sucks
401 Unauthorized Your API token is wrong
403 Forbidden The server understood the request but refuses to authorize it
404 Not Found The specified object could not be found
405 Method Not Allowed You tried to access our API with an invalid method
406 Not Acceptable You requested a format that isn't json
410 Gone The object requested has been removed from our servers
412 Precondition Failed The server does not meet one of the preconditions that the requester put on the request
418 I'm a teapot
422 Unprocessable Entity The object is not valid
429 Too Many Requests You're requesting too many objects! Slow down!
500 Internal Server Error We had a problem with our server. Try again later.
503 Service Unavailable We're temporarially offline for maintanance. Please try again later.

Bilendo Error Codes

# Scenario: Creating a new customer with an existing name, customer_number and external _id

curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers/" \
  -H "Authorization: Token token=YOUR-API-TOKEN" \
  -H "Content-Type: multipart/form-data" \
  -F "customer_number=<existing-customer-number>" \
  -F "external_id=<existing-external-id>" \
  -F "name=<existing-name>" \
Error Code Object Meaning
1000 Customer The customer name cannot be blank
1001 Customer The provided customer name already exists
1002 Customer The customer number already exists
1003 Customer The provided customer external_id already exists
1004 Customer The provided customer cannot be found
1005 Customer The provided customers group cannot be found
1003 Contact The external id already exists
1006 Address The address already exists
{
  "error": [
    {
      "name": {
        "title": "Es existiert bereits ein Kunde mit diesem Namen.",
        "code": 1001
      }
    },
    {
      "customer_number": {
        "title": "Es existiert bereits ein Kunde mit dieser Kundennummer.",
        "code": 1002
      }
    },
    {
      "external_id": {
        "title": "Es existiert bereits ein Kunde mit dieser externen ID.",
        "code": 1003
      }
    }
  ]
}