Update invoice

PUT 
/invoices/:invoiceId

API to update invoice by invoice id

Request

Version stringrequired

API Version

Available optionsv3

invoiceId stringrequired

Invoice Id

application/json

application/json

Body

Bodyrequired

altIdstringrequired

location Id / company Id based on altType

altTypestringrequired
Alt Type
Available optionslocation
namestringrequired

Name to be updated

titlestring

Title for the invoice

currencystringrequired

Currency

descriptionstring

Description

businessDetailsobject

Business details which need to be updated

invoiceNumberstring

Invoice Number

contactIdstring

Id of the contact which you need to send the invoice

contactDetailsobject
termsNotesstring

Terms notes, Also supports HTML markups

discountobject
invoiceItemsobject[]required
automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

liveModeboolean

Payment mode

issueDatestringrequired

Issue date in YYYY-MM-DD format

dueDatestringrequired

Due date in YYYY-MM-DD format

paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount

tipsConfigurationobject

tips configuration for the invoice

xeroDetailsobject
invoiceNumberPrefixstring

prefix for invoice number

paymentMethodsobject

Payment Methods for Invoices

attachmentsobject[]

attachments for the invoice

miscellaneousChargesobject

miscellaneous charges for the invoice

Example (auto)

{
  "altId": "6578278e879ad2646715ba9c",
  "altType": "location",
  "name": "New Invoice",
  "title": "INVOICE",
  "currency": "USD",
  "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": "[email protected]",
    "additionalEmails": [
      {
        "email": "[email protected]"
      }
    ],
    "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": {
    "value": 10,
    "type": "percentage",
    "validOnProductIds": "[ '6579751d56f60276e5bd4154' ]"
  },
  "invoiceItems": [
    {
      "name": "ABC Product",
      "description": "ABC Corp.",
      "productId": "6578278e879ad2646715ba9c",
      "priceId": "6578278e879ad2646715ba9c",
      "currency": "USD",
      "amount": 999,
      "qty": 1,
      "taxes": [
        {
          "_id": "string",
          "name": "string",
          "rate": 0,
          "calculation": "exclusive",
          "description": "string",
          "taxId": "string"
        }
      ],
      "automaticTaxCategoryId": "6578278e879ad2646715ba9c",
      "isSetupFeeItem": true,
      "type": "one_time",
      "taxInclusive": true
    }
  ],
  "automaticTaxesEnabled": true,
  "liveMode": true,
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-14",
  "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": [
      null
    ],
    "collectedMiscellaneousCharges": 10,
    "paidCharges": [
      {
        "name": "Processing Fee",
        "charge": 10,
        "amount": 10,
        "_id": "673d01d7d547648a8dab6211"
      }
    ]
  }
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Invoice Id

statusstringrequired
Invoice Status
Available optionsdraftsentpayment_processingpaidvoidpartially_paid
liveModebooleanrequired

Live Mode

amountPaidnumberrequired

Amount Paid

altIdstringrequired

Location Id or Agency Id

altTypestringrequired
Available optionslocation
namestringrequired

Name of the invoice

businessDetailsobjectrequired

Business Details

invoiceNumbernumberrequired

Invoice Number

currencystringrequired

Currency

contactDetailsobjectrequired

Contact Details

issueDatestringrequired

Issue date in YYYY-MM-DD format

dueDatestringrequired

Due date in YYYY-MM-DD format

discountobject

Discount

invoiceItemsstring[]required

Invoice Items

totalnumberrequired

Total Amount

titlestringrequired

Title

amountDuenumberrequired

Total Amount Due

createdAtstringrequired

created at

updatedAtstringrequired

updated at

automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

automaticTaxesCalculatedboolean

Is Automatic taxes calculated for the Invoice items

paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount

Example (auto)

{
  "_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": "[email protected]",
    "customFields": [],
    "name": "Alex",
    "address": {
      "countryCode": "US"
    }
  },
  "issueDate": "2023-01-01",
  "dueDate": "2023-01-01",
  "discount": {
    "type": "percentage",
    "value": 0
  },
  "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",
  "automaticTaxesEnabled": true,
  "automaticTaxesCalculated": true,
  "paymentSchedule": {}
}