v1

latestOpenAPI 3.0.02026-08-068926279.2 KB
Invoices

Update an invoice

Updates an existing invoice

put/invoices/{id}

Path parameters

idinteger required

Invoice ID

Request body

client_idinteger
project_idinteger
document_idstring
issue_datestring date
due_datestring date
statusstring
discountnumber
shippingnumber
line_itemsobject[]

Response

Invoice updated

idinteger
client_idinteger nullable
project_idinteger nullable
uuidstring uuid
document_idstring
po_numberstring nullable
subjectstring nullable
issue_datestring date
payment_dueinteger

Days until payment due

due_datestring date
status'draft' | 'sent' | 'viewed' | 'partial' | 'paid' | 'processing'
shippingnumber
discountnumber
totalnumber
amount_paidnumber
amount_duenumber
outstandingnumber
company_namestring nullable
addressstring nullable
emailstring email nullable
phonestring nullable
notestring nullable
send_atstring date-time nullable
auto_billingboolean
online_paymentboolean
accept_achboolean
hide_qty_price_columnsboolean
automatically_send_payment_remindersboolean
created_atstring date-time

Example response

{
  "id": 1,
  "client_id": 1,
  "project_id": 1,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "document_id": "INV-001",
  "po_number": "PO-12345",
  "subject": "Website Development - January",
  "issue_date": "2024-01-15",
  "payment_due": 30,
  "due_date": "2024-02-15",
  "status": "sent",
  "total": 1500,
  "amount_due": 1500,
  "outstanding": 1500,
  "company_name": "Acme Corporation",
  "address": "123 Main St",
  "email": "billing@acme.com",
  "phone": "555-1234",
  "note": "Thank you for your business!",
  "online_payment": true,
  "automatically_send_payment_reminders": true
}