# Get Invoice Settings GET https://services.leadconnectorhq.com/invoices/settings Get the invoice settings for the given location ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `invoices.readonly` - **Agency token: OAuth access token or Private Integration Token.** Scopes: `invoices.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `altId` | string | Yes | Location Id or Agency Id | | `altType` | string | Yes | | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/invoices/settings": { "get": { "summary": "Get Invoice Settings", "operationId": "getInvoiceSettings", "description": "Get the invoice settings for the given location", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "altId", "required": true, "in": "query", "description": "Location Id or Agency Id", "schema": { "example": "6578278e879ad2646715ba9c", "type": "string" } }, { "name": "altType", "required": true, "in": "query", "schema": { "enum": [ "location" ], "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetInvoiceSettingsResponseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "Location-Access": [ "invoices.readonly" ] }, { "Agency-Access": [ "invoices.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "GetInvoiceSettingsResponseDto": { "type": "object", "properties": { "altId": { "type": "string", "description": "Sub-Account Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "description": "Alt Type", "enum": [ "location" ], "example": "location" }, "termsNote": { "type": "string", "description": "Terms and conditions for invoices", "example": "Payment is due within 30 days." }, "estimatesTermsNote": { "type": "string", "description": "Terms and conditions for estimates", "example": "This estimate is valid for 30 days." }, "title": { "type": "string", "description": "Title for invoices", "example": "INVOICE", "maxLength": 40 }, "estimatesTitle": { "type": "string", "description": "Title for estimates", "example": "ESTIMATE", "maxLength": 40 }, "invoiceNumberPrefix": { "type": "string", "description": "Prefix for invoice numbers", "example": "INV-", "maxLength": 10 }, "estimateNumberPrefix": { "type": "string", "description": "Prefix for estimate numbers", "example": "EST-", "maxLength": 10 }, "dueAfterXDays": { "type": "number", "description": "Number of days after which invoice is due", "example": 30 }, "estimatesExpireAfterXDays": { "type": "number", "description": "Number of days after which estimate expires", "example": 30 }, "minimumPercentagePartialPayment": { "type": "number", "description": "Minimum percentage for partial payment", "example": 25 }, "customFields": { "description": "Custom fields array", "example": [ "6578278e879ad2646715baxc", "6901e9fb77ac4d701ba0b996" ], "maxItems": 3, "type": "array", "items": { "type": "string" } }, "customNotification": { "description": "Custom notification settings", "allOf": [ { "type": "object", "properties": { "customerSendInvoice": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamPaymentSuccess": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerPaymentSuccess": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamAutoPaymentSuccess": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerAutoPaymentSuccess": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamPaymentFailure": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerPaymentFailure": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamAutoPaymentFailure": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerAutoPaymentFailure": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerAutoPaymentInfo": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerAutoPaymentAmountChanged": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamAutoPaymentSkip": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamRecurringSendInvoiceFailed": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "customerSendEstimate": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamEstimateAccepted": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" }, "teamEstimateDeclined": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the notification is enabled or not" }, "emailTemplate": { "type": "string", "description": "Template to be used for sending email" }, "smsTemplate": { "type": "string", "description": "Template to be used for sending sms" }, "fromName": { "type": "string", "description": "Name to be used while sending email", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email address to be used for sending email", "example": "alex@example.com" }, "emailSubject": { "type": "string", "description": "Subject of email which is sent out", "example": "Thank you for purchasing" }, "defaultEmailTemplateId": { "type": "string", "description": "Default email TemplateId to be used for sending via email", "example": "dhwjqi2899012990w2u" } }, "required": [ "enabled", "emailTemplate", "smsTemplate" ], "title": "CustomNotificationItemDto" } }, "required": [ "customerSendInvoice", "teamPaymentSuccess", "customerPaymentSuccess", "teamAutoPaymentSuccess", "customerAutoPaymentSuccess", "teamPaymentFailure", "customerPaymentFailure", "teamAutoPaymentFailure", "customerAutoPaymentFailure", "customerAutoPaymentInfo", "customerAutoPaymentAmountChanged", "teamAutoPaymentSkip", "teamRecurringSendInvoiceFailed", "customerSendEstimate", "teamEstimateAccepted", "teamEstimateDeclined" ], "title": "CustomNotificationDto" } ] }, "businessDetails": { "description": "Business details", "allOf": [ { "type": "object", "properties": { "logoUrl": { "type": "string" }, "name": { "type": "string" }, "phoneNo": { "type": "string" }, "address": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "countryCode": { "type": "string", "enum": [ "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CD", "CK", "CR", "CI", "HR", "CU", "CY", "CZ", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KP", "KR", "XK", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "GB", "UA", "AE", "US", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW" ] }, "postalCode": { "type": "string" } }, "title": "Address" }, "website": { "type": "string" }, "customValues": { "type": "array", "items": { "type": "string" } } }, "required": [ "name" ], "title": "InvoiceSettingsBusinessDetailsDto" } ] }, "senderConfiguration": { "description": "Sender configuration", "allOf": [ { "type": "object", "properties": { "fromName": { "type": "string", "description": "Sender name to be used while sending email notification", "example": "Alex" }, "fromEmail": { "type": "string", "description": "Email id to be used while sending email notification", "example": "alex@example.com" } }, "title": "InvoiceSettingsSenderConfigurationDto" } ] }, "productSettings": { "description": "Product settings", "allOf": [ { "type": "object", "properties": { "enableImportProductDescription": { "type": "boolean", "description": "Flag indicating if the product description import is enabled or not", "example": true }, "descriptionOptional": { "type": "boolean", "description": "Flag indicating if the product description is optional or not", "example": true } }, "title": "InvoiceProductSettingsDto" } ] }, "reminderSettings": { "description": "Reminder settings", "allOf": [ { "type": "object", "properties": { "defaultEmailTemplateId": { "type": "string", "description": "default template Id of reminder", "example": "dhwjqi2899012990w2u" }, "reminders": { "description": "List of reminders", "type": "array", "items": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Flag indicating if the reminder is enabled or not", "example": true }, "emailTemplate": { "type": "string", "description": "Email template to be used for sending reminders", "example": "default" }, "smsTemplate": { "type": "string", "description": "SMS template to be used for sending reminders", "example": "default" }, "emailSubject": { "type": "string", "description": "Subject of the reminder", "example": "Reminder" }, "reminderId": { "type": "string", "description": "Unique identifier for the reminder", "example": "9333e45f-a27d-4659-90e5-76c5ef06d094" }, "reminderName": { "type": "string", "description": "Name of the reminder", "example": "Special Reminder" }, "reminderTime": { "type": "string", "description": "Time condition for the reminder", "example": "before", "enum": [ "before", "after" ] }, "intervalType": { "type": "string", "description": "Interval type for the reminder", "example": "daily", "enum": [ "yearly", "monthly", "weekly", "daily", "hourly", "minutely", "secondly" ] }, "maxReminders": { "type": "number", "description": "Maximum number of reminders that can be sent", "example": 3 }, "reminderInvoiceCondition": { "type": "string", "description": "Condition for sending the reminder", "example": "invoice_sent", "enum": [ "invoice_sent", "invoice_overdue" ] }, "reminderNumber": { "type": "number", "description": "frequency gap of the reminder to exeucte", "example": 10 }, "startTime": { "type": "string", "description": "Business Hour Start Time", "example": "9:00 AM" }, "endTime": { "type": "string", "description": "Business Hour End Time", "example": "5:00 PM" }, "timezone": { "type": "string", "description": "Timezone at which reminder will be sent", "example": "businessTZ" } }, "required": [ "enabled", "emailTemplate", "smsTemplate", "emailSubject", "reminderId", "reminderName", "reminderTime", "intervalType", "maxReminders", "reminderInvoiceCondition", "reminderNumber" ], "title": "ReminderDto" } } }, "required": [ "defaultEmailTemplateId", "reminders" ], "title": "ReminderSettingsDto" } ] }, "lateFeesConfiguration": { "description": "Late fees configuration", "allOf": [ { "type": "object", "properties": { "enable": { "type": "boolean", "description": "Enable late fees", "example": true }, "value": { "type": "number", "description": "Late Fees Value", "example": 10 }, "type": { "type": "string", "description": "Late Fees Type", "example": "fixed", "enum": [ "fixed", "percentage" ] }, "frequency": { "description": "Late Fees Frequency", "allOf": [ { "type": "object", "properties": { "intervalCount": { "type": "number", "description": "Late fees interval count", "example": 10 }, "interval": { "type": "string", "description": "Late fees interval", "example": "day", "enum": [ "minute", "hour", "day", "week", "month", "one_time" ] } }, "required": [ "intervalCount", "interval" ], "title": "LateFeesFrequencyDto" } ] }, "grace": { "description": "Late Fees Grace", "allOf": [ { "type": "object", "properties": { "intervalCount": { "type": "number", "description": "Late fees grace interval count", "example": 10 }, "interval": { "type": "string", "description": "Late fees grace interval", "example": "day", "enum": [ "day" ] } }, "required": [ "intervalCount", "interval" ], "title": "LateFeesGraceDto" } ] }, "maxLateFees": { "description": "Max late fees payable", "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "example": "fixed", "enum": [ "fixed" ] }, "value": { "type": "number", "example": "10", "description": "Max late fees to pay" } }, "required": [ "type", "value" ], "title": "LateFeesMaxFeesDto" } ] } }, "required": [ "enable", "value", "type", "frequency" ], "title": "LateFeesConfigurationDto" } ] }, "tipsConfiguration": { "description": "Tips configuration", "allOf": [ { "type": "object", "properties": { "tipsPercentage": { "description": "Percentage of tips allowed", "example": [ 5, 10, 15 ], "type": "array", "items": { "type": "string" } }, "tipsEnabled": { "type": "boolean", "description": "Tips enabled status", "example": true } }, "required": [ "tipsPercentage", "tipsEnabled" ], "title": "TipsConfigurationDto" } ] }, "paymentMethods": { "description": "Payment methods configuration", "allOf": [ { "type": "object", "properties": { "stripe": { "description": "Payment Method", "allOf": [ { "type": "object", "properties": { "enableBankDebitOnly": { "type": "boolean", "description": "Enable Bank Debit Only", "example": false } }, "required": [ "enableBankDebitOnly" ], "title": "StripePaymentMethodDto" } ] } }, "required": [ "stripe" ], "title": "PaymentMethodDto" } ] } }, "title": "GetInvoiceSettingsResponseDto" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/invoices/settings?altId=&altType=' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/invoices/settings?altId=&altType=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/invoices/settings" headers = { "Authorization": "Bearer ", "Version": "v3" } params = { "altId": "", "altType": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/invoices/settings?altId=&altType=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/invoices/settings?altId=&altType=") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/invoices/settings?altId=&altType=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/invoices/settings?altId=&altType=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/invoices/settings?altId=&altType=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```