Skip to main content
GET
/
invoices
/
settings
Get Invoice Settings
curl --request GET \
  --url https://services.leadconnectorhq.com/invoices/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Version: <version>'
{
  "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
    }
  }
}

Authorizations

​
Authorization
string
header
required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

​
Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

​
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required
Available options:
location

Response

Successful response

​
altId
string

Sub-Account Id

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>

Alt Type

Available options:
location
Example:

"location"

​
termsNote
string

Terms and conditions for invoices

Example:

"Payment is due within 30 days."

​
estimatesTermsNote
string

Terms and conditions for estimates

Example:

"This estimate is valid for 30 days."

​
title
string

Title for invoices

Maximum string length: 40
Example:

"INVOICE"

​
estimatesTitle
string

Title for estimates

Maximum string length: 40
Example:

"ESTIMATE"

​
invoiceNumberPrefix
string

Prefix for invoice numbers

Maximum string length: 10
Example:

"INV-"

​
estimateNumberPrefix
string

Prefix for estimate numbers

Maximum string length: 10
Example:

"EST-"

​
dueAfterXDays
number

Number of days after which invoice is due

Example:

30

​
estimatesExpireAfterXDays
number

Number of days after which estimate expires

Example:

30

​
minimumPercentagePartialPayment
number

Minimum percentage for partial payment

Example:

25

​
customFields
string[]

Custom fields array

Maximum array length: 3
Example:
[
  "6578278e879ad2646715baxc",
  "6901e9fb77ac4d701ba0b996"
]
​
customNotification
object
​
businessDetails
object
​
senderConfiguration
object
​
productSettings
object
​
reminderSettings
object
​
lateFeesConfiguration
object
​
tipsConfiguration
object
​
paymentMethods
object
Last modified on March 4, 2026