Update an invoice
Updates an invoice.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/invoices.write scope.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{
"createdOn": "2024-05-06T12:20:38.184Z",
"customerAccountID": "3dfff852-927d-47e8-822c-2fffc57ff6b9",
"description": "Professional services for Q1 2026",
"disputedAmount": {
"currency": "USD",
"valueDecimal": "0.00"
},
"dueDate": "2026-02-15T00:00:00Z",
"invoiceDate": "2026-01-15T00:00:00Z",
"invoiceID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"invoiceNumber": "INV-1001",
"lineItems": {
"items": [
{
"basePrice": {
"currency": "USD",
"valueDecimal": "1000.00"
},
"name": "Professional Services",
"quantity": 1
}
]
},
"paidAmount": {
"currency": "USD",
"valueDecimal": "0.00"
},
"partnerAccountID": "5dfff852-927d-47e8-822c-2fffc57ff6b8",
"pendingAmount": {
"currency": "USD",
"valueDecimal": "0.00"
},
"refundedAmount": {
"currency": "USD",
"valueDecimal": "0.00"
},
"status": "unpaid",
"subtotalAmount": {
"currency": "USD",
"valueDecimal": "1000.00"
},
"taxAmount": {
"currency": "USD",
"valueDecimal": "80.00"
},
"totalAmount": {
"currency": "USD",
"valueDecimal": "1080.00"
}
}Response headers
x-request-id
string
<uuid>
required
{
"error": "string"
}Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
{
"error": "string"
}Response headers
x-request-id
string
<uuid>
required
{
"description": "string",
"lineItems": {
"items": {
"property1": {
"productID": "string",
"name": "string",
"basePrice": {
"currency": "string",
"valueDecimal": "string"
},
"options": {
"property1": {
"name": "string",
"group": "string",
"priceModifier": {
"currency": "string",
"valueDecimal": "string"
},
"quantity": "string"
},
"property2": {
"name": "string",
"group": "string",
"priceModifier": {
"currency": "string",
"valueDecimal": "string"
},
"quantity": "string"
}
},
"quantity": "string"
},
"property2": {
"productID": "string",
"name": "string",
"basePrice": {
"currency": "string",
"valueDecimal": "string"
},
"options": {
"property1": {
"name": "string",
"group": "string",
"priceModifier": {
"currency": "string",
"valueDecimal": "string"
},
"quantity": "string"
},
"property2": {
"name": "string",
"group": "string",
"priceModifier": {
"currency": "string",
"valueDecimal": "string"
},
"quantity": "string"
}
},
"quantity": "string"
}
}
},
"invoiceDate": "string",
"dueDate": "string",
"status": "string",
"taxAmount": {
"currency": "string",
"valueDecimal": "string"
}
}Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Response headers
x-request-id
string
<uuid>
required
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
When no version is specified, the API defaults to v2024.01.00.
Path parameters
accountID
string
<uuid>
required
invoiceID
string
<uuid>
required
Body
description
string
dueDate
string<date-time>
| null
invoiceDate
string<date-time>
| null
lineItems
object
Show child attributes
items
array<object>
Show child attributes
basePrice
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
name
string
[1 to 150] characters
required
quantity
integer<int32>
required
imageIDs
array<string>
options
array<object>
Show child attributes
name
string
[1 to 150] characters
required
quantity
integer<int32>
required
group
string
<=100 characters
imageIDs
array<string>
priceModifier
object
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
productID
string
status
string
The status can be updated to one of the following values under specific conditions:
canceled: Can only be set if the current status isdraft,unpaid, oroverdue.unpaid: Can only be set if the current status isdraft. Setting the status tounpaidfinalizes the invoice and sends an email with a payment link to the customer.
draft,
unpaid,
payment-pending,
paid,
overdue,
canceled
taxAmount
object
Show child attributes
currency
string
Pattern
valueDecimal
string
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
Response
createdOn
string<date-time>
required
customerAccountID
string
<=36 characters
required
disputedAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
invoiceID
string
<=36 characters
required
invoiceNumber
string
required
lineItems
object
required
Show child attributes
items
array<object>
required
Show child attributes
basePrice
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
name
string
[1 to 150] characters
required
quantity
integer<int32>
required
images
array<object>
options
array<object>
Show child attributes
name
string
[1 to 150] characters
required
quantity
integer<int32>
required
group
string
<=100 characters
images
array<object>
Show child attributes
altText
string
<=125 characters
imageID
string
<=36 characters
link
string<uri>
publicID
string
Pattern
priceModifier
object
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
productID
string
paidAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
partnerAccountID
string
<=36 characters
required
pendingAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
refundedAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
status
string<enum>
required
draft,
unpaid,
payment-pending,
paid,
overdue,
canceled
subtotalAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
taxAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
totalAmount
object
required
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
canceledOn
string<date-time>
description
string
dueDate
string<date-time>
invoiceDate
string<date-time>
invoicePayments
array<object>
Show child attributes
amount
object
Show child attributes
currency
string
required
Pattern
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
external
object
Show child attributes
description
string
foreignID
string
paymentDate
string<date-time>
invoicePaymentID
string
<=36 characters
invoicePaymentType
string<enum>
transfer,
external
transfer
object
Show child attributes
transferID
string
<=36 characters
required
paidOn
string<date-time>
paymentLinkCode
string
sentOn
string<date-time>