Delivery Notes
Create delivery notes, mark as delivered, and convert to invoices.
|
Endpoints
| GET | /api/v1/delivery-notes | List delivery notes |
| POST | /api/v1/delivery-notes | Create a delivery note |
| GET | /api/v1/delivery-notes/{id} | Get a delivery note |
| PATCH | /api/v1/delivery-notes/{id} | Update a delivery note |
| DELETE | /api/v1/delivery-notes/{id} | Delete a delivery note |
| POST | /api/v1/delivery-notes/{id}/deliver | Mark as delivered |
| POST | /api/v1/delivery-notes/{id}/convert | Convert to invoice |
| GET | /api/v1/delivery-notes/{id}/pdf | Get PDF |
| POST | /api/v1/delivery-notes/{id}/send-email | Send by email |
GET
/api/v1/delivery-notesList delivery notes
Authentication required— Include session cookie or Bearer token
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
status | string | Optional | Filter by status (draft / delivered) |
company_id | string | Optional | Filter by company ID |
search | string | Optional | Search by delivery note number or subject |
limit | integer | Optional | Number of items to return (default: 20, max: 100) |
offset | integer | Optional | Offset for pagination (default: 0) |
Code Examples
curl "https://api.blueai.jp/api/v1/delivery-notes" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/delivery-notesCreate a delivery note
Authentication required— Include session cookie or Bearer token
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
company_id | string | Required | Company ID |
issue_date | string | Required | Issue date (YYYY-MM-DD) |
subject | string | Optional | Subject |
issuer_name | string | Optional | Issuer name |
issuer_detail | string | Optional | Issuer detail |
memo | string | Optional | Memo |
| object[] | Required | Line items |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/delivery-notes" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/delivery-notes/{id}Get a delivery note
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"PATCH
/api/v1/delivery-notes/{id}Update a delivery note
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Request Body
| Name | Type | Required | Description |
|---|---|---|---|
company_id | string | Optional | Company ID |
issue_date | string | Optional | Issue date (YYYY-MM-DD) |
subject | string | Optional | Subject |
issuer_name | string | Optional | Issuer name |
issuer_detail | string | Optional | Issuer detail |
memo | string | Optional | Memo |
| object[] | Optional | Line items |
Code Examples
curl -X PATCH "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"DELETE
/api/v1/delivery-notes/{id}Delete a delivery note
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl -X DELETE "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/delivery-notes/{id}/deliverMark as delivered
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000/deliver" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/delivery-notes/{id}/convertConvert to invoice
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000/convert" \
-H "Cookie: better-auth.session_token=<token>"GET
/api/v1/delivery-notes/{id}/pdfGet PDF
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000/pdf" \
-H "Cookie: better-auth.session_token=<token>"POST
/api/v1/delivery-notes/{id}/send-emailSend by email
Authentication required— Include session cookie or Bearer token
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Optional | Delivery note ID |
Code Examples
curl -X POST "https://api.blueai.jp/api/v1/delivery-notes/dn_123e4567e89b12d3a456426614174000/send-email" \
-H "Cookie: better-auth.session_token=<token>"