easybill REST API

https://www.easybill.de/api
Admin
easybill REST API is a comprehensive API for managing invoices, customers, documents, projects, and...
Tokens:5,104
Snippets:43
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Project Management

Source: https://www.easybill.de/api

Endpoints for managing projects, including fetching lists, creating, retrieving, updating, and deleting projects.

```APIDOC
## GET /projects

### Description
Fetch projects list.

### Method
GET

### Endpoint
/projects

```

```APIDOC
## POST /projects

### Description
Create project.

### Method
POST

### Endpoint
/projects

```

```APIDOC
## GET /projects/{id}

### Description
Fetch project.

### Method
GET

### Endpoint
/projects/{id}

```

```APIDOC
## PUT /projects/{id}

### Description
Update project.

### Method
PUT

### Endpoint
/projects/{id}

```

```APIDOC
## DELETE /projects/{id}

### Description
Delete project.

### Method
DELETE

### Endpoint
/projects/{id}

```

--------------------------------

### Task Management

Source: https://www.easybill.de/api

Endpoints for managing tasks, including fetching lists, creating, retrieving, updating, and deleting tasks.

```APIDOC
## GET /tasks

### Description
Fetch tasks list.

### Method
GET

### Endpoint
/tasks

```

```APIDOC
## POST /tasks

### Description
Create task.

### Method
POST

### Endpoint
/tasks

```

```APIDOC
## GET /tasks/{id}

### Description
Fetch task.

### Method
GET

### Endpoint
/tasks/{id}

```

```APIDOC
## PUT /tasks/{id}

### Description
Update task.

### Method
PUT

### Endpoint
/tasks/{id}

```

```APIDOC
## DELETE /tasks/{id}

### Description
Delete task.

### Method
DELETE

### Endpoint
/tasks/{id}

```

--------------------------------

### Position Discount Management

Source: https://www.easybill.de/api

Endpoints for managing discounts applied to positions, including fetching lists, creating, retrieving, updating, and deleting discounts.

```APIDOC
## GET /discounts/position

### Description
Fetch list of position discounts.

### Method
GET

### Endpoint
/discounts/position

```

```APIDOC
## POST /discounts/position

### Description
Create a new position discount.

### Method
POST

### Endpoint
/discounts/position

```

```APIDOC
## GET /discounts/position/{id}

### Description
Fetch specified position discount by id.

### Method
GET

### Endpoint
/discounts/position/{id}

```

```APIDOC
## PUT /discounts/position/{id}

### Description
Update a position discount.

### Method
PUT

### Endpoint
/discounts/position/{id}

```

```APIDOC
## DELETE /discounts/position/{id}

### Description
Delete the specified position discount.

### Method
DELETE

### Endpoint
/discounts/position/{id}

```

--------------------------------

### Position Management

Source: https://www.easybill.de/api

Endpoints for managing positions, including fetching lists, creating, retrieving, updating, and deleting positions.

```APIDOC
## GET /positions

### Description
Fetch positions list.

### Method
GET

### Endpoint
/positions

```

```APIDOC
## POST /positions

### Description
Create position.

### Method
POST

### Endpoint
/positions

```

```APIDOC
## GET /positions/{id}

### Description
Fetch position.

### Method
GET

### Endpoint
/positions/{id}

```

```APIDOC
## PUT /positions/{id}

### Description
Update position.

### Method
PUT

### Endpoint
/positions/{id}

```

```APIDOC
## DELETE /positions/{id}

### Description
Delete position.

### Method
DELETE

### Endpoint
/positions/{id}

```

--------------------------------

### Login API

Source: https://www.easybill.de/api

Endpoints for retrieving information regarding logins and employees.

```APIDOC
## GET /logins

### Description
Informations regarding the logins / employees

### Method
GET

### Endpoint
/logins
```

```APIDOC
## GET /logins/{id}

### Description
Fetch a specific login or employee information

### Method
GET

### Endpoint
/logins/{id}
```

--------------------------------

### Text Template Management

Source: https://www.easybill.de/api

Endpoints for managing text templates, including fetching lists, creating, retrieving, updating, and deleting text templates.

```APIDOC
## GET /text-templates

### Description
Fetch text templates list.

### Method
GET

### Endpoint
/text-templates

```

```APIDOC
## POST /text-templates

### Description
Create text template.

### Method
POST

### Endpoint
/text-templates

```

```APIDOC
## GET /text-templates/{id}

### Description
Fetch text template.

### Method
GET

### Endpoint
/text-templates/{id}

```

```APIDOC
## PUT /text-templates/{id}

### Description
Update text template.

### Method
PUT

### Endpoint
/text-templates/{id}

```

```APIDOC
## DELETE /text-templates/{id}

### Description
Delete text template.

### Method
DELETE

### Endpoint
/text-templates/{id}

```

--------------------------------

### Document Management

Source: https://www.easybill.de/api

Endpoints for managing various types of documents such as invoices and offers, including fetching lists, creating, retrieving, updating, deleting, and performing actions like completion, cancellation, sending, and conversion.

```APIDOC
## GET /documents

### Description
Fetch documents list.

### Method
GET

### Endpoint
/documents

```

```APIDOC
## POST /documents

### Description
Create document.

### Method
POST

### Endpoint
/documents

```

```APIDOC
## GET /documents/{id}

### Description
Fetch document.

### Method
GET

### Endpoint
/documents/{id}

```

```APIDOC
## PUT /documents/{id}

### Description
Update document.

### Method
PUT

### Endpoint
/documents/{id}

```

```APIDOC
## DELETE /documents/{id}

### Description
Delete document.

### Method
DELETE

### Endpoint
/documents/{id}

```

```APIDOC
## PUT /documents/{id}/done

### Description
To complete a document.

### Method
PUT

### Endpoint
/documents/{id}/done

```

```APIDOC
## POST /documents/{id}/cancel

### Description
Cancel document.

### Method
POST

### Endpoint
/documents/{id}/cancel

```

```APIDOC
## POST /documents/{id}/send/{type}

### Description
Send document.

### Method
POST

### Endpoint
/documents/{id}/send/{type}

```

```APIDOC
## GET /documents/{id}/pdf

### Description
Fetch pdf document.

### Method
GET

### Endpoint
/documents/{id}/pdf

```

```APIDOC
## GET /documents/{id}/download

### Description
Fetch the document in best fitting format to the given Accept header.

### Method
GET

### Endpoint
/documents/{id}/download

```

```APIDOC
## GET /documents/{id}/jpg

### Description
Download a document as an jpeg-image.

### Method
GET

### Endpoint
/documents/{id}/jpg

```

```APIDOC
## POST /documents/{id}/{type}

### Description
Convert an existing document to one of a different type.

### Method
POST

### Endpoint
/documents/{id}/{type}

```

--------------------------------

### Stock API

Source: https://www.easybill.de/api

Endpoints for managing stock entries for positions.

```APIDOC
## GET /stocks

### Description
Fetch a list of stock entries for positions

### Method
GET

### Endpoint
/stocks
```

```APIDOC
## POST /stocks

### Description
Create a stock entry for a position

### Method
POST

### Endpoint
/stocks
```

```APIDOC
## GET /stocks/{id}

### Description
Fetch an stock entry for a position

### Method
GET

### Endpoint
/stocks/{id}
```

--------------------------------

### Webhook API

Source: https://www.easybill.de/api

Endpoints for managing WebHooks.

```APIDOC
## GET /webhooks

### Description
Fetch WebHooks list

### Method
GET

### Endpoint
/webhooks
```

```APIDOC
## POST /webhooks

### Description
Create WebHook

### Method
POST

### Endpoint
/webhooks
```

```APIDOC
## GET /webhooks/{id}

### Description
Fetch WebHook

### Method
GET

### Endpoint
/webhooks/{id}
```

```APIDOC
## PUT /webhooks/{id}

### Description
Update WebHook

### Method
PUT

### Endpoint
/webhooks/{id}
```

```APIDOC
## DELETE /webhooks/{id}

### Description
Delete WebHook

### Method
DELETE

### Endpoint
/webhooks/{id}
```

--------------------------------

### Time Tracking API

Source: https://www.easybill.de/api

Endpoints for managing time tracking entries.

```APIDOC
## GET /time-trackings

### Description
Fetch time trackings list

### Method
GET

### Endpoint
/time-trackings
```

```APIDOC
## POST /time-trackings

### Description
Create time tracking

### Method
POST

### Endpoint
/time-trackings
```

```APIDOC
## GET /time-trackings/{id}

### Description
Fetch time tracking

### Method
GET

### Endpoint
/time-trackings/{id}
```

```APIDOC
## PUT /time-trackings/{id}

### Description
Update time tracking

### Method
PUT

### Endpoint
/time-trackings/{id}
```

```APIDOC
## DELETE /time-trackings/{id}

### Description
Delete time tracking

### Method
DELETE

### Endpoint
/time-trackings/{id}
```

--------------------------------

### PDF Templates API

Source: https://www.easybill.de/api

Endpoints for fetching PDF templates for documents.

```APIDOC
## GET /pdf-templates

### Description
Fetch PDF Templates list

### Method
GET

### Endpoint
/pdf-templates
```

--------------------------------

### Position Group Discount Management

Source: https://www.easybill.de/api

Endpoints for managing discounts applied to position groups, including fetching lists, creating, retrieving, updating, and deleting discounts.

```APIDOC
## GET /discounts/position-group

### Description
Fetch list of position-group discounts.

### Method
GET

### Endpoint
/discounts/position-group

```

```APIDOC
## POST /discounts/position-group

### Description
Create a new position-group discount.

### Method
POST

### Endpoint
/discounts/position-group

```

```APIDOC
## GET /discounts/position-group/{id}

### Description
Fetch specified position-group discount by id.

### Method
GET

### Endpoint
/discounts/position-group/{id}

```

```APIDOC
## PUT /discounts/position-group/{id}

### Description
Update a position-group discount.

### Method
PUT

### Endpoint
/discounts/position-group/{id}

```

```APIDOC
## DELETE /discounts/position-group/{id}

### Description
Delete the specified position-group discount.

### Method
DELETE

### Endpoint
/discounts/position-group/{id}

```

--------------------------------

### Document Version API

Source: https://www.easybill.de/api

Endpoints for managing document versions.

```APIDOC
## GET /documents/{id}/versions

### Description
List all versions of a given document

### Method
GET

### Endpoint
/documents/{id}/versions
```

```APIDOC
## GET /documents/{id}/versions/{versionId}

### Description
Show a single version of a given document

### Method
GET

### Endpoint
/documents/{id}/versions/{versionId}
```

```APIDOC
## GET /documents/{id}/versions/{versionId}/items/{versionItemId}/download

### Description
Download a specific file for a single version of a given document

### Method
GET

### Endpoint
/documents/{id}/versions/{versionId}/items/{versionItemId}/download
```

--------------------------------

### Customer Management

Source: https://www.easybill.de/api

Endpoints for managing customer data, including fetching lists, creating, retrieving, updating, and deleting individual customers.

```APIDOC
## GET /customers

### Description
Fetch customers list.

### Method
GET

### Endpoint
/customers

```

```APIDOC
## POST /customers

### Description
Create customer.

### Method
POST

### Endpoint
/customers

```

```APIDOC
## GET /customers/{id}

### Description
Fetch customer.

### Method
GET

### Endpoint
/customers/{id}

```

```APIDOC
## PUT /customers/{id}

### Description
Update Customer.

### Method
PUT

### Endpoint
/customers/{id}

```

```APIDOC
## DELETE /customers/{id}

### Description
Delete customer.

### Method
DELETE

### Endpoint
/customers/{id}

```

```APIDOC
## POST /customers/{id}/sepa-mandate/transfer

### Description
Transfer the customer's SEPA mandate to the connected payment provider.

### Method
POST

### Endpoint
/customers/{id}/sepa-mandate/transfer

```

--------------------------------

### Post Box API

Source: https://www.easybill.de/api

Endpoints for managing post boxes.

```APIDOC
## GET /post-boxes

### Description
Fetch post box list

### Method
GET

### Endpoint
/post-boxes
```

```APIDOC
## GET /post-boxes/{id}

### Description
Fetch post box

### Method
GET

### Endpoint
/post-boxes/{id}
```

```APIDOC
## DELETE /post-boxes/{id}

### Description
Delete post box

### Method
DELETE

### Endpoint
/post-boxes/{id}
```

--------------------------------

### Position Group Management

Source: https://www.easybill.de/api

Endpoints for managing position groups, including fetching lists, creating, retrieving, updating, and deleting position groups.

```APIDOC
## GET /position-groups

### Description
Fetch position group list.

### Method
GET

### Endpoint
/position-groups

```

```APIDOC
## POST /position-groups

### Description
Create position group.

### Method
POST

### Endpoint
/position-groups

```

```APIDOC
## GET /position-groups/{id}

### Description
Fetch position group.

### Method
GET

### Endpoint
/position-groups/{id}

```

```APIDOC
## PUT /position-groups/{id}

### Description
Update position group.

### Method
PUT

### Endpoint
/position-groups/{id}

```

```APIDOC
## DELETE /position-groups/{id}

### Description
Delete position group.

### Method
DELETE

### Endpoint
/position-groups/{id}

```

--------------------------------

### Authentication Headers for easybill API

Source: https://www.easybill.de/api

Use either Basic Auth or Bearer Token for authentication. Ensure the correct Authorization header is included in your HTTP requests.

```http
# Basic Auth
Authorization: Basic base64_encode('<email>:<api_key>')
# Bearer Token
Authorization: Bearer <api_key>
```

--------------------------------

### Contact API

Source: https://www.easybill.de/api

Endpoints for managing contacts associated with customers.

```APIDOC
## GET /customers/{customerId}/contacts

### Description
Fetch customer contact list

### Method
GET

### Endpoint
/customers/{customerId}/contacts
```

```APIDOC
## POST /customers/{customerId}/contacts

### Description
Create new contact

### Method
POST

### Endpoint
/customers/{customerId}/contacts
```

```APIDOC
## GET /customers/{customerId}/contacts/{id}

### Description
Fetch contact

### Method
GET

### Endpoint
/customers/{customerId}/contacts/{id}
```

```APIDOC
## PUT /customers/{customerId}/contacts/{id}

### Description
Update Contact

### Method
PUT

### Endpoint
/customers/{customerId}/contacts/{id}
```

```APIDOC
## DELETE /customers/{customerId}/contacts/{id}

### Description
Delete contact

### Method
DELETE

### Endpoint
/customers/{customerId}/contacts/{id}
```

--------------------------------

### Attachment API

Source: https://www.easybill.de/api

Endpoints for managing attachments.

```APIDOC
## GET /attachments

### Description
Fetch attachments list

### Method
GET

### Endpoint
/attachments
```

```APIDOC
## POST /attachments

### Description
Create attachment

### Method
POST

### Endpoint
/attachments
```

```APIDOC
## GET /attachments/{id}

### Description
Fetch attachment

### Method
GET

### Endpoint
/attachments/{id}
```

```APIDOC
## PUT /attachments/{id}

### Description
Update attachment

### Method
PUT

### Endpoint
/attachments/{id}
```

```APIDOC
## DELETE /attachments/{id}

### Description
Delete attachment

### Method
DELETE

### Endpoint
/attachments/{id}
```

```APIDOC
## GET /attachments/{id}/content

### Description
Fetch attachment content

### Method
GET

### Endpoint
/attachments/{id}/content
```

--------------------------------

### Customer Group Management

Source: https://www.easybill.de/api

Endpoints for managing customer groups, including fetching lists, creating, retrieving, updating, and deleting groups.

```APIDOC
## GET /customer-groups

### Description
Fetch customer group list.

### Method
GET

### Endpoint
/customer-groups

```

```APIDOC
## POST /customer-groups

### Description
Create customer group.

### Method
POST

### Endpoint
/customer-groups

```

```APIDOC
## GET /customer-groups/{id}

### Description
Fetch customer group.

### Method
GET

### Endpoint
/customer-groups/{id}

```

```APIDOC
## PUT /customer-groups/{id}

### Description
Update customer group.

### Method
PUT

### Endpoint
/customer-groups/{id}

```

```APIDOC
## DELETE /customer-groups/{id}

### Description
Delete customer group.

### Method
DELETE

### Endpoint
/customer-groups/{id}

```

--------------------------------

### SEPA Payment API

Source: https://www.easybill.de/api

Endpoints for managing SEPA payments.

```APIDOC
## GET /sepa-payments

### Description
Fetch SEPA payments list

### Method
GET

### Endpoint
/sepa-payments
```

```APIDOC
## POST /sepa-payments

### Description
Create SEPA payment

### Method
POST

### Endpoint
/sepa-payments
```

```APIDOC
## GET /sepa-payments/{id}

### Description
Fetch SEPA payment

### Method
GET

### Endpoint
/sepa-payments/{id}
```

```APIDOC
## PUT /sepa-payments/{id}

### Description
Update SEPA payment

### Method
PUT

### Endpoint
/sepa-payments/{id}
```

```APIDOC
## DELETE /sepa-payments/{id}

### Description
Delete SEPA payment

### Method
DELETE

### Endpoint
/sepa-payments/{id}
```

--------------------------------

### Document Payment Management

Source: https://www.easybill.de/api

Endpoints for managing payments related to documents, including fetching lists, creating, retrieving, and deleting document payments.

```APIDOC
## GET /document-payments

### Description
Fetch document payments list.

### Method
GET

### Endpoint
/document-payments

```

```APIDOC
## POST /document-payments

### Description
Create document payment.

### Method
POST

### Endpoint
/document-payments

```

```APIDOC
## GET /document-payments/{id}

### Description
Fetch document payment.

### Method
GET

### Endpoint
/document-payments/{id}

```

```APIDOC
## DELETE /document-payments/{id}

### Description
Delete document payment.

### Method
DELETE

### Endpoint
/document-payments/{id}

```

--------------------------------

### Escaping Commas in Query Parameters

Source: https://www.easybill.de/api

To include commas within query parameter values, set the 'X-Easybill-Escape' header to 'true'. This is useful for parameters like 'name'.

```http
X-Easybill-Escape: true
name=Patrick\, Peter
```

--------------------------------

### Date and Date-Time Format in easybill API

Source: https://www.easybill.de/api

Use the 'Europe/Berlin' timezone for date and date-time values. Dates are formatted as Y-m-d and date-times as Y-m-d H:i:s. These fields can be null.

```text
date = _Y-m-d_ = `2016-12-31`
date-time = _Y-m-d H:i:s_ = `2016-12-31 03:13:37`
```

--------------------------------

### Serial Number API

Source: https://www.easybill.de/api

Endpoints for managing serial numbers for positions.

```APIDOC
## GET /serial-numbers

### Description
Fetch a list of serial numbers for positions

### Method
GET

### Endpoint
/serial-numbers
```

```APIDOC
## POST /serial-numbers

### Description
Create a serial number for a position

### Method
POST

### Endpoint
/serial-numbers
```

```APIDOC
## GET /serial-numbers/{id}

### Description
Fetch a serial number for a position

### Method
GET

### Endpoint
/serial-numbers/{id}
```

```APIDOC
## DELETE /serial-numbers/{id}

### Description
Delete a serial number for a position

### Method
DELETE

### Endpoint
/serial-numbers/{id}
```

--------------------------------

### Filtering Documents by Number in easybill API

Source: https://www.easybill.de/api

Filter document lists by one or more numbers. For multiple numbers, use comma-separated values or an array. Be mindful of the request line size limit.

```http
/documents?number=111028654
/documents?number=111028654,222006895
/documents?number[]=111028654&number[]=222006895
```
Tokens:
Raw