invoices

Create Invoice

post/api/v1/invoices/

Request

Base URL: https://api.peil.app (the document declares no server; this is the origin it was published from)
URL: https://api.peil.app/api/v1/invoices/
Auth: none declared

Request body

invoice_numberstring nullable

client_idinteger required

project_idinteger nullable

invoice_datestring date nullable

period_startstring date required

period_endstring date required

due_datestring date nullable

subtotalnumber nullable

vat_ratenumber nullable

total_hoursnumber nullable

reverse_chargeboolean nullable

status'draft' | 'sent' | 'paid' | 'overdue' | 'archived'

payment_datestring date nullable

notesstring nullable

pdf_pathstring nullable

payment_referencestring nullable

template_fieldsobject nullable

sourcestring nullable

time_entry_idsinteger[]

recurringboolean nullable

recurrence_interval'monthly' | 'quarterly' | 'annual' nullable

recurrence_anchor_dayinteger nullable

recurrence_project_idinteger nullable

parent_invoice_idinteger nullable

Response

Successful Response

invoice_numberstring nullable

client_idinteger required

project_idinteger nullable

invoice_datestring date nullable

period_startstring date nullable

period_endstring date nullable

due_datestring date nullable

subtotalnumber nullable

vat_ratenumber nullable

vat_amountnumber nullable

total_amountnumber nullable

total_hoursnumber nullable

reverse_chargeboolean nullable

statusstring

payment_datestring date nullable

notesstring nullable

pdf_pathstring nullable

recurringboolean nullable

recurrence_intervalstring nullable

recurrence_anchor_dayinteger nullable

recurrence_project_idinteger nullable

parent_invoice_idinteger nullable

email_sent_atstring date-time nullable

resend_email_idstring nullable

email_delivered_atstring date-time nullable

email_opened_atstring date-time nullable

email_bounced_atstring date-time nullable

email_failed_atstring date-time nullable

payment_referencestring nullable

last_reminder_atstring date-time nullable

reminder_countinteger

scheduled_send_atstring date-time nullable

template_fieldsobject nullable

idinteger required

created_atstring date-time required

updated_atstring date-time required

time_entry_idsinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.