Issue invoice
POST
apiKeyheader
AuthorizationBearer <token>An API key (blk_…) from Settings → API keys.
id*stringapplication/json- response
id*stringnumber*string|nullstatus*stringValue in
"draft""issued""void"paymentStatus*stringValue in
"unpaid""partially_paid""paid"displayStatus*stringValue in
"draft""open""overdue""partially_paid""paid""void"isOverdue*booleantitle*string|nullclientId*stringclientName*stringquoteId*string|nullcurrency*stringissueDate*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datedueDate*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$Format
datesubtotal*integerRange
-9007199254740991 <= value <= 9007199254740991taxTotal*integerRange
-9007199254740991 <= value <= 9007199254740991total*integerRange
-9007199254740991 <= value <= 9007199254740991amountPaid*integerRange
-9007199254740991 <= value <= 9007199254740991amountCredited*integerRange
-9007199254740991 <= value <= 9007199254740991amountDue*integerRange
-9007199254740991 <= value <= 9007199254740991createdAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timeupdatedAt*stringMatch
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timequoteNumber*string|nullrecurringId*string|nullrecurringPeriod*string|nullnotes*string|nullterms*string|nulllines*array<>issuedAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timevoidedAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timevoidReason*string|nulllastSentAt*|Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timelastSentTo*string|nullremindersPaused*booleanreminders*array<>clientSnapshot*|nullissuerSnapshot*|nullcreditNotes*array<>curl -X POST 'https://your-billleaf-api/v1/invoices/string/issue'Example Response200
{ "id": "string", "number": "string", "status": "draft", "paymentStatus": "unpaid", "displayStatus": "draft", "isOverdue": true, "title": "string", "clientId": "string", "clientName": "string", "quoteId": "string", "currency": "string", "issueDate": "2019-08-24", "dueDate": "2019-08-24", "subtotal": -9007199254740991, "taxTotal": -9007199254740991, "total": -9007199254740991, "amountPaid": -9007199254740991, "amountCredited": -9007199254740991, "amountDue": -9007199254740991, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "quoteNumber": "string", "recurringId": "string", "recurringPeriod": "string", "notes": "string", "terms": "string", "lines": [ { "id": "string", "position": -9007199254740991, "description": "string", "quantity": 0, "unitPrice": -9007199254740991, "taxRateBps": -9007199254740991, "amount": -9007199254740991, "taxAmount": -9007199254740991 } ], "issuedAt": "2019-08-24T14:15:22Z", "voidedAt": "2019-08-24T14:15:22Z", "voidReason": "string", "lastSentAt": "2019-08-24T14:15:22Z", "lastSentTo": "string", "remindersPaused": true, "reminders": [ { "offsetDays": -9007199254740991, "sentTo": "string", "sentAt": "2019-08-24T14:15:22Z" } ], "clientSnapshot": { "name": "string", "legalName": "string", "email": "string", "phone": "string", "taxId": "string", "addressLines": [ "string" ] }, "issuerSnapshot": { "name": "string", "legalName": "string", "email": "string", "phone": "string", "taxId": "string", "addressLines": [ "string" ] }, "creditNotes": [ { "id": "string", "number": "string", "status": "issued", "issueDate": "2019-08-24", "total": -9007199254740991, "appliedAmount": -9007199254740991, "refundAmount": -9007199254740991 } ]}