Skip to Content
DevelopersAPI referenceQuotes

Get quote

GET
/v1/quotes/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

application/json
  1. response
id*string
number*string|null
status*string
Value in"draft""sent""accepted""declined"
isExpired*boolean
title*string|null
clientId*string
clientName*string
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
validUntil*|
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
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
notes*string|null
terms*string|null
lines*array<>
sentAt*|
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
acceptedAt*|
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
declinedAt*|
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
respondedByName*string|null
respondedVia*|
Value in"manual""portal"null
declineReason*string|null
clientSnapshot*|null
issuerSnapshot*|null
invoiceId*string|null
invoiceNumber*string|null
Example Request
curl -X GET 'https://your-billleaf-api/v1/quotes/string'
Example Response200
{  "id": "string",  "number": "string",  "status": "draft",  "isExpired": true,  "title": "string",  "clientId": "string",  "clientName": "string",  "currency": "string",  "issueDate": "2019-08-24",  "validUntil": "2019-08-24",  "subtotal": -9007199254740991,  "taxTotal": -9007199254740991,  "total": -9007199254740991,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "notes": "string",  "terms": "string",  "lines": [    {      "id": "string",      "position": -9007199254740991,      "description": "string",      "quantity": 0,      "unitPrice": -9007199254740991,      "taxRateBps": -9007199254740991,      "amount": -9007199254740991,      "taxAmount": -9007199254740991    }  ],  "sentAt": "2019-08-24T14:15:22Z",  "acceptedAt": "2019-08-24T14:15:22Z",  "declinedAt": "2019-08-24T14:15:22Z",  "respondedByName": "string",  "respondedVia": "manual",  "declineReason": "string",  "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"    ]  },  "invoiceId": "string",  "invoiceNumber": "string"}