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.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
{
"invoiceID": "4f03a727-9c4b-43a5-b699-271a3e6fdc9c",
"invoiceNumber": "INV-1001",
"description": "string",
"customerAccountID": "d8b40343-5784-4096-8d40-9f3b4a834066",
"partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
"status": "draft",
"lineItems": {
"items": [
{
"options": [
{
"images": [
{
"imageID": "bbdcb050-2e05-43cb-812a-e1296cd0c01a",
"altText": "string",
"link": "https://api.moov.io/images/q7lKWleAy9fUNhEGezQ1g",
"publicID": "string"
}
],
"name": "string",
"quantity": 1,
"priceModifier": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"group": "string"
}
],
"images": [
{
"imageID": "bbdcb050-2e05-43cb-812a-e1296cd0c01a",
"altText": "string",
"link": "https://api.moov.io/images/q7lKWleAy9fUNhEGezQ1g",
"publicID": "string"
}
],
"name": "string",
"basePrice": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"quantity": 1,
"productID": "dbb08e34-cbbb-47d7-824b-bc71f5b00e6c"
}
]
},
"subtotalAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"taxAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"totalAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"pendingAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"paidAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"refundedAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"disputedAmount": {
"currency": "USD",
"valueDecimal": "12.987654321"
},
"paymentLinkCode": "string",
"payments": [
{
"paymentType": "transfer",
"transfer": {
"paymentType": "transfer",
"transferID": "e23de6dd-5168-4e1d-894d-807fa691dc80"
},
"external": {
"paymentType": "external",
"description": "string",
"foreignID": "string",
"paymentDate": "2019-08-24T14:15:22Z",
"amount": {
"currency": "USD",
"valueDecimal": "12.987654321"
}
}
}
],
"createdOn": "2019-08-24T14:15:22Z",
"invoiceDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"sentOn": "2019-08-24T14:15:22Z",
"paidOn": "2019-08-24T14:15:22Z",
"canceledOn": "2019-08-24T14:15:22Z"
}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<uuid>
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<uuid>
required
description
string
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<uuid>
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<uuid>
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<uuid>
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<uuid>
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>
dueDate
string<date-time>
invoiceDate
string<date-time>
paidOn
string<date-time>
paymentLinkCode
string
payments
array<object>
Show child attributes
external
object
Show child attributes
amount
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'.
description
string
required
paymentType
string<enum>
required
external
foreignID
string
paymentDate
string<date-time>
paymentType
string<enum>
transfer,
external
transfer
object
Show child attributes
paymentType
string<enum>
required
transfer
transferID
string<uuid>
required
sentOn
string<date-time>