Skip to Content
DevelopersAPI referenceInvoices

Send invoice

POST
/v1/invoices/{id}/send

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Path Parameters

id*string

Request Body

application/json
  1. body
to?string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
message?|
Lengthlength <= 2000

Response Body

application/json
  1. response
id*string
number*string|null
status*string
Value in"draft""issued""void"
paymentStatus*string
Value in"unpaid""partially_paid""paid"
displayStatus*string
Value in"draft""open""overdue""partially_paid""paid""void"
isOverdue*boolean
title*string|null
clientId*string
clientName*string
quoteId*string|null
currency*string
issueDate*string
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])))$
Formatdate
dueDate*|
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])))$
Formatdate
subtotal*integer
Range-9007199254740991 <= value <= 9007199254740991
taxTotal*integer
Range-9007199254740991 <= value <= 9007199254740991
total*integer
Range-9007199254740991 <= value <= 9007199254740991
amountPaid*integer
Range-9007199254740991 <= value <= 9007199254740991
amountCredited*integer
Range-9007199254740991 <= value <= 9007199254740991
amountDue*integer
Range-9007199254740991 <= value <= 9007199254740991
createdAt*string
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))$
Formatdate-time
updatedAt*string
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))$
Formatdate-time
quoteNumber*string|null
recurringId*string|null
recurringPeriod*string|null
notes*string|null
terms*string|null
lines*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))$
Formatdate-time
voidedAt*|
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))$
Formatdate-time
voidReason*string|null
lastSentAt*|
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))$
Formatdate-time
lastSentTo*string|null
remindersPaused*boolean
reminders*array<>
clientSnapshot*|null
issuerSnapshot*|null
creditNotes*array<>
Example Request
curl -X POST 'https://your-billleaf-api/v1/invoices/string/send' \  -H 'Content-Type: application/json' \  -d '{}'
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    }  ]}