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 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>",
"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_creditreform": null,
"external_id_creditsafe": null,
"external_id_dd_monitor": 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 of 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 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_creditreform | string | this id will be used to get credit information of 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 of the customer from DD Monitor (service scoring and risk should be enabled first) |
| 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"
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>",
"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_creditreform": null,
"external_id_creditsafe": null,
"external_id_dd_monitor": 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 "note=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>"
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 |
| external_user_id | optional | your id of the user |
| external_id_creditreform | optional | Creditreform number of customer |
| external_id_dd_monitor | optional | DD-Monitor number of customer |
| customer_number | mandatory | 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#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." \
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 |
|---|---|---|
| external_id | optional | your id of the customer |
| external_user_id | optional | your id of the user, If you want to delete a user from the customer, simply 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"
This endpoint will display all the information of a particular 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"
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>
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"
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 |
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"
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 |
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"
Use this endpoint to set the credit limit of the customer. If you want to remove an existing credit limit, provide an empty string as new credit limit.
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 of the contact |
| name | string | name of the contact |
| gender | string | unknown male female family |
| string | ||
| phone | string | phone number of the contact |
| main_contact | boolean | true = main contact false = 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"
This endpoint will display all the 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"
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 |
|---|---|---|
| external_id | optional | your contact id |
| name | optional | name of the contact |
| gender | mandatory | please use one of these string: unknown male female family |
| phone | optional | phone number of the contact |
| optional | ||
| main_contact | optional | true = make this contact a main contact, false = make this contact not a main contact |
contacts#update
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 |
|---|---|---|
| external_id | optional | your contact id |
| name | optional | name of the contact |
| gender | mandatory | please use one of these string: unknown male female family |
| phone | optional | phone number of the contact |
| optional | ||
| main_contact | optional | true = make this contact a main contact, false = 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"
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>
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"
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>",
"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/<address-id>"
}
}
}
}
}
| Attribute | Type | Description |
|---|---|---|
| id | UUID | 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) |
| 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 address false = 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" \
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>",
"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/<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"
}
}
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"
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) |
| 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 country isocode |
| country | optional | customer’s country name |
| default_address | optional | true = default address false = not default address |
Important: Either country_code or country are 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"
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) |
| 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 country isocode |
| country | optional | customer’s country name |
| default_address | optional | true = default address false = not default address |
Important: Either country_code or country are 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"
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>
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"
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>
Customer Groups
Customer Groups 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 Customer Group external 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"
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"
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"
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>
customer_groups#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 | array of customer ids |
API Endpoint
PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/add
customer_groups#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 | array of customer ids |
API Endpoint
PUT https://apisandbox.bilendo.de/api/v2/customer_groups/<customer-group-id>/remove
Journal Entries (BETA)
Journal Entries 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,
"entry_date": "1998-02-01",
"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,
"custom_fields": {
"additional_info": "additional info",
"more_info": "more info"
},
"created_at": "2020-06-03T14:18:27+02:00",
"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 | |
| entry_date | date | the date of the creation of the Journal Entry in the external system |
| 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 |
| custom_fields | object |
journal_entries#index
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" : {
"id": "<journal-entry-id>",
"external_id": "1234567890",
"amount": "123.45",
"currency": "EUR",
"journal_type": "receivable",
"invoice_number": null,
"entry_date": "1998-02-01",
"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,
"custom_fields": {
"additional_info": "additional info",
"more_info": "more info"
},
"created_at": "2020-06-03T14:18:27+02:00",
"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#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/journal_entries" \
-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"
This endpoint allows you to create contact for a customer.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/journal_entries
| Parameter | Type | Description |
|---|---|---|
| amount | mandatory | The amount of the journal entry |
| currency | mandatory | The currency, e.g. EUR |
| due_date | mandatory | The due date |
| external_id | mandatory | unique ID in your system |
| receipt_number | mandatory | The receipt number in your system |
| invoice_number | mandatory | invoice number |
| journal_type | mandatory | "receivable" or "credit" |
| receipt_date | mandatory | the date on the document |
| customer_id | mandatory | the bilendo_id of the customer |
| external_doctype | mandatory | |
| external_doctype_hint | optional | |
| external_amount | optional | The external_amount of the journal entry |
| external_currency | optional | The external currency, e.g. USD |
| area_id | optional | the bilendo_id of the area |
| business_unit_id | optional | bilendo_id of the business unit |
| service_user_id | optional | the bilendo_id of the service user |
| user_id | optional | the bilendo_id of the User |
| sales_unit_id | optional | the bilendo_id of the sales user |
| erp_association | optional | |
| erp_reference | optional | |
| erp_reference_key_1 | optional | |
| erp_reference_key_2 | optional | |
| external_sales_unit | optional | |
| notice | optional | |
| external_notice | optional | |
| text | optional |
journal_entries#show
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>
journal_entries#find
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/journal_entries/find/<external-id>" \
-H "Authorization: Token token=YOUR-API-TOKEN"
Use this endpoint to find one or multiple journal entry by external id.
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"
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 |
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" \
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 (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": [
[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/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 Journal entry |
clearings#index
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>",
"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": [
[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/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"
This endpoint will display all the information of a clearing.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/clearings/<clearing-id>
clearings#create
curl -X "POST" "https://apisandbox.bilendo.de/api/v2/clearings" \
-H "Authorization: Token token=YOUR-API-TOKEN" \
-d "clearing_number=<your-clearing-number>" \
-d $'{ "journal_entry_ids": [
"<journal-entry1-id>",
"<journal-entry2-id>"
]}'
This endpoint allows you to create clearings for journal entries
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/clearings
| Parameter | Type | Description |
|---|---|---|
| journal_entry_ids | mandatory | array of bilendo journal entry ids |
| clearing_number | mandatory | your clearing number |
clearings#delete
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>
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 | customer_file, journal_file or unknown |
| processing_status | string | waiting, in_progress done or canceled |
| rows_count | integer | number of rows in 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" \
This endpoint will display all the ERP files for a company.
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"
This endpoint allows you to upload an ERP file.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/erp_files
| Parameter | 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"
This endpoint will display the details of an 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"
Use this endpoint to delete 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" \
This endpoint will display all the Enhancement files for a company.
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/enhancement_files
{
"data": [
{
"id": "<enhancement-file-id>",
"type": "erp_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"
This endpoint allows you to upload an Enhancement file.
API Endpoint
POST https://apisandbox.bilendo.de/api/v2/enhancement_files
| Parameter | 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"
This endpoint will display the details of an 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-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-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id-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"
This endpoint will display all the 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-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-id>/media_files/<media-file-id>",
"related": "https://apisandbox.bilendo.de/api/v2/journal_entries/<journal-entry-id-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"
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 |
|---|---|---|
| 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"
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>
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"
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>
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 Example: 00000000-0000-0000-0000-000000000000 |
| name | string | name of media file type |
| description | text | description for 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" \
This endpoint will display all the media file types for the company.
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" \
This endpoint will display all the information of a particular 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 email 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_emails/<template-email-id>
Template Invoices
Template invoices are used to define the behaviour 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"
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"
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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_posts/<template-post-id>
Template Settings
Template settingsare used to define the behaviour of Bilendo's modules like 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/template_settings/<template-setting-id>
Areas
Areas are an organizational structure object.
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 Area external 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/areas/<area-id>
Business Units
Business Units are an organizational structure object.
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 Business Unit external 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/business_units/<business_unit-id>
Sales Units
Sales Units are an organizational structure object.
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 of 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/sales_units/<sales_unit-id>
Users
Users are an organizational structure object.
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 | list containing your ids of the User |
| first_name | string | The first name of the User |
| last_name | string | The last name of the User |
| string | The E-Mail of the User | |
| phone | string | The phone number of the User |
| employee_number | string | The employee number number of the User |
| description | string | The description of the User |
| user_role_id | string | Bilendo id of the User's User Role within the Company |
| user_data_access | array | This list contains 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"
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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/users/<user-id>
User Roles
User Roles are an organizational structure object.
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_billing": "none | read | read_and_write",
"access_clarifications": "none | read | read_and_write",
"access_customers": "none | read | read_and_write",
"access_integrations": "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_reminders": "none | read | read_and_write",
"access_reporting": "none | read | read_and_write",
"access_sales_units": "none | read | read_and_write",
"access_sap_import": "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_sftp_import": "none | read | read_and_write",
"access_tasks": "none | read | read_and_write",
"access_templates": "none | read | read_and_write",
"access_users": "none | read | read_and_write",
"access_workflows": "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_billing | string | access level to billing |
| access_clarifications | string | access level to clarifications |
| access_customers | string | access level to customers |
| access_integrations | string | access level to integrations |
| 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_reminders | string | access level to reminders |
| access_reporting | string | access level to reporting |
| access_sales_units | string | access level to sales units |
| access_sap_import | string | access level to data import |
| 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_sftp_import | string | access level to sftp import |
| access_tasks | string | access level to tasks |
| access_templates | string | access level to templates |
| access_users | string | access level to users |
| access_workflows | string | access level to clarification workflows settings |
user_roles#index
curl -X "GET" "https://apisandbox.bilendo.de/api/v2/user_roles" \
-H "Authorization: Token token=YOUR-API-TOKEN"
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_billing": "read_and_write",
"access_clarifications": "read_and_write",
"access_customers": "read_and_write",
"access_integrations": "read_and_write",
"access_letters": "read_and_write",
"access_media_files": "read_and_write",
"access_organization_tree": "read_and_write",
"access_reminders": "read_and_write",
"access_reporting": "read_and_write",
"access_sales_units": "read_and_write",
"access_sap_import": "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_sftp_import": "read_and_write",
"access_tasks": "read_and_write",
"access_templates": "read_and_write",
"access_users": "read_and_write",
"access_workflows": "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"
API Endpoint
GET https://apisandbox.bilendo.de/api/v2/user_roles/<user_role-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 wrong |
| 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 isn't json |
| 410 | Gone | The object requested has been removed from our servers |
| 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
In case an API Call fails, the API will respond with an HTTP Status Code other than 200 and a JSON Response that indicates, what whent 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 mandatoy 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"
}
]
}
}