Get Invoice Settings
Get the invoice settings for the given location
GET
/
invoices
/
settings
Get Invoice Settings
curl --request GET \
--url https://services.leadconnectorhq.com/invoices/settings \
--header 'Version: <version>'const options = {method: 'GET', headers: {Version: '<version>'}};
fetch('https://services.leadconnectorhq.com/invoices/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/invoices/settings"
headers = {"Version": "<version>"}
response = requests.get(url, headers=headers)
print(response.text){
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"termsNote": "Payment is due within 30 days.",
"estimatesTermsNote": "This estimate is valid for 30 days.",
"title": "INVOICE",
"estimatesTitle": "ESTIMATE",
"invoiceNumberPrefix": "INV-",
"estimateNumberPrefix": "EST-",
"dueAfterXDays": 30,
"estimatesExpireAfterXDays": 30,
"minimumPercentagePartialPayment": 25,
"customFields": [
"6578278e879ad2646715baxc",
"6901e9fb77ac4d701ba0b996"
],
"customNotification": {
"customerSendInvoice": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentInfo": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentAmountChanged": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentSkip": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamRecurringSendInvoiceFailed": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerSendEstimate": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamEstimateAccepted": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamEstimateDeclined": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
}
},
"businessDetails": {
"name": "<string>",
"logoUrl": "<string>",
"phoneNo": "<string>",
"address": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "AF",
"postalCode": "<string>"
},
"website": "<string>",
"customValues": [
"<string>"
]
},
"senderConfiguration": {
"fromName": "Alex",
"fromEmail": "alex@example.com"
},
"productSettings": {
"enableImportProductDescription": true,
"descriptionOptional": true
},
"reminderSettings": {
"defaultEmailTemplateId": "dhwjqi2899012990w2u",
"reminders": [
{
"enabled": true,
"emailTemplate": "default",
"smsTemplate": "default",
"emailSubject": "Reminder",
"reminderId": "9333e45f-a27d-4659-90e5-76c5ef06d094",
"reminderName": "Special Reminder",
"reminderTime": "before",
"intervalType": "daily",
"maxReminders": 3,
"reminderInvoiceCondition": "invoice_sent",
"reminderNumber": 10,
"startTime": "9:00 AM",
"endTime": "5:00 PM",
"timezone": "businessTZ"
}
]
},
"lateFeesConfiguration": {
"enable": true,
"value": 10,
"type": "fixed",
"frequency": {
"intervalCount": 10,
"interval": "day"
},
"grace": {
"intervalCount": 10,
"interval": "day"
},
"maxLateFees": {
"type": "fixed",
"value": "10"
}
},
"tipsConfiguration": {
"tipsPercentage": [
5,
10,
15
],
"tipsEnabled": true
},
"paymentMethods": {
"stripe": {
"enableBankDebitOnly": false
}
}
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}Query Parameters
Response
Successful response
Last modified on March 8, 2026
Was this page helpful?
Get Invoice Settings
curl --request GET \
--url https://services.leadconnectorhq.com/invoices/settings \
--header 'Version: <version>'const options = {method: 'GET', headers: {Version: '<version>'}};
fetch('https://services.leadconnectorhq.com/invoices/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://services.leadconnectorhq.com/invoices/settings"
headers = {"Version": "<version>"}
response = requests.get(url, headers=headers)
print(response.text){
"altId": "6578278e879ad2646715ba9c",
"altType": "location",
"termsNote": "Payment is due within 30 days.",
"estimatesTermsNote": "This estimate is valid for 30 days.",
"title": "INVOICE",
"estimatesTitle": "ESTIMATE",
"invoiceNumberPrefix": "INV-",
"estimateNumberPrefix": "EST-",
"dueAfterXDays": 30,
"estimatesExpireAfterXDays": 30,
"minimumPercentagePartialPayment": 25,
"customFields": [
"6578278e879ad2646715baxc",
"6901e9fb77ac4d701ba0b996"
],
"customNotification": {
"customerSendInvoice": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentSuccess": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentFailure": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentInfo": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerAutoPaymentAmountChanged": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamAutoPaymentSkip": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamRecurringSendInvoiceFailed": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"customerSendEstimate": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamEstimateAccepted": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
},
"teamEstimateDeclined": {
"enabled": true,
"emailTemplate": "<string>",
"smsTemplate": "<string>",
"fromName": "Alex",
"fromEmail": "alex@example.com",
"emailSubject": "Thank you for purchasing",
"defaultEmailTemplateId": "dhwjqi2899012990w2u"
}
},
"businessDetails": {
"name": "<string>",
"logoUrl": "<string>",
"phoneNo": "<string>",
"address": {
"addressLine1": "<string>",
"addressLine2": "<string>",
"city": "<string>",
"state": "<string>",
"countryCode": "AF",
"postalCode": "<string>"
},
"website": "<string>",
"customValues": [
"<string>"
]
},
"senderConfiguration": {
"fromName": "Alex",
"fromEmail": "alex@example.com"
},
"productSettings": {
"enableImportProductDescription": true,
"descriptionOptional": true
},
"reminderSettings": {
"defaultEmailTemplateId": "dhwjqi2899012990w2u",
"reminders": [
{
"enabled": true,
"emailTemplate": "default",
"smsTemplate": "default",
"emailSubject": "Reminder",
"reminderId": "9333e45f-a27d-4659-90e5-76c5ef06d094",
"reminderName": "Special Reminder",
"reminderTime": "before",
"intervalType": "daily",
"maxReminders": 3,
"reminderInvoiceCondition": "invoice_sent",
"reminderNumber": 10,
"startTime": "9:00 AM",
"endTime": "5:00 PM",
"timezone": "businessTZ"
}
]
},
"lateFeesConfiguration": {
"enable": true,
"value": 10,
"type": "fixed",
"frequency": {
"intervalCount": 10,
"interval": "day"
},
"grace": {
"intervalCount": 10,
"interval": "day"
},
"maxLateFees": {
"type": "fixed",
"value": "10"
}
},
"tipsConfiguration": {
"tipsPercentage": [
5,
10,
15
],
"tipsEnabled": true
},
"paymentMethods": {
"stripe": {
"enableBankDebitOnly": false
}
}
}{
"statusCode": 400,
"message": "Bad Request"
}{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}{
"statusCode": 422,
"message": [
"Unprocessable Entity"
],
"error": "Unprocessable Entity"
}