Skip to main content
PUT
/
invoices
/
{invoiceId}
Update invoice
curl --request PUT \
  --url https://services.leadconnectorhq.com/invoices/{invoiceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data @- <<EOF
{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "currency": "USD",
  "invoiceItems": [
    {
      "name": "ABC Product",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "taxes": [
        {
          "_id": "<string>",
          "name": "<string>",
          "rate": 123,
          "calculation": "exclusive",
          "description": "<string>",
          "taxId": "<string>"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-14",
  "title": "INVOICE",
  "description": "ABC Corp payments",
  "businessDetails": {
    "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": "1001",
  "contactId": "6578278e879ad2646715ba9c",
  "contactDetails": {
    "id": "6578278e879ad2646715ba9c",
    "name": "Alex",
    "phoneNo": "+1234567890",
    "email": "alex@example.com",
    "additionalEmails": [
      {
        "email": "alex@example.com"
      }
    ],
    "companyName": "ABC Corp.",
    "address": {
      "addressLine1": "9931 Beechwood",
      "addressLine2": "Beechwood",
      "city": "St. Houston",
      "state": "TX",
      "countryCode": "US",
      "postalCode": "559-6993"
    },
    "customFields": [
      "<string>"
    ]
  },
  "termsNotes": "<p>This is a default terms.</p>",
  "discount": {
    "type": "percentage",
    "value": 10,
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "automaticTaxesEnabled": true,
  "liveMode": true,
  "paymentSchedule": {
    "type": "percentage",
    "schedules": [
      "<string>"
    ]
  },
  "tipsConfiguration": {
    "tipsPercentage": [
      5,
      10,
      15
    ],
    "tipsEnabled": true
  },
  "xeroDetails": {},
  "invoiceNumberPrefix": "INV-",
  "paymentMethods": {
    "stripe": {
      "enableBankDebitOnly": false
    }
  },
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ],
  "miscellaneousCharges": {
    "charges": [
      "<array>"
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  }
}
EOF
{
  "_id": "6578278e879ad2646715ba9c",
  "status": "draft",
  "liveMode": false,
  "amountPaid": 0,
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "businessDetails": {
    "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": "19",
  "currency": "USD",
  "contactDetails": {
    "id": "c6tZZU0rJBf30ZXx9Gli",
    "phoneNo": "+1-214-559-6993",
    "email": "alex@example.com",
    "customFields": [],
    "name": "Alex",
    "address": {
      "countryCode": "US"
    }
  },
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "invoiceItems": [
    {
      "taxes": [],
      "_id": "c6tZZU0rJBf30ZXx9Gli",
      "productId": "c6tZZU0rJBf30ZXx9Gli",
      "priceId": "c6tZZU0rJBf30ZXx9Gli",
      "currency": "USD",
      "name": "Macbook Pro",
      "qty": 1,
      "amount": 999
    }
  ],
  "total": 999,
  "title": "INVOICE",
  "amountDue": 999,
  "createdAt": "2023-12-12T09:27:42.355Z",
  "updatedAt": "2023-12-12T09:27:42.355Z",
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "automaticTaxesEnabled": true,
  "automaticTaxesCalculated": true,
  "paymentSchedule": {}
}

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

Path Parameters

​
invoiceId
string
required

Invoice Id

Example:

"6578278e879ad2646715ba9c"

Body

application/json
​
altId
string
required

location Id / company Id based on altType

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required

Alt Type

Available options:
location
Example:

"location"

​
name
string
required

Name to be updated

Example:

"New Invoice"

​
currency
string
required

Currency

Example:

"USD"

​
invoiceItems
object[]
required
​
issueDate
string
required

Issue date in YYYY-MM-DD format

Example:

"2023-01-01"

​
dueDate
string
required

Due date in YYYY-MM-DD format

Example:

"2023-01-14"

​
title
string

Title for the invoice

Example:

"INVOICE"

​
description
string

Description

Example:

"ABC Corp payments"

​
businessDetails
object
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
string

Invoice Number

Example:

"1001"

​
contactId
string

Id of the contact which you need to send the invoice

Example:

"6578278e879ad2646715ba9c"

​
contactDetails
object
​
termsNotes
string

Terms notes, Also supports HTML markups

Example:

"<p>This is a default terms.</p>"

​
discount
object
​
automaticTaxesEnabled
boolean

Automatic taxes enabled for the Invoice

Example:

true

​
liveMode
boolean

Payment mode

​
paymentSchedule
object
​
tipsConfiguration
object
​
xeroDetails
object
​
invoiceNumberPrefix
string

prefix for invoice number

Example:

"INV-"

​
paymentMethods
object
​
attachments
object[]

attachments for the invoice

​
miscellaneousCharges
object

Response

Successful response

​
_id
string
required

Invoice Id

Example:

"6578278e879ad2646715ba9c"

​
status
enum<string>
required

Invoice Status

Available options:
draft,
sent,
payment_processing,
paid,
void,
partially_paid
Example:

"draft"

​
liveMode
boolean
required

Live Mode

Example:

false

​
amountPaid
number
required

Amount Paid

Example:

0

​
altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

​
altType
enum<string>
required
Available options:
location
​
name
string
required

Name of the invoice

Example:

"New Invoice"

​
businessDetails
object
required

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
number
required

Invoice Number

Example:

"19"

​
currency
string
required

Currency

Example:

"USD"

​
contactDetails
object
required

Contact Details

Example:
{
  "id": "c6tZZU0rJBf30ZXx9Gli",
  "phoneNo": "+1-214-559-6993",
  "email": "alex@example.com",
  "customFields": [],
  "name": "Alex",
  "address": { "countryCode": "US" }
}
​
issueDate
string
required

Issue date in YYYY-MM-DD format

Example:

"2023-01-01"

​
dueDate
string
required

Due date in YYYY-MM-DD format

Example:

"2023-01-01"

​
invoiceItems
string[]
required

Invoice Items

Example:
[
  {
    "taxes": [],
    "_id": "c6tZZU0rJBf30ZXx9Gli",
    "productId": "c6tZZU0rJBf30ZXx9Gli",
    "priceId": "c6tZZU0rJBf30ZXx9Gli",
    "currency": "USD",
    "name": "Macbook Pro",
    "qty": 1,
    "amount": 999
  }
]
​
total
number
required

Total Amount

Example:

999

​
title
string
required

Title

Example:

"INVOICE"

​
amountDue
number
required

Total Amount Due

Example:

999

​
createdAt
string
required

created at

Example:

"2023-12-12T09:27:42.355Z"

​
updatedAt
string
required

updated at

Example:

"2023-12-12T09:27:42.355Z"

​
discount
object

Discount

Example:
{ "type": "percentage", "value": 0 }
​
automaticTaxesEnabled
boolean

Automatic taxes enabled for the Invoice

Example:

true

​
automaticTaxesCalculated
boolean

Is Automatic taxes calculated for the Invoice items

Example:

true

​
paymentSchedule
object

split invoice into payment schedule summing up to full invoice amount

Last modified on March 4, 2026