# Update invoice late fees configuration PATCH https://services.leadconnectorhq.com/invoices/{invoiceId}/late-fees-configuration API to update invoice late fees configuration by invoice id ## Authentication Send `Authorization: Bearer ` using any one of: - **Sub-Account token: OAuth access token or Private Integration Token.** No scopes required. - **Agency token: OAuth access token or Private Integration Token.** No scopes required. ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `invoiceId` | string | Yes | Invoice Id | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/invoices/{invoiceId}/late-fees-configuration": { "patch": { "summary": "Update invoice late fees configuration", "operationId": "updateInvoiceLateFeesConfiguration", "description": "API to update invoice late fees configuration by invoice id", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "invoiceId", "required": true, "in": "path", "description": "Invoice Id", "schema": { "example": "6578278e879ad2646715ba9c", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceLateFeesConfigurationDto" } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInvoiceResponseDto" } } } }, "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": [] }, { "Agency-Access": [] } ] } } }, "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": { "UpdateInvoiceLateFeesConfigurationDto": { "type": "object", "properties": { "altId": { "type": "string", "description": "location Id / company Id based on altType", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "description": "Alt Type", "enum": [ "location" ], "example": "location" }, "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" } ] } }, "required": [ "altId", "altType", "lateFeesConfiguration" ], "title": "UpdateInvoiceLateFeesConfigurationDto" }, "UpdateInvoiceResponseDto": { "type": "object", "properties": { "_id": { "type": "string", "description": "Invoice Id", "example": "6578278e879ad2646715ba9c" }, "status": { "type": "string", "description": "Invoice Status", "example": "draft", "enum": [ "draft", "sent", "payment_processing", "paid", "void", "partially_paid" ] }, "liveMode": { "type": "boolean", "description": "Live Mode", "example": false }, "amountPaid": { "type": "number", "description": "Amount Paid", "example": 0 }, "altId": { "type": "string", "description": "Location Id or Agency Id", "example": "6578278e879ad2646715ba9c" }, "altType": { "type": "string", "enum": [ "location" ] }, "name": { "type": "string", "description": "Name of the invoice", "example": "New Invoice" }, "businessDetails": { "type": "object", "description": "Business Details", "example": { "name": "Alex", "address": { "addressLine1": "9931 Beechwood", "city": "St. Houston", "state": "TX", "countryCode": "USA", "postalCode": "559-6993" }, "phoneNo": "+1-214-559-6993", "website": "www.example.com" } }, "invoiceNumber": { "type": "number", "description": "Invoice Number", "example": "19" }, "currency": { "type": "string", "description": "Currency", "example": "USD" }, "contactDetails": { "type": "object", "description": "Contact Details", "example": { "id": "c6tZZU0rJBf30ZXx9Gli", "phoneNo": "+1-214-559-6993", "email": "alex@example.com", "customFields": [], "name": "Alex", "address": { "countryCode": "US" } } }, "issueDate": { "type": "string", "description": "Issue date in YYYY-MM-DD format", "example": "2023-01-01" }, "dueDate": { "type": "string", "description": "Due date in YYYY-MM-DD format", "example": "2023-01-01" }, "discount": { "type": "object", "description": "Discount", "example": { "type": "percentage", "value": 0 } }, "invoiceItems": { "description": "Invoice Items", "example": [ { "taxes": [], "_id": "c6tZZU0rJBf30ZXx9Gli", "productId": "c6tZZU0rJBf30ZXx9Gli", "priceId": "c6tZZU0rJBf30ZXx9Gli", "currency": "USD", "name": "Macbook Pro", "qty": 1, "amount": 999 } ], "type": "array", "items": { "type": "string" } }, "total": { "type": "number", "description": "Total Amount", "example": 999 }, "title": { "type": "string", "description": "Title", "example": "INVOICE" }, "amountDue": { "type": "number", "description": "Total Amount Due", "example": 999 }, "createdAt": { "type": "string", "description": "created at", "example": "2023-12-12T09:27:42.355Z" }, "updatedAt": { "type": "string", "description": "updated at", "example": "2023-12-12T09:27:42.355Z" }, "automaticTaxesEnabled": { "type": "boolean", "description": "Automatic taxes enabled for the Invoice", "example": true }, "automaticTaxesCalculated": { "type": "boolean", "description": "Is Automatic taxes calculated for the Invoice items", "example": true }, "paymentSchedule": { "type": "object", "description": "split invoice into payment schedule summing up to full invoice amount" } }, "required": [ "_id", "status", "liveMode", "amountPaid", "altId", "altType", "name", "businessDetails", "invoiceNumber", "currency", "contactDetails", "issueDate", "dueDate", "invoiceItems", "total", "title", "amountDue", "createdAt", "updatedAt" ], "title": "UpdateInvoiceResponseDto" }, "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 PATCH 'https://services.leadconnectorhq.com/invoices//late-fees-configuration' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' \ -H 'Content-Type: application/json' \ --data-raw '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }' ``` **Node.js** ```javascript const options = { method: 'PATCH', headers: { Authorization: 'Bearer ', Version: 'v3', 'Content-Type': 'application/json' }, body: JSON.stringify({ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }) }; try { const response = await fetch('https://services.leadconnectorhq.com/invoices//late-fees-configuration', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/invoices/{invoiceId}/late-fees-configuration" headers = { "Authorization": "Bearer ", "Version": "v3" } payload = { "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/invoices//late-fees-configuration', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }', ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .patch("https://services.leadconnectorhq.com/invoices//late-fees-configuration") .header("Authorization", "Bearer ") .header("Version", "v3") .header("Content-Type", "application/json") .body("{\"altId\":\"6578278e879ad2646715ba9c\",\"altType\":\"location\",\"lateFeesConfiguration\":{\"enable\":true,\"value\":10,\"type\":\"fixed\",\"frequency\":{\"intervalCount\":10,\"interval\":\"day\"},\"grace\":{\"intervalCount\":10,\"interval\":\"day\"},\"maxLateFees\":{\"type\":\"fixed\",\"value\":\"10\"}}}") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" "strings" ) func main() { url := "https://services.leadconnectorhq.com/invoices//late-fees-configuration" payload := strings.NewReader(`{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }`) req, _ := http.NewRequest("PATCH", url, payload) 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//late-fees-configuration") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" request["Content-Type"] = "application/json" request.body = '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }' response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $body = '{ "altId": "6578278e879ad2646715ba9c", "altType": "location", "lateFeesConfiguration": { "enable": true, "value": 10, "type": "fixed", "frequency": { "intervalCount": 10, "interval": "day" }, "grace": { "intervalCount": 10, "interval": "day" }, "maxLateFees": { "type": "fixed", "value": "10" } } }' $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/invoices//late-fees-configuration' -Method 'PATCH' -Headers $headers -Body $body -ContentType 'application/json' $response | ConvertTo-Json ```