Skip to main content
BlueAI
Home/Invoicing/Purchase Orders

Purchase Orders

Create, send, accept, and convert purchase orders to invoices.

|

Endpoints

GET/api/v1/purchase-ordersList purchase orders
POST/api/v1/purchase-ordersCreate a purchase order
GET/api/v1/purchase-orders/{id}Get a purchase order
PATCH/api/v1/purchase-orders/{id}Update a purchase order
DELETE/api/v1/purchase-orders/{id}Delete a purchase order
POST/api/v1/purchase-orders/{id}/sendMark as sent
POST/api/v1/purchase-orders/{id}/acceptAccept
POST/api/v1/purchase-orders/{id}/convertConvert to invoice
GET/api/v1/purchase-orders/{id}/pdfGet PDF
POST/api/v1/purchase-orders/{id}/send-emailSend by email
GET/api/v1/purchase-orders

List purchase orders

Authentication requiredInclude session cookie or Bearer token

Query Parameters

NameTypeRequiredDescription
status
stringOptionalFilter by status (draft / sent / accepted)
company_id
stringOptionalFilter by company ID
search
stringOptionalSearch by purchase order 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/purchase-orders" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/purchase-orders

Create a purchase order

Authentication requiredInclude session cookie or Bearer token

Request Body

NameTypeRequiredDescription
company_id
stringRequiredCompany ID
issue_date
stringRequiredIssue date (YYYY-MM-DD)
due_date
stringOptionalDelivery deadline (YYYY-MM-DD)
subject
stringOptionalSubject
issuer_name
stringOptionalIssuer name
issuer_detail
stringOptionalIssuer detail
memo
stringOptionalMemo
tax_display_mode
stringOptionalTax display mode (inclusive / exclusive)
tax_rounding
stringOptionalTax rounding (round / floor / ceil)
object[]RequiredLine items

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/purchase-orders" \
  -H "Cookie: better-auth.session_token=<token>"
GET/api/v1/purchase-orders/{id}

Get a purchase order

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
PATCH/api/v1/purchase-orders/{id}

Update a purchase order

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Request Body

NameTypeRequiredDescription
company_id
stringOptionalCompany ID
issue_date
stringOptionalIssue date (YYYY-MM-DD)
due_date
stringOptionalDelivery deadline (YYYY-MM-DD)
subject
stringOptionalSubject
issuer_name
stringOptionalIssuer name
issuer_detail
stringOptionalIssuer detail
memo
stringOptionalMemo
tax_display_mode
stringOptionalTax display mode (inclusive / exclusive)
tax_rounding
stringOptionalTax rounding (round / floor / ceil)
object[]OptionalLine items

Code Examples

curl -X PATCH "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
DELETE/api/v1/purchase-orders/{id}

Delete a purchase order

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl -X DELETE "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/purchase-orders/{id}/send

Mark as sent

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000/send" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/purchase-orders/{id}/accept

Accept

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000/accept" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/purchase-orders/{id}/convert

Convert to invoice

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000/convert" \
  -H "Cookie: better-auth.session_token=<token>"
GET/api/v1/purchase-orders/{id}/pdf

Get PDF

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000/pdf" \
  -H "Cookie: better-auth.session_token=<token>"
POST/api/v1/purchase-orders/{id}/send-email

Send by email

Authentication requiredInclude session cookie or Bearer token

Path Parameters

NameTypeRequiredDescription
id
stringOptionalPurchase order ID

Code Examples

curl -X POST "https://api.blueai.jp/api/v1/purchase-orders/po_123e4567e89b12d3a456426614174000/send-email" \
  -H "Cookie: better-auth.session_token=<token>"