actionEnumRequired
"GENERATE": string"UPDATE_STATUS": string"PROCESS_PASTDUE": string"UPSERT_DEFAULTS": stringDefault value of this property is "GENERATE"
statusUpdatesarrayOptional
Default value of this property is []
invoicesarrayOptional
Default value of this property is [{"invoiceNumber":"INV-2025-001","issueDate":"2025-01-15","dueDate":"2025-02-15","currency":"USD","seller":{"name":"Your Company Name","address":"123 Business St","city":"New York","state":"NY","zipCode":"10001","country":"USA","email":"billing@company.com","phone":"+1-555-0123"},"buyer":{"name":"Client Company","address":"456 Client Ave","city":"Los Angeles","state":"CA","zipCode":"90001","country":"USA"},"items":[{"description":"Web Development Services","quantity":40,"unitPrice":150,"taxRate":0.1}],"notes":"Payment due within 30 days. Thank you for your business!","terms":"Net 30","status":"SENT","customFields":{"PO Number":"PO-12345","Project Code":"PROJ-001"}}]
numberingSchemestringOptional
Default value of this property is "INV-{YYYY}-{MM}-{####}"
allowDuplicatesbooleanOptional
Default value of this property is false
outputobjectOptional
Default value of this property is {"pdf":true,"html":false,"json":false}
templateobjectOptional
Default value of this property is {"layout":"standard","primaryColor":"#2563eb","secondaryColor":"#64748b","fontFamily":"Helvetica"}
defaultsobjectOptional
Default value of this property is {"seller":{"name":"Your Company Name","address":"123 Business St","city":"New York","state":"NY","zipCode":"10001","country":"USA","email":"billing@company.com","phone":"+1-555-0123"},"template":{"layout":"standard","primaryColor":"#2563eb","secondaryColor":"#64748b","logoUrl":"","fontFamily":"Helvetica"}}