Files
n8n-nodes-billbee-fork/README.md
T

239 lines
7.9 KiB
Markdown

# @n8n-dev/n8n-nodes-billbee
![billbee Banner](banner.svg)
[![npm version](https://img.shields.io/npm/v/@n8n-dev/n8n-nodes-billbee.svg)](https://www.npmjs.com/package/@n8n-dev/n8n-nodes-billbee)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
---
**Stop writing billbee API integrations by hand.**
Every time you connect n8n to billbee, you waste hours mapping endpoints, defining parameters, and debugging schemas. You copy-paste from docs, fix edge cases, and pray nothing breaks.
**What if connecting n8n to billbee took 5 minutes, not half a day?**
This node gives you **12+ resources** out of the box: **Provisioning**, **Cloud Storage**, **Customer Addresses**, **Customers**, **Enum API**, and 7 more: with full CRUD operations, typed parameters, and zero manual configuration.
---
## What You Get
- **Zero boilerplate**: Resources, operations, and fields are pre-configured and ready to use
- **Full CRUD**: Create, read, update, and delete support where the API allows it
- **Typed parameters**: No more guessing field types
- **Built-in auth**: API key authentication, ready to go
- **Declarative**: Native n8n performance, no custom execute() overhead
---
## Install
```bash
npm install @n8n-dev/n8n-nodes-billbee
```
**Or in n8n:**
1. **Settings → Community Nodes → Install**
2. Search: `@n8n-dev/n8n-nodes-billbee`
3. Click **Install**
---
## Quick Start
1. Install the node (above)
2. Add credentials: **billbee API** → paste your API key
3. Drag the **billbee** node into your workflow
4. Pick a resource → pick an operation → done.
That's it. No configuration files. No code. It just works.
---
## Resources
<details>
<summary><b>Provisioning</b> (2 operations)</summary>
- Post Creates a new Billbee user account with the data passed
- Get Returns infos about Billbee terms and conditions
</details>
<details>
<summary><b>Cloud Storage</b> (1 operations)</summary>
- Get s a list of all connected cloud storage devices
</details>
<details>
<summary><b>Customer Addresses</b> (4 operations)</summary>
- Get a list of all customer addresses
- Post Creates a new customer address
- Get Queries a single customer address by ID
- Put Updates a customer address by ID
</details>
<details>
<summary><b>Customers</b> (11 operations)</summary>
- Get a list of all customers
- Post Creates a new customer
- Get Queries a single address from a customer
- Patch Updates one or more fields of an address
- Put Updates all fields of an address
- Get Queries a single customer by ID
- Put Updates a customer by ID
- Get Queries a list of addresses from a customer
- Post Adds a new address to a customer
- Get Queries a list of orders from a customer
- Post Search for products customers and orders Type can be order product and or customer Term can contains lucene query syntax
</details>
<details>
<summary><b>Enum API</b> (4 operations)</summary>
- Get Returns a list with all defined orderstates
- Get Returns a list with all defined paymenttypes
- Get Returns a list with all defined shipmenttypes
- Get Returns a list with all defined shippingcarriers
</details>
<details>
<summary><b>Events</b> (1 operations)</summary>
- Get a list of all events optionally filtered by date This request is extra throttled to 2 calls per page per hour
</details>
<details>
<summary><b>Orders</b> (18 operations)</summary>
- Get Layout API Get List
- Get a list of all orders optionally filtered by date
- Post Creates a new order in the Billbee account
- Post Create an delivery note for an existing order This request is extra throttled by order and API key to a maximum of 1 per 5 minutes
- Post Create an invoice for an existing order This request is extra throttled by order and API key to a maximum of 1 per 5 minutes
- Get Returns a list of fields which can be updated with the orders ID patch call
- Get a single order by its external order number
- Get a list of all invoices optionally filtered by date This request ist throttled to 1 per 1 minute for same page and minInvoiceDate
- Get a single order by its internal billbee ID This request is throttled to 6 calls per order in one minute
- Patch Updates one or more fields of an order
- Put Changes the main state of a single order
- Post Parses a text and replaces all placeholders
- Post Sends a message to the buyer
- Post Add a shipment to a given order
- Post Attach one or more tags to an order
- Put Sets the tags attached to an order
- Post Triggers a rule event
- Post Search for products customers and orders Type can be order product and or customer Term can contains lucene query syntax
</details>
<details>
<summary><b>Delivery Note</b> (1 operations)</summary>
- Post Create an delivery note for an existing order This request is extra throttled by order and API key to a maximum of 1 per 5 minutes
</details>
<details>
<summary><b>Invoice</b> (2 operations)</summary>
- Post Create an invoice for an existing order This request is extra throttled by order and API key to a maximum of 1 per 5 minutes
- Get a list of all invoices optionally filtered by date This request ist throttled to 1 per 1 minute for same page and minInvoiceDate
</details>
<details>
<summary><b>Products</b> (23 operations)</summary>
- Get a list of all products
- Post Creates a new product
- Get Returns a list of fields which can be updated with the patch call
- Get s a list of all defined categories
- Get Queries a list of all custom fields
- Get Queries a single custom field
- Post Delete multiple images by ID
- Delete s a single image by ID
- Get Returns a single image by ID
- Get Queries the reserved amount for a single article by ID or by sku
- Get Query all defined stock locations
- Post Update the stock qty of an article
- Post Update the stock code of an article
- Post Update the stock qty for multiple articles at once
- Delete s a product
- Get Queries a single article by ID or by sku
- Patch Updates one or more fields of a product
- Get Returns a list of all images of the product
- Put Add multiple images to a product or replace the product images by the given images
- Delete s a single image from a product
- Get Returns a single image by ID
- Put Add or update an existing image of a product
- Post Search for products customers and orders Type can be order product and or customer Term can contains lucene query syntax
</details>
<details>
<summary><b>Shipments</b> (6 operations)</summary>
- Get Shipment Get Ping
- Post Creates a new shipment with the selected Shippingprovider
- Get a list of all shipments optionally filtered by date All parameters are optional
- Get Queries the currently available shipping carriers
- Get Query all defined shipping providers
- Post Creates a shipment for an order in billbee
</details>
<details>
<summary><b>Webhooks</b> (7 operations)</summary>
- Delete s all existing WEBHOOK registrations
- Get s all registered WebHooks for a given user
- Post Registers a new WEBHOOK for a given user
- Get Returns a list of all known filters you can use to register webhooks
- Delete s an existing WEBHOOK registration
- Get Looks up a registered WEBHOOK with the given ID for a given user
- Put Updates an existing WEBHOOK registration
</details>
---
## Why This Node?
**Without this node:**
- Hours of manual API integration
- Copy-pasting from billbee docs
- Debugging auth, pagination, error handling
- Maintaining your own client code
**With this node:**
- Install → configure → use. 5 minutes.
- Auto-generated from the official billbee OpenAPI spec
- Always up to date when the API changes
- Native n8n performance
---
## Auto-Generated
This node was auto-generated from the official **billbee** OpenAPI specification using
[@n8n-dev/n8n-openapi-node-ultimate](https://github.com/kelvinzer0/n8n-openapi-node-ultimate),
then validated against the live API so you get accurate types and real parameters, not guesswork.
When the billbee API updates, this node updates too.
---
## License
MIT © [kelvinzer0](https://github.com/n8n-code)