Skip to main content
BlueAI
Home/Invoicing/Delivery Notes

Delivery Notes

Create delivery notes, mark as delivered, and convert to invoices.

|

Endpoints

GET/api/v1/delivery-notesList delivery notes
POST/api/v1/delivery-notesCreate 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}/deliverMark as delivered
POST/api/v1/delivery-notes/{id}/convertConvert to invoice
GET/api/v1/delivery-notes/{id}/pdfGet PDF
POST/api/v1/delivery-notes/{id}/send-emailSend by email
GET/api/v1/delivery-notes

List delivery notes

Authentication requiredInclude session cookie or Bearer token

Query Parameters

NameTypeRequiredDescription
status
stringOptionalFilter by status (draft / delivered)
company_id
stringOptionalFilter by company ID
search
stringOptionalSearch by delivery note number or subject
limit
integerOptionalNumber of items to return (default: 20, max: 100)
offset
integerOptionalOffset 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-notes

Create a delivery note

Authentication requiredInclude session cookie or Bearer token

Request Body

NameTypeRequiredDescription
company_id
stringRequiredCompany ID
issue_date
stringRequiredIssue date (YYYY-MM-DD)
subject
stringOptionalSubject
issuer_name
stringOptionalIssuer name
issuer_detail
stringOptionalIssuer detail
memo
stringOptionalMemo
object[]RequiredLine 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 requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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 requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery note ID

Request Body

NameTypeRequiredDescription
company_id
stringOptionalCompany ID
issue_date
stringOptionalIssue date (YYYY-MM-DD)
subject
stringOptionalSubject
issuer_name
stringOptionalIssuer name
issuer_detail
stringOptionalIssuer detail
memo
stringOptionalMemo
object[]OptionalLine 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 requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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}/deliver

Mark as delivered

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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}/convert

Convert to invoice

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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}/pdf

Get PDF

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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-email

Send by email

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalDelivery 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>"