Update invoice

PUT

invoices

{invoiceId}

Update invoice

curl --request PUT \
  --url https://services.leadconnectorhq.com/invoices/{invoiceId} \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "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",
  "termsNotes": "<p>This is a default terms.</p>",
  "automaticTaxesEnabled": true,
  "liveMode": true,
  "xeroDetails": {},
  "invoiceNumberPrefix": "INV-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Version: '<version>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    termsNotes: '<p>This is a default terms.</p>',
    automaticTaxesEnabled: true,
    liveMode: true,
    xeroDetails: {},
    invoiceNumberPrefix: 'INV-',
    attachments: [
      {
        id: '6241712be68f7a98102ba272',
        name: 'Electronics.pdf',
        url: 'https://example.com/digital-delivery',
        type: '<string>',
        size: 10000
      }
    ]
  })
};

fetch('https://services.leadconnectorhq.com/invoices/{invoiceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/invoices/{invoiceId}"

payload = {
    "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",
    "termsNotes": "<p>This is a default terms.</p>",
    "automaticTaxesEnabled": True,
    "liveMode": True,
    "xeroDetails": {},
    "invoiceNumberPrefix": "INV-",
    "attachments": [
        {
            "id": "6241712be68f7a98102ba272",
            "name": "Electronics.pdf",
            "url": "https://example.com/digital-delivery",
            "type": "<string>",
            "size": 10000
        }
    ]
}
headers = {
    "Version": "<version>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "_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": {}
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

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

Show child attributes

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

Show child attributes

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

Show child attributes

termsNotes

string

Terms notes, Also supports HTML markups

Example:

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

discount

object

Show child attributes

automaticTaxesEnabled

boolean

Automatic taxes enabled for the Invoice

Example:

true

liveMode

boolean

Payment mode

paymentSchedule

object

Show child attributes

tipsConfiguration

object

Show child attributes

xeroDetails

object

invoiceNumberPrefix

string

prefix for invoice number

Example:

"INV-"

paymentMethods

object

Show child attributes

attachments

object[]

attachments for the invoice

Show child attributes

miscellaneousCharges

object

Show child attributes

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 8, 2026

Get Invoice Settings

Update invoice late fees configuration

Update invoice

curl --request PUT \
  --url https://services.leadconnectorhq.com/invoices/{invoiceId} \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "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",
  "termsNotes": "<p>This is a default terms.</p>",
  "automaticTaxesEnabled": true,
  "liveMode": true,
  "xeroDetails": {},
  "invoiceNumberPrefix": "INV-",
  "attachments": [
    {
      "id": "6241712be68f7a98102ba272",
      "name": "Electronics.pdf",
      "url": "https://example.com/digital-delivery",
      "type": "<string>",
      "size": 10000
    }
  ]
}
'

const options = {
  method: 'PUT',
  headers: {Version: '<version>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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',
    termsNotes: '<p>This is a default terms.</p>',
    automaticTaxesEnabled: true,
    liveMode: true,
    xeroDetails: {},
    invoiceNumberPrefix: 'INV-',
    attachments: [
      {
        id: '6241712be68f7a98102ba272',
        name: 'Electronics.pdf',
        url: 'https://example.com/digital-delivery',
        type: '<string>',
        size: 10000
      }
    ]
  })
};

fetch('https://services.leadconnectorhq.com/invoices/{invoiceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/invoices/{invoiceId}"

payload = {
    "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",
    "termsNotes": "<p>This is a default terms.</p>",
    "automaticTaxesEnabled": True,
    "liveMode": True,
    "xeroDetails": {},
    "invoiceNumberPrefix": "INV-",
    "attachments": [
        {
            "id": "6241712be68f7a98102ba272",
            "name": "Electronics.pdf",
            "url": "https://example.com/digital-delivery",
            "type": "<string>",
            "size": 10000
        }
    ]
}
headers = {
    "Version": "<version>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "_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": {}
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Invoices

Payments

Products

Store

Documents & Contracts

Headers

Path Parameters

Body

Response