Skip to main content
InvoiceVersion: v3

Update invoice

PUT/invoices/{invoiceId}

API to update invoice by invoice id

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:invoices.write
Auth methods:OAuthPrivate Integration
Token types:Sub-Account TokenAgency Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

invoiceIdstringrequired

Invoice Id

Example:6578278e879ad2646715ba9c

Body

application/json
altIdstringrequired

location Id / company Id based on altType

Example:6578278e879ad2646715ba9c
altTypestringrequired

Alt Type

Available optionslocation
Example:location
namestringrequired

Name to be updated

Example:New Invoice
titlestring

Title for the invoice

Example:INVOICE
currencystringrequired

Currency

Example:USD
descriptionstring

Description

Example:ABC Corp payments
businessDetailsobject

Business details which need to be updated

invoiceNumberstring

Invoice Number

Example:1001
contactIdstring

Id of the contact which you need to send the invoice

Example:6578278e879ad2646715ba9c
contactDetailsobject
termsNotesstring

Terms notes, Also supports HTML markups

Example:<p>This is a default terms.</p>
discountobject
invoiceItemsobject[]required
automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

Example:true
liveModeboolean

Payment mode

issueDatestringrequired

Issue date in YYYY-MM-DD format

Example:2023-01-01
dueDatestringrequired

Due date in YYYY-MM-DD format

Example:2023-01-14
paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount

tipsConfigurationobject

tips configuration for the invoice

xeroDetailsobject
invoiceNumberPrefixstring

prefix for invoice number

Example:INV-
paymentMethodsobject

Payment Methods for Invoices

attachmentsobject[]

attachments for the invoice

miscellaneousChargesobject

miscellaneous charges for the invoice

Response

application/json

Successful response

_idstringrequired

Invoice Id

Example:6578278e879ad2646715ba9c
statusstringrequired

Invoice Status

Available optionsdraftsentpayment_processingpaidvoidpartially_paid
Example:draft
liveModebooleanrequired

Live Mode

Example:false
amountPaidnumberrequired

Amount Paid

Example:0
altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c
altTypestringrequired
Available optionslocation
namestringrequired

Name of the invoice

Example:New Invoice
businessDetailsobjectrequired

Business Details

invoiceNumbernumberrequired

Invoice Number

Example:19
currencystringrequired

Currency

Example:USD
contactDetailsobjectrequired

Contact Details

issueDatestringrequired

Issue date in YYYY-MM-DD format

Example:2023-01-01
dueDatestringrequired

Due date in YYYY-MM-DD format

Example:2023-01-01
discountobject

Discount

invoiceItemsstring[]required

Invoice Items

totalnumberrequired

Total Amount

Example:999
titlestringrequired

Title

Example:INVOICE
amountDuenumberrequired

Total Amount Due

Example:999
createdAtstringrequired

created at

Example:2023-12-12T09:27:42.355Z
updatedAtstringrequired

updated at

Example:2023-12-12T09:27:42.355Z
automaticTaxesEnabledboolean

Automatic taxes enabled for the Invoice

Example:true
automaticTaxesCalculatedboolean

Is Automatic taxes calculated for the Invoice items

Example:true
paymentScheduleobject

split invoice into payment schedule summing up to full invoice amount