Invoice Items API
The Invoice Items API allows you to create, update, and manage individual items within an invoice.
Contents
- Base URL
- Field Definitions
- Create Invoice Item
- Update Invoice Item
- Delete Invoice Item
- Example Usage
Base URL
https://api.billover.com/v1/invoices/{invoice_uid}/items/
Note
Replace {invoice_uid} with the actual UUID of the parent invoice.
Field Definitions
Common Fields
| Field | Type | Description | Required |
|---|---|---|---|
| uid | UUID | Unique identifier for the item | Read-only |
| name | string | Name of the item | No |
| description | string | Description of the item | No |
| quantity | decimal(10,3) | Quantity of the item | No |
| unit | string | Unit of measurement (k: Kilogram, p: Piece, m: Meter, l: Liter) | No |
| total_price | decimal(10,2) | Total price of the item (including VAT) | No |
| vat_rate | decimal(5,2) | VAT rate percentage | No |
Unit Values
| Value | Description |
|---|---|
| k | Kilogram |
| p | Piece |
| m | Meter |
| l | Liter |
Create Invoice Item
Create a new item for a specific invoice.
POST /v1/invoices/{invoice_uid}/items/
Request Body
{
"name": "Product A",
"description": "Premium quality product",
"quantity": "2.000",
"unit": "p",
"total_price": "100.00",
"vat_rate": "18.00"
}
Response
{
"uid": "67df8b92-ed61-4796-b5c2-9505bf9d4b6a",
"name": "Product A",
"description": "Premium quality product",
"quantity": "2.000",
"unit": "p",
"total_price": "100.00",
"vat_rate": "18.00"
}
Update Invoice Item
Update an existing item of a specific invoice.
PUT /v1/invoices/{invoice_uid}/items/{item_uid}
Request Body
{
"name": "Updated Product A",
"quantity": "3.000",
"unit": "k",
"total_price": "150.00"
}
Response
{
"uid": "67df8b92-ed61-4796-b5c2-9505bf9d4b6a",
"name": "Updated Product A",
"description": "Premium quality product",
"quantity": "3.000",
"unit": "k",
"total_price": "150.00",
"vat_rate": "18.00"
}
Delete Invoice Item
Delete an existing item from a specific invoice.
DELETE /v1/invoices/{invoice_uid}/items/{item_uid}
Response
HTTP/1.1 204 No Content
Example Usage
Create an Invoice Item
curl -X POST \
https://api.billover.com/v1/invoices/a1b2c3d4-e5f6-g7h8-i9j0/items/ \
-H 'Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Product A",
"description": "Premium quality product",
"quantity": "2.000",
"unit": "p",
"total_price": "100.00",
"vat_rate": "18.00"
}'
Update an Invoice Item
curl -X PUT \
https://api.billover.com/v1/invoices/a1b2c3d4-e5f6-g7h8-i9j0/items/67df8b92-ed61-4796-b5c2-9505bf9d4b6a \
-H 'Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Updated Product A",
"quantity": "3.000",
"unit": "k",
"total_price": "150.00"
}'
Delete an Invoice Item
curl -X DELETE \
https://api.billover.com/v1/invoices/a1b2c3d4-e5f6-g7h8-i9j0/items/67df8b92-ed61-4796-b5c2-9505bf9d4b6a \
-H 'Api-Key: YOUR_API_KEY'