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
Sandbox
You can request a developer account via email 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 retrieve your API token from your Bilendo account under 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>",
"name": "New Company",
"customer_number": "07254383",
"additional_number": "20002",
"phone": "123456",
"notice": "Lorem Ipsum",
"dunning_stop": false,
"external_dunning_stop_date": null,
"dunning_stop_date": null,
"enforce_shipping_mode": false,
"letters_shipping_via_email": null,
"letters_shipping_via_post": null,
"media_files_shipping_via_email": null,
"media_files_shipping_via_post": null,
"reminders_shipping_via_email": null,
"reminders_shipping_via_post": null,
"revenue": "314715.0",
"saldo": "314715.0",
"credit_limit": "5000.0",
"current_reminder_stage": 0,
"historical_max_reminder_stage": 3,
"customer_group_id": null,
"template_setting_id": "<template-setting-id>",
"template_invoice_id": "<template-invoice-id>",
"template_email_id": "<template-email-id>",
"template_post_id": "<template-post-id>",
"external_creation_date": null,
"external_id_allianz": null,
"external_id_atradius": null,
"external_id_coface": null,
"external_id_coface_icon": null,
"external_id_creditreform": null,
"external_id_creditsafe": null,
"external_id_dd_monitor": null,
"external_id_dun_n_bradstreet": null,
"external_parent_id": null,
"external_user_id": "<your-user-id>",
"vat_reg_number": null,
"custom_fields": {},
"created_at": "2024-03-04T07:49:19+01:00",
"updated_at": "2024-03-04T07:53:32+01:00"
},
"relationships": {
"addresses": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
"related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses"
}
},
"contacts": {
"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 | UUID | Bilendo ID of the customer Example: 00000000-0000-0000-0000-000000000000 |
| external_id | string | Your ID for the customer |
| name | string | Name of the customer |
| customer_number | string | Customer number |
| additional_number | string | Optional additional customer number |
| phone | string | Phone number of the customer |
| notice | string | Optional note |
| dunning_stop | boolean | Prevents reminders |
| external_dunning_stop_date | date | Date until the dunning stop is valid |
| dunning_stop_date | date | The dunning stop ends on this date |
| enforce_shipping_mode | boolean | When true, takes shipping information from the customer itself and discards all shipping settings from templates. |
| letters_shipping_via_email | boolean | Letter shipping via email |
| letters_shipping_via_post | boolean | Letter shipping via post |
| media_files_shipping_via_email | boolean | Media file shipping via email |
| media_files_shipping_via_post | boolean | Media file shipping via post |
| reminders_shipping_via_email | boolean | Reminder shipping via email |
| reminders_shipping_via_post | boolean | Reminder shipping via post |
| revenue | string | The total revenue |
| saldo | string | The current saldo |
| credit_limit | string | Current credit limit of the customer |
| current_reminder_stage | integer | Current reminder stage |
| historical_max_reminder_stage | integer | Highest reminder stage in the past |
| customer_group_id | UUID | The customer's group ID |
| template_setting_id | UUID | The customer's template setting ID |
| template_invoice_id | UUID | The customer's template invoice ID |
| template_email_id | UUID | The customer's template email ID |
| template_post_id | UUID | The customer's template post ID |
| external_creation_date | datetime | Date and time of creation from external source |
| external_id_allianz | string | External ID for Allianz |
| external_id_atradius | string | External ID for Atradius |
| external_id_coface | string | External ID for Coface |
| external_id_coface_icon | string | External ID for Coface Icon |
| external_id_creditreform | string | This ID will be used to get credit information for the customer from Creditreform (service scoring and risk should be enabled first) |
| external_id_creditsafe | string | External ID for Creditsafe |
| external_id_dd_monitor | string | This ID will be used to get credit information for the customer from DD Monitor (service scoring and risk should be enabled first) |
| external_id_dun_n_bradstreet | string | External ID for Dun & Bradstreet |
| external_parent_id | string | External parent ID |
| external_user_id | string | External user ID |
| vat_reg_number | string | VAT registration number |
| custom_fields | object | Additional custom fields for the customer |
| created_at | datetime | Datetime of creation |
| updated_at | datetime | Datetime of last update |
customers#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all customers.
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>",
"name": "New Company",
"customer_number": "07254383",
"additional_number": "20002",
"phone": "123456",
"notice": "Lorem Ipsum",
"dunning_stop": false,
"external_dunning_stop_date": null,
"dunning_stop_date": null,
"enforce_shipping_mode": false,
"letters_shipping_via_email": null,
"letters_shipping_via_post": null,
"media_files_shipping_via_email": null,
"media_files_shipping_via_post": null,
"reminders_shipping_via_email": null,
"reminders_shipping_via_post": null,
"revenue": "314715.0",
"saldo": "314715.0",
"credit_limit": "5000.0",
"current_reminder_stage": 0,
"historical_max_reminder_stage": 3,
"customer_group_id": null,
"template_setting_id": "<template-setting-id>",
"template_invoice_id": "<template-invoice-id>",
"template_email_id": "<template-email-id>",
"template_post_id": "<template-post-id>",
"external_creation_date": null,
"external_id_allianz": null,
"external_id_atradius": null,
"external_id_coface": null,
"external_id_coface_icon": null,
"external_id_creditreform": null,
"external_id_creditsafe": null,
"external_id_dd_monitor": null,
"external_id_dun_n_bradstreet": null,
"external_parent_id": null,
"external_user_id": "<your-user-id>",
"vat_reg_number": null,
"custom_fields": {},
"created_at": "2024-03-04T07:49:19+01:00",
"updated_at": "2024-03-04T07:53:32+01:00"
},
"relationships": {
"addresses": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>",
"related": "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses"
}
},
"contacts": {
"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"
}
}
customers#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "external_id=<your-customer-id>" \
-d "external_user_id=<your-user-id>" \
-d "name=New Company" \
-d "customer_number=10001" \
-d "additional_number=20002" \
-d "phone=123456" \
-d "notice=Lorem Ipsum" \
-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>"
Creates a new customer.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/customers
| Attribute | Type | Description |
|---|---|---|
| external_id | optional | Your ID for the customer |
| external_user_id | optional | Your ID for the user |
| external_id_creditreform | optional | Creditreform number of the customer |
| external_id_dd_monitor | optional | DD-Monitor number of the customer |
| customer_number | mandatory | 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 |
| customer_group_id | optional | The customer's group ID |
| 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 |
customers#update
curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "name=New Companyname Inc." \
Updates an existing customer.
API Endpoint
PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>
| Attribute | Type | Description |
|---|---|---|
| external_id | optional | Your ID for the customer |
| external_user_id | optional | Your ID for the user. To remove a user from the customer, leave this field blank. |
| 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 |
| customer_group_id | optional | The customer's group ID |
| 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 |
customers#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific customer.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>
customers#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/find/<your-customer-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a customer using your external ID.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/find/<your-customer-id>
customers/dunning_stop#create
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"
Adds 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 the manual dunning stop should end. Only applicable for manual dunning stops. |
customers/dunning_stop#delete
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"
Deactivates a dunning stop.
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 |
customers/credit_limit#update
curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/credit_limit" \
-H "Authorization: Token token=YOUR-API-TOKEN"
-d "amount=1000.0"
Sets the credit limit for a customer. To remove an existing credit limit, provide an empty string as the value.
API Endpoint
PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/credit_limit
| Attribute | Type | Description |
|---|---|---|
| amount | mandatory | Credit limit amount or null |
Contacts
Contact Object
{
"data": {
"id": "<contact-id>",
"type": "contact",
"attributes": {
"id": "<contact-id>",
"external_id": "<your-contact-id>",
"name": "John",
"gender": "male",
"email": "john@bilendo.de",
"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 | UUID | Bilendo ID of the contact Example: 00000000-0000-0000-0000-000000000000 |
| external_id | string | Your ID for the contact |
| name | string | Name of the contact |
| gender | string | unknownmalefemalefamily |
| string | Email address | |
| phone | string | Phone number of the contact |
| main_contact | boolean | true = main contactfalse = not main contact |
contacts#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all contacts for a customer.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts
{
"data": [
{
"id": "<contact-id>",
"type": "contact",
"attributes": {
"id": "<contact-id>",
"external_id": "<your-contact-id>",
"name": "John",
"gender": "male",
"email": "john@bilendo.de",
"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"
}
}
contacts#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "external_id=<your-contact-id>" \
-d "name=John" \
-d "gender=male" \
-d "phone=0123456789" \
-d "email=john@bilendo.de"
Creates a new contact for a customer.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts
| Attribute | Type | Description |
|---|---|---|
| external_id | optional | Your contact ID |
| name | optional | Name of the contact |
| gender | mandatory | One of the following values:unknownmalefemalefamily |
| phone | optional | Phone number of the contact |
| optional | Email address of the contact | |
| main_contact | optional | true = make this contact the main contactfalse = make this contact not a main contact |
contacts#update
curl -X "PATCH" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "name=New name"
Updates an existing contact for a customer.
API Endpoint
PATCH https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>
| Attribute | Type | Description |
|---|---|---|
| external_id | optional | Your contact ID |
| name | optional | Name of the contact |
| gender | mandatory | One of the following values:unknownmalefemalefamily |
| phone | optional | Phone number of the contact |
| optional | Email address of the contact | |
| main_contact | optional | true = make this contact the main contactfalse = make this contact not a main contact |
contacts#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific contact for a customer.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/<contact-id>
contacts#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/contacts/find/<your-contact-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a contact using your external 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>",
"line1": "New GmbH",
"line2": null,
"line3": "Sendlinger Str. 85",
"line4": null,
"street": "Sendlinger Str.",
"house_number": "85",
"zip": "81735",
"city": "Munich",
"region": "Bayern",
"country": "Deutschland",
"default_address": true,
"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/<customer-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the address Example: 00000000-0000-0000-0000-000000000000 |
| external_id | string | Your ID for 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) |
| street | string | Customer's street |
| house_number | string | Customer's house number |
| zip | string | Customer's zip code |
| city | string | Customer's city |
| region | string | Customer's region |
| country | string | Customer's country |
| default_address | boolean | true = default addressfalse = not default address |
addresses#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Returns a list of all 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>",
"line1": "New GmbH",
"line2": null,
"line3": "Sendlinger Str. 85",
"line4": null,
"street": "Sendlinger Str.",
"house_number": "85",
"zip": "81735",
"city": "Munich",
"region": "Bayern",
"country": "Deutschland",
"default_address": true,
"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/<customer-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"
}
}
addresses#create
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 "region=Bayern" \
-d "country_code=de"
Creates 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 for 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) |
| street | optional | Customer's street |
| house_number | optional | Customer's house number |
| zip | mandatory | Customer's zip code |
| city | mandatory | Customer's city |
| region | optional | Customer's region |
| country_code | optional | Customer's ISO country code |
| country | optional | Customer's country name |
| default_address | optional | true = default addressfalse = not default address |
Important: Either country_code or country is mandatory.
addresses#update
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"
Updates an existing 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 for 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) |
| street | optional | Customer's street |
| house_number | optional | Customer's house number |
| zip | mandatory | Customer's zip code |
| city | mandatory | Customer's city |
| region | optional | Customer's region |
| country_code | optional | Customer's ISO country code |
| country | optional | Customer's country name |
| default_address | optional | true = default addressfalse = not default address |
Important: Either country_code or country is mandatory.
addresses#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific address for a customer.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/<address-id>
addresses#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/find/<your-address-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves an address using your external ID.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customers/<customer-id>/addresses/find/<your-address-id>
Customer Groups
Customer Group Object
{
"data": {
"id": "<customer_group-id>",
"type": "customer_group",
"attributes": {
"id": "<customer-group-id>",
"external_ids": ["cg-123", "cg-456"],
"name": "Example Group",
"description": "This is Customer Group one"
},
"relationships": {
"customers": {
"data": [],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
"related": "https://apisandbox.bilendo.de/api/v2/customers?customer_group_id=<customer-group-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the customer group Example: 00000000-0000-0000-0000-000000000000 |
| external_ids | array | Array of external customer group IDs Example: ["cg-123", "cg-456"] |
| name | text | The name of the customer group |
| description | text | The description of the customer group |
customer_groups#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all customer groups.
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_ids": ["cg-123", "cg-456"],
"name": "Example Group",
"description": "Lorem ipsum"
},
"relationships": {
"customers": {
"data": [],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>",
"related": "https://apisandbox.bilendo.de/api/v2/customers?customer_group_id=<customer-group-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"
}
}
customer_groups#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific customer group.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>
customer_groups#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/customer_groups/find/<your-customer-group-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a customer group using your external ID.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/customer_groups/find/<your-customer-group-id>
customer_groups#add
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>"
]}'
| Attribute | Type | Description |
|---|---|---|
| customers | mandatory | Array of customer IDs |
Adds customers to a customer group.
API Endpoint
PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/add
customer_groups#remove
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>"
]}'
| Attribute | Type | Description |
|---|---|---|
| customers | mandatory | Array of customer IDs |
Removes customers from a customer group.
API Endpoint
PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/remove
Journal Entries (BETA)
Journal Entry Object
{
"data": {
"id" : "<journal-entry-id>",
"type" : "journal_entry",
"attributes" : {
"id": "<journal-entry-id>",
"external_id": "1234567890",
"amount": "123.45",
"currency": "EUR",
"journal_type": "receivable",
"invoice_number": null,
"receipt_date": "1998-01-28",
"due_date": "1998-02-19",
"external_doctype": "SaP123",
"external_difference_reason": null,
"notice": null,
"external_notice": null,
"text": "This is a journal entry",
"reminder_stage": 0,
"dunning_stop": false,
"dunning_stop_date": null,
"external_dunning_stop_date": null,
"open_amount": "100.15",
"net_amount": "123.45",
"tax_amount": "5.30",
"custom_fields": {
"additional_info": "additional info",
"more_info": "more info"
},
"created_at": "2020-06-03T14:18:27+02:00",
"external_creation_date": null,
"external_amount": 100.15,
"external_currency": "EUR",
"updated_at": "2020-06-03T14:18:27+02:00"
},
"relationships": {
"customer": {
"data": {
"id": "<customer-id>",
"type": "customer"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/customers/<customer-id>"
}
},
"clearing": {
"data": {
"id": "<clearing-id>",
"type": "clearing"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/clearings/<clearing-id>"
}
},
"area": {
"data": {
"id": "<area-id>",
"type": "area"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/areas/<area-id>"
}
},
"business_unit": {
"data": {
"id": "<business_unit-id>",
"type": "business_unit"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/business_units/<business_unit-id>"
}
},
"service_user": {
"data": {
"id": "<service_user-id>",
"type": "service_user"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/service_users/<service_user-id>"
}
},
"user": {
"data": {
"id": "<user-id>",
"type": "user"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/users/<user-id>"
}
},
"sales_unit": {
"data": {
"id": "<sales_unit-id>",
"type": "sales_unit"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/sales_units/<sales_unit-id>"
}
},
"media_files": {
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>/media_files"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the journal entry Example: 00000000-0000-0000-0000-000000000000 |
| external_id | string | Unique external ID of the journal entry |
| amount | decimal | |
| currency | string | |
| journal_type | string | |
| invoice_number | string | |
| receipt_date | date | The date of the document |
| due_date | date | |
| external_doctype | string | |
| external_difference_reason | string | |
| notice | string | Optional note |
| external_notice | string | |
| external_amount | decimal | |
| external_currency | string | |
| text | string | |
| reminder_stage | integer | The current reminder stage |
| dunning_stop | boolean | Prevents reminders |
| dunning_stop_date | date | The dunning stop ends on this date |
| external_dunning_stop_date | date | Dunning stop date in the external system |
| open_amount | decimal | |
| net_amount | decimal | |
| tax_amount | decimal | |
| external_creation_date | date | Date of creation from external source |
| custom_fields | object |
journal_entries#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Returns a list of all journal entries.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/journal_entries
{
"data": [
{
"id" : "<journal-entry-id>",
"type" : "journal_entry",
"attributes" : {
"id": "<journal-entry-id>",
"external_id": "1234567890",
"amount": "123.45",
"currency": "EUR",
"journal_type": "receivable",
"invoice_number": null,
"receipt_date": "1998-01-28",
"due_date": "1998-02-19",
"external_doctype": "SaP123",
"external_difference_reason": null,
"notice": null,
"external_notice": null,
"text": "This is a journal entry",
"reminder_stage": 0,
"dunning_stop": false,
"dunning_stop_date": null,
"external_dunning_stop_date": null,
"open_amount": "100.15",
"net_amount": "123.45",
"tax_amount": "5.30",
"custom_fields": {
"additional_info": "additional info",
"more_info": "more info"
},
"created_at": "2020-06-03T14:18:27+02:00",
"external_creation_date": null,
"external_amount": 100.15,
"external_currency": "EUR",
"updated_at": "2020-06-03T14:18:27+02:00"
},
"relationships": {
"customer": {
"data": {
"id": "<customer-id>",
"type": "customer"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/customers/<customer-id>"
}
},
"clearing": {
"data": {
"id": "<clearing-id>",
"type": "clearing"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/clearings/<clearing-id>"
}
},
"area": {
"data": {
"id": "<area-id>",
"type": "area"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/areas/<area-id>"
}
},
"business_unit": {
"data": {
"id": "<business_unit-id>",
"type": "business_unit"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/business_units/<business_unit-id>"
}
},
"service_user": {
"data": {
"id": "<service_user-id>",
"type": "service_user"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/service_users/<service_user-id>"
}
},
"user": {
"data": {
"id": "<user-id>",
"type": "user"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/users/<user-id>"
}
},
"sales_unit": {
"data": {
"id": "<sales_unit-id>",
"type": "sales_unit"
},
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/sales_units/<sales_unit-id>"
}
},
"media_files": {
"links": {
"self": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>",
"related": "https://localhost:3000/api/v2/journal_entries/<journal-entry-id>/media_files"
}
}
}
}
],
"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"
}
}
journal_entries#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific journal entry.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>
journal_entries#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/find/<external-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves one or multiple journal entries using external IDs.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/journal_entries/find/<external-id>
journal_entries/dunning_stop#create
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"
Activates a dunning stop on a journal entry.
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 the manual dunning stop should end. Only applicable for manual dunning stops. |
journal_entries/dunning_stop#delete
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" \
Deactivates a dunning stop on a journal entry.
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 (BETA)
Clearing Object
{
"data": {
"id": "<clearing-id>",
"type": "clearing",
"attributes": {
"id": "<clearing-id>",
"clearing_type": "balanced",
"clearing_number": "abc1234",
"created_at": "2020-05-15T15:53:44+02:00",
"updated_at": "2020-05-15T15:53:44+02:00"
},
"relationships": {
"journal_entries": {
"data": [
{
"id": "<journal-entry-id>",
"type": "journal_entry"
},
{
"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/journal_entries?jes_clearing_id=<clearing-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the clearing Example: 00000000-0000-0000-0000-000000000000 |
| clearing_type | string | Values: balanced, unbalanced |
| clearing_number | string | Receipt number of the journal entry |
clearings#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/clearings" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all clearings.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/clearings
{
"data": [
{
"id": "<clearing-id>",
"type": "clearing",
"attributes": {
"id": "<clearing-id>",
"clearing_type": "balanced",
"clearing_number": "abc1234",
"created_at": "2020-05-15T15:53:44+02:00",
"updated_at": "2020-05-15T15:53:44+02:00"
},
"relationships": {
"journal_entries": {
"data": [
{
"id": "<journal-entry-id>",
"type": "journal_entry"
},
{
"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/journal_entries?jes_clearing_id=<clearing-id>"
}
}
}
}
],
"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"
}
}
clearings#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific clearing.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>
ERP Files
ERP File Object
{
"data": {
"id": "<erp-file-id>",
"type": "erp_file",
"attributes": {
"id": "<erp-file-id>",
"file_type": "customer_file",
"processing_status": "done",
"rows_count": 123,
"file": {
"url": "<url-of-file>"
},
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the ERP file Example: 00000000-0000-0000-0000-000000000000 |
| file_type | string | Values: customer_file, journal_file, or unknown |
| processing_status | string | Values: waiting, in_progress, done, or canceled |
| rows_count | integer | Number of rows in the file |
| file | URL | URL of the uploaded file |
erp_files#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/erp_files" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Returns a list of all ERP files.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/erp_files
{
"data": [
{
"id": "<erp-file-id>",
"type": "erp_file",
"attributes": {
"id": "<erp-file-id>",
"file_type": "customer_file",
"processing_status": "done",
"rows_count": 123,
"file": {
"url": "<url-of-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"
}
}
erp_files#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/erp_files" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-F "file=@path/to/local/file.xlsx"
Uploads a new ERP file.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/erp_files
| Attribute | Type | Description |
|---|---|---|
| file | mandatory | Your ERP file |
erp_files#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific ERP file.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>
erp_files#delete
curl -X "DELETE" "https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Deletes an ERP file.
API Endpoint
DELETE https://apisandbox.bilendo.de/api/v2/erp_files/<erp-file-id>
Enhancement Files
Enhancement File Object
{
"data": {
"id": "<enhancement-file-id>",
"type": "enhancement_file",
"attributes": {
"id": "<enhancement-file-id>",
"status": "processed",
"custom_enhancer": "Dummy",
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00",
"filename": "<name-of-file>"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the enhancement file Example: 00000000-0000-0000-0000-000000000000 |
| filename | string | File name |
| custom_enhancer | string | Name of the enhancer |
| status | string | pending, processed |
enhancement_files#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/enhancement_files" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Returns a list of all enhancement files.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/enhancement_files
{
"data": [
{
"id": "<enhancement-file-id>",
"type": "enhancement_file",
"attributes": {
"id": "<enhancement-file-id>",
"status": "processed",
"custom_enhancer": "dummy",
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00",
"filename": "<name-of-file>"
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/enhancement_files?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/enhancement_files?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/enhancement_files?page=1"
}
}
enhancement_files#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/enhancement_files" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-F "file=@path/to/local/file.xlsx"
Uploads a new enhancement file.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/enhancement_files
| Attribute | Type | Description |
|---|---|---|
| file | mandatory | Your enhancement file |
| custom_enhancer | mandatory | Talk to the onboarding team |
enhancement_files#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/enhancement_files/<enhancement-file-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific enhancement file.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/enhancement_files/<enhancement-file-id>
Media Files
Media File Object
{
"data": {
"id": "<media-file-id>",
"type": "media_file",
"attributes": {
"id": "<media-file-id>",
"file": {
"url": "<link-to-file>"
},
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00"
},
"relationships": {
"media_file_type": {
"data": [
{
"id": "<media-file-type-id>",
"type": "media_file_type"
}
],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/media_file_types/<media-file-type-id>"
}
},
"journal_entry": {
"data": [
{
"id": "<journal-entry-id>",
"type": "journal_entry"
}
],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the media file Example: 00000000-0000-0000-0000-000000000000 |
| file | URL | URL of the uploaded file |
media_files#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all media files for a journal entry.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files
{
"data": [
{
"id": "<media-file-id>",
"type": "media_file",
"attributes": {
"id": "<media-file-id>",
"file": {
"url": "<link-to-file>"
},
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00"
},
"relationships": {
"media_file_type": {
"data": [
{
"id": "<media-file-type-id>",
"type": "media_file_type"
}
],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/media_file_types/<media-file-type-id>"
}
},
"journal_entry": {
"data": [
{
"id": "<journal-entry-id>",
"type": "journal_entry"
}
],
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>"
}
}
}
}
],
"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"
}
}
media_files#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-F "file=@path/to/local/file.pdf"
Uploads a new media file for a journal entry.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files
| Attribute | Type | Description |
|---|---|---|
| file | mandatory | The media file |
| media_file_type_id | optional | The Bilendo ID of the media file type |
media_files#show
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"
Retrieves a specific 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>
media_files#delete
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"
Deletes a media file for a journal entry.
API Endpoint
DELETE https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id>/media_files/<media-file-id>
Media File Types
Media File Type Object
{
"data": {
"id": "<media-file-type-id>",
"type": "media_file_type",
"attributes": {
"id": "<media-file-type-id>",
"name": "text",
"description": "text",
"created_at": "2021-05-15T17:35:00+02:00",
"updated_at": "2021-05-15T17:35:00+02:00"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the media file type Example: 00000000-0000-0000-0000-000000000000 |
| name | string | Name of the media file type |
| description | text | Description of the media file type |
media_file_types#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/media_file_types" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Returns a list of all media file types.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/media_file_types
{
"data": [
{
"id": "<media-file-type-id>",
"type": "media_file_type",
"attributes": {
"id": "<media-file-type-id>",
"name": "text",
"description": "text",
"created_at": "2021-05-15T17:35:00+02:00",
"updated_at": "2021-05-15T17:35:00+02:00"
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/media_file_types?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/media_file_types?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/media_file_types?page=1"
}
}
media_file_types#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/media_file_types/<media-file-type-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
Retrieves a specific media file type.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/media_file_types/<media-file-type-id>
{
"data": {
"id": "<media-file-type-id>",
"type": "media_file_type",
"attributes": {
"id": "<media-file-type-id>",
"name": "text",
"description": "text",
"created_at": "2021-05-15T17:35:00+02:00",
"updated_at": "2021-05-15T17:35:00+02:00"
}
}
}
Template Emails
Template emails are used to define the design of letter, media file, and reminder emails.
Template Email Object
{
"data": {
"id": "<template-email-id>",
"type": "template_email",
"attributes": {
"id": "<template-email-id>",
"title": "Standard"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the template email Example: 00000000-0000-0000-0000-000000000000 |
| title | string | The name of the template |
template_emails#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_emails" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all template emails.
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"
}
}
template_emails#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific template email.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>
Template Invoices
Template invoices are used to define the behavior of media files and reminders.
Template Invoice Object
{
"data": {
"id": "<template-invoice-id>",
"type": "template_invoice",
"attributes": {
"id": "<template-invoice-id>",
"title": "Standard"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the template invoice Example: 00000000-0000-0000-0000-000000000000 |
| title | string | The name of the template |
template_invoices#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_invoices" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all template invoices.
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"
}
}
template_invoices#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific template invoice.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_invoices/<template-invoice-id>
Template Posts
Template posts are used to define the design of letter and reminder 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 | UUID | Bilendo ID of the template post Example: 00000000-0000-0000-0000-000000000000 |
| title | string | The name of the template |
template_posts#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_posts" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all template posts.
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"
}
}
template_posts#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific template post.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>
Template Settings
Template settings are used to define the behavior of Bilendo's modules such as shipping and automatic dunning.
Template Setting Object
{
"data": {
"id": "<template-setting-id>",
"type": "template_setting",
"attributes": {
"id": "<template-setting-id>",
"title": "Standard"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the template setting Example: 00000000-0000-0000-0000-000000000000 |
| title | string | The name of the template |
template_settings#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_settings" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all template settings.
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"
}
}
],
"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"
}
}
template_settings#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific template setting.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>
Areas
Areas are organizational structure objects.
Area Object
{
"data": {
"id": "<area-id>",
"type": "area",
"attributes": {
"id": "<area-id>",
"external_ids": ["ar-123", "ar-456"],
"name": "Example Area",
"description": "This is Area one"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the area Example: 00000000-0000-0000-0000-000000000000 |
| external_ids | array | Array of external area IDs Example: ["ar-123", "ar-456"] |
| name | text | The name of the area |
| description | text | The description of the area |
areas#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/areas" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all areas.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/areas
{
"data": [
{
"id": "<area-id>",
"type": "area",
"attributes": {
"id": "<area-id>",
"external_ids": ["ar-123", "ar-456"],
"name": "Example Area",
"description": "This is Area one"
},
"relationships": {
"business_units": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/areas/<area-id>",
"related": "https://apisandbox.bilendo.de/api/v2/business_units?area_id=<area-id>"
}
},
"journal_entries": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/areas/<area-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries?jes_area_id=<area-id>"
}
}
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/areas?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/areas?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/areas?page=1"
}
}
areas#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/areas/<area-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific area.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/areas/<area-id>
Business Units
Business Units are organizational structure objects.
Business Unit Object
{
"data": {
"id": "<business_unit-id>",
"type": "business_unit",
"attributes": {
"id": "<business_unit-id>",
"external_ids": ["bu-123", "bu-456"],
"name": "Example Business Unit",
"description": "This is Business Unit one"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the business unit Example: 00000000-0000-0000-0000-000000000000 |
| external_ids | array | Array of external business unit IDs Example: ["bu-123", "bu-456"] |
| name | text | The name of the business unit |
| description | text | The description of the business unit |
business_units#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/business_units" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all business units.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/business_units
{
"data": [
{
"id": "<business_unit-id>",
"type": "business_unit",
"attributes": {
"id": "<business_unit-id>",
"external_ids": ["bu-123", "bu-456"],
"name": "Example Business Unit",
"description": "This is Business Unit one"
},
"relationships": {
"area": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/areas/<area-id>"
}
},
"sales_units": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/sales_units?business_unit_id=<business_unit-id>"
}
},
"journal_entries": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries?jes_business_unit_id=<business_unit-id>"
}
}
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/business_units?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/business_units?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/business_units?page=1"
}
}
business_units#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific business unit.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>
Sales Units
Sales Units are organizational structure objects.
Sales Unit Object
{
"data": {
"id": "<sales_unit-id>",
"type": "sales_unit",
"attributes": {
"id": "<sales_unit-id>",
"title": "Standard"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the sales unit Example: 00000000-0000-0000-0000-000000000000 |
| external_id | string | Your ID for the sales unit |
| name | string | The name of the sales unit |
| description | string | The description of the sales unit |
sales_units#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/sales_units" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all sales units.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/sales_units
{
"data": [
{
"id": "<sales_unit-id>",
"type": "sales_unit",
"attributes": {
"id": "<sales_unit-id>",
"external_id": "<your-sales_unit-id>",
"name": "Example Sales Unit",
"description": "This is Sales Unit one"
},
"relationships": {
"area": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/areas/<area-id>"
}
},
"business_unit": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>"
}
},
"service_user": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/service_user/<service-user-id>"
}
},
"journal_entries": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries?jes_sales_unit_id=<sales_unit-id>"
}
}
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/sales_units?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/sales_units?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/sales_units?page=1"
}
}
sales_units#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific sales unit.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>
Users
Users are organizational structure objects.
User Object
{
"data": {
"id": "<user-id>",
"type": "user",
"attributes": {
"id": "<user-id>",
"external_ids": [
"string"
],
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"employee_number": "string",
"description": "string",
"user_role_id": "<user-role-id>",
"user_data_access": {
"area_ids": [
"<area-id>"
],
"business_unit_ids": [
"<business-unit-id>"
],
"customer_group_ids": [
"<customer-group-id>"
],
"sales_unit_ids": [
"<sales-unit-id>"
],
"team_ids": [
"<team-id>"
]
}
},
"relationships": {
"journal_entries": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/users/<user-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries?jes_user_id=<user-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the user Example: 00000000-0000-0000-0000-000000000000 |
| external_ids | array | Array of external user IDs |
| first_name | string | The first name of the user |
| last_name | string | The last name of the user |
| string | The email address of the user | |
| phone | string | The phone number of the user |
| employee_number | string | The employee number of the user |
| description | string | The description of the user |
| user_role_id | string | Bilendo ID of the user's user role |
| user_data_access | object | Object containing Bilendo IDs of areas, business units, customer groups, sales units, and teams whose data the user can access |
users#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/users" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all users.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/users
{
"data": [
{
"id": "<user-id>",
"type": "user",
"attributes": {
"id": "<user-id>",
"external_ids": [
"abc1234"
],
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "0123456789",
"employee_number": "xyz1234",
"description": "Some text",
"user_role_id": "<user-role-id>",
"user_data_access": {
"area_ids": [
"<area-id>"
],
"business_unit_ids": [
"<business-unit-id>"
],
"customer_group_ids": [
"<customer-group-id>"
],
"sales_unit_ids": [
"<sales-unit-group-id>"
],
"team_ids": [
"<team-id>"
]
}
},
"relationships": {
"journal_entries": {
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/users/<user-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries?jes_user_id=<user-id>"
}
}
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/users?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/users?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/users?page=1"
}
}
users#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/users/<user-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific user.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/users/<user-id>
User Roles
User Roles are organizational structure objects.
User Role Object
{
"data": {
"id": "<user_role-id>",
"type": "user_role",
"attributes": {
"id": "<user_role-id>",
"name": "string",
"category": "user | user_role",
"description": "string",
"access_balance_sheet_analyses": "none | read | read_and_write",
"access_billing": "none | read | read_and_write",
"access_clarification_requests": "none | read | read_and_write",
"access_clarification_workflows": "none | read | read_and_write",
"access_clarifications": "none | read | read_and_write",
"access_credit_informations": "none | read | read_and_write",
"access_credit_limits": "none | read | read_and_write",
"access_credit_securities": "none | read | read_and_write",
"access_customers": "none | read | read_and_write",
"access_deductions": "none | read | read_and_write",
"access_draft_customers": "none | read | read_and_write",
"access_dunning_stop": "none | read | read_and_write",
"access_import_files": "none | read | read_and_write",
"access_integrations": "none | read | read_and_write",
"access_journal_entries": "none | read | read_and_write",
"access_letters": "none | read | read_and_write",
"access_media_files": "none | read | read_and_write",
"access_organization_tree": "none | read | read_and_write",
"access_promise_to_pay": "none | read | read_and_write",
"access_reminders": "none | read | read_and_write",
"access_reporting": "none | read | read_and_write",
"access_risk_alerts": "none | read | read_and_write",
"access_sales_orders": "none | read | read_and_write",
"access_sales_units": "none | read | read_and_write",
"access_scoring_and_risk": "none | read | read_and_write",
"access_scoring_and_risk_settings": "none | read | read_and_write",
"access_security": "none | read | read_and_write",
"access_settings": "none | read | read_and_write",
"access_templates": "none | read | read_and_write",
"access_user_roles": "none | read | read_and_write",
"access_users": "none | read | read_and_write"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the user role Example: 00000000-0000-0000-0000-000000000000 |
| name | string | Name of the user role |
| category | string | Type of user role (possible values: user or service_user) |
| description | string | The description of the user role |
| access_balance_sheet_analyses | string | Access level to balance sheet analyses |
| access_billing | string | Access level to billing |
| access_clarification_requests | string | Access level to clarification requests |
| access_clarification_workflows | string | Access level to clarification workflows |
| access_clarifications | string | Access level to clarifications |
| access_credit_informations | string | Access level to credit informations |
| access_credit_limits | string | Access level to credit limits |
| access_credit_securities | string | Access level to credit securities |
| access_customers | string | Access level to customers |
| access_deductions | string | Access level to deductions |
| access_draft_customers | string | Access level to draft customers |
| access_dunning_stop | string | Access level to dunning stop |
| access_import_files | string | Access level to import files |
| access_integrations | string | Access level to integrations |
| access_journal_entries | string | Access level to journal entries |
| access_letters | string | Access level to letters |
| access_media_files | string | Access level to media files |
| access_organization_tree | string | Access level to the organization tree (users, business units, areas, teams, sales units) |
| access_promise_to_pay | string | Access level to promise to pay |
| access_reminders | string | Access level to reminders |
| access_reporting | string | Access level to reporting |
| access_risk_alerts | string | Access level to risk alerts |
| access_sales_orders | string | Access level to sales orders |
| access_sales_units | string | Access level to sales units |
| access_scoring_and_risk | string | Access level to scoring and risk |
| access_scoring_and_risk_settings | string | Access level to scoring and risk settings |
| access_security | string | Access level to security settings |
| access_settings | string | Access level to all settings |
| access_templates | string | Access level to templates |
| access_user_roles | string | Access level to user roles |
| access_users | string | Access level to users |
user_roles#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/user_roles" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a list of all user roles.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/user_roles
{
"data": [
{
"id": "<user_role-id>",
"type": "user_role",
"attributes": {
"id": "<user_role-id>",
"name": "string",
"category": "user",
"description": "some text",
"access_balance_sheet_analyses": "read_and_write",
"access_billing": "read_and_write",
"access_clarification_requests": "read_and_write",
"access_clarification_workflows": "read_and_write",
"access_clarifications": "read_and_write",
"access_credit_informations": "read_and_write",
"access_credit_limits": "read_and_write",
"access_credit_securities": "read_and_write",
"access_customers": "read_and_write",
"access_deductions": "read_and_write",
"access_draft_customers": "read_and_write",
"access_dunning_stop": "read_and_write",
"access_import_files": "read_and_write",
"access_integrations": "read_and_write",
"access_journal_entries": "read_and_write",
"access_letters": "read_and_write",
"access_media_files": "read_and_write",
"access_organization_tree": "read_and_write",
"access_promise_to_pay": "read_and_write",
"access_reminders": "read_and_write",
"access_reporting": "read_and_write",
"access_risk_alerts": "read_and_write",
"access_sales_orders": "read_and_write",
"access_sales_units": "read_and_write",
"access_scoring_and_risk": "read_and_write",
"access_scoring_and_risk_settings": "read_and_write",
"access_security": "read_and_write",
"access_settings": "read_and_write",
"access_templates": "read_and_write",
"access_user_roles": "read_and_write",
"access_users": "read_and_write"
}
}
],
"meta": {
"total_pages": 1,
"total_entries": 1,
"per_page": 100
},
"links": {
"self": "https://apisandbox.bilendo.de/api/v2/user_roles?page=1",
"first": "https://apisandbox.bilendo.de/api/v2/user_roles?page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/user_roles?page=1"
}
}
user_roles#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/user_roles/<user_role-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific user role.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/user_roles/<user_role-id>
Comments
Comment Object
{
"data": {
"id": "<comment-id>",
"type": "comment",
"attributes": {
"id": "<comment-id>",
"item_type": "Customer",
"item": "123454",
"customer_name": "Customer name",
"customer_number": "123454",
"message": "Comment message text",
"category": "Comment category",
"pinned": "false",
"author": "user_email@examplemail.com",
"created_at": "2020-05-15T17:35:00+02:00",
"updated_at": "2020-05-15T17:35:00+02:00"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | Bilendo ID of the comment Example: 00000000-0000-0000-0000-000000000000 |
| item_type | string | Object related to the comment (e.g., Customer, JournalEntry) |
| item | string | Customer number for customers and invoice number for journal entries |
| customer_name | string | Name of the customer |
| customer_number | string | Customer number |
| message | string | Content of the comment |
| category | string | Category name of the comment |
| pinned | boolean | true = pinned for highlightingfalse = not highlighted |
| author | string | Email of the user who commented, or 'BilendoBot' |
customer#comments
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/comments?parent_type=customer&parent_id=<customer-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all comments for a customer.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/comments?parent_type=customer&parent_id=<customer-id>
{
"data": [
{
"id": "<comment-id>",
"type": "comment",
"attributes": {
"id": "<comment-id>",
"item_type": "Customer",
"item": "123454",
"customer_name": "Customer name",
"customer_number": "123454",
"message": "Comment message text",
"category": "Comment category",
"pinned": "false",
"author": "user_email@examplemail.com",
"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/comments?parent_type=customer&parent_id=<customer-id>&page=1",
"first": "https://apisandbox.bilendo.de/api/v2/comments?parent_type=customer&parent_id=<customer-id>&page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/comments?parent_type=customer&parent_id=<customer-id>&page=1"
}
}
journal_entry#comments
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/comments?parent_type=journal_entry&parent_id=<journal-entry-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Returns a list of all comments for a journal entry.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/comments?parent_type=journal_entry&parent_id=<journal-entry-id>
{
"data": [
{
"id": "<comment-id>",
"type": "comment",
"attributes": {
"id": "<comment-id>",
"item_type": "JournalEntry",
"item": "INVOICE-1234",
"customer_name": "Customer name",
"customer_number": "123454",
"message": "Comment message text",
"category": "Comment category A",
"pinned": "false",
"author": "user_email@examplemail.com",
"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/comments?parent_type=journal_entry&parent_id=<journal-entry-id>&page=1",
"first": "https://apisandbox.bilendo.de/api/v2/comments?parent_type=journal_entry&parent_id=<journal-entry-id>&page=1",
"prev": null,
"next": null,
"last": "https://apisandbox.bilendo.de/api/v2/comments?parent_type=journal_entry&parent_id=<journal-entry-id>&page=1"
}
}
comments#show
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/comments/<comment-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Retrieves a specific comment.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/comments/<comment-id>
Errors
HTTP Status Codes
The Bilendo API uses the following HTTP error status codes:
| Status | Code | Meaning |
|---|---|---|
| 400 | Bad Request | Your request is invalid |
| 401 | Unauthorized | Your API token is invalid |
| 403 | Forbidden | The server understood the request but refuses to authorize it |
| 404 | Not Found | The specified object could not be found |
| 406 | Not Acceptable | You requested a format that is not JSON |
| 410 | Gone | The object requested has been removed from our servers |
| 422 | Unprocessable Entity | The object is not valid |
| 429 | Too Many Requests | Too many requests. Please slow down. |
| 500 | Internal Server Error | We had a problem with our server. Try again later. |
| 503 | Service Unavailable | We're temporarily offline for maintenance. Please try again later. |
Bilendo Error Codes
If an API call fails, the API will respond with an HTTP status code other than 200 and a JSON response that indicates what went wrong.
| Error | Meaning |
|---|---|
| blank | A mandatory field was not provided |
| taken | Another object with the same value already exists |
| invalid | The provided value for this field is invalid |
# Example: A request to customers#create without the mandatory field "name".
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/customers" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "customer_number=123"
{
"error": {
"name": [
{
"error": "blank"
}
]
}
}