Update invoice
/documents/invoices/{id}Costs 2 rate-limit points · Rate limits
Edits the fields of one invoice the invoice editor lets a merchant change: document number, issue, due, tax and fulfilment dates, PO number, payment terms, the order note, the footer note and up to four custom fields. Only the keys sent change; returns the full invoice.
Marks the invoice edited, so a Shopify resync no longer overwrites it until it is regenerated. Allowed even when the shop locks issued invoices: the lock stops Shopify resyncs, not merchant edits. The stored PDF is re-rendered on the next download or send.
Also searched asedit invoicechange invoice due datechange invoice numberadd note to invoiceset po number on invoiceupdate invoice fieldschange invoice dateedit custom fields
Path parameters
idstringRequired
Request body
invoice_numberstringDocument number shown on the invoice.
issued_onstringInvoice date (YYYY-MM-DD).
due_onstring, nullableDue date; null or "" clears it.
tax_datestring, nullableTax point date; null clears it.
fulfilled_onstring, nullableFulfilment date; null clears it.
po_numberstring, nullablePurchase order number; null clears it.
payment_termsstring, nullablePayment terms text; null clears it.
notestring, nullableOrder note printed on the invoice; null clears it.
custom_notestring, nullableFooter note for this invoice; null clears it.
custom_fieldsarray of objectsUp to 4 {title, body} pairs; replaces the existing set, [] clears them.
Show 2 child attributesHide child attributes
titlestringExample:RefbodystringExample:X1
Returns
idintegerExample:980190979document_typestringExample:invoiceinvoice_numberstringExample:INV-77titlestringExample:InvoiceorderobjectShow 3 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/Order/12213474623569namestringExample:#1001numberintegerExample:1001
customerobjectShow 8 child attributesHide child attributes
idintegerExample:11namestringExample:Customer 1emailstringExample:cus1@gmail.comshopify_customer_idstringExample:gid://shopify/Customer/23935678808145phonestring, nullabletax_numberstring, nullableeori_numberstring, nullabletagsarray of anys
financial_statusstringExample:paidcurrencystringExample:USDtotalstringExample:1100.22issued_onstringExample:2025-12-11due_onstring, nullableExample:2026-03-01sent_atstring, nullableprinted_atstring, nullablereminder_sent_atstring, nullablepaidbooleanExample:trueeditedbooleanExample:truetrashedbooleanExample:falsee_invoice_statusstring, nullablecreated_atstringExample:2026-11-10T08:35:18Zfulfillment_statusstring, nullabledatesobjectShow 5 child attributesHide child attributes
order_placed_atstringExample:2025-12-11T00:00:00Zissued_onstringExample:2025-12-11due_onstring, nullableExample:2026-03-01tax_datestring, nullablefulfilled_onstring, nullable
po_numberstring, nullableExample:PO-9payment_termsstring, nullablepayment_gatewaystringExample:manuallocalestringExample:entotalsobjectShow 11 child attributesHide child attributes
currencystringExample:USDtaxes_includedbooleanExample:falsesubtotalstringExample:1497.95discountsstringExample:494.32shippingstringExample:6.90taxstringExample:89.69dutiesstringExample:0.00totalstringExample:1100.22total_paidstringExample:0.00total_refundedstringExample:0.00total_duestringExample:0.00
billing_addressobjectShow 14 child attributesHide child attributes
namestringExample:Customer 1first_namestringExample:Customerlast_namestringExample:1companystring, nullableaddress1string, nullableaddress2string, nullablecitystring, nullableprovincestring, nullablezipstring, nullablecountrystringExample:United Statescountry_codestringExample:USphonestring, nullabletax_numberstring, nullableeori_numberstring, nullable
shipping_addressobjectShow 14 child attributesHide child attributes
namestringExample:Customer 1first_namestringExample:Customerlast_namestringExample:1companystring, nullableaddress1stringExample:New Yorkaddress2string, nullablecitystringExample:New YorkprovincestringExample:New YorkzipstringExample:10004countrystringExample:United Statescountry_codestringExample:USphonestring, nullabletax_numberstring, nullableeori_numberstring, nullable
line_itemsarray of objectsShow 18 child attributesHide child attributes
idintegerExample:494titlestringExample:The Videographer Snowboardvariant_titlestring, nullableskustringExample:9506.11.21barcodestring, nullableproduct_typestring, nullablequantityintegerExample:1unit_pricestringExample:885.95discountstringExample:0.00discounted_unit_pricestringExample:885.95total_discountstringExample:0.00taxstringExample:78.63tax_linesarray of objectsShow 2 child attributesHide child attributes
titlestringExample:New York State TaxratestringExample:4.0
totalstringExample:885.95refunded_quantityintegerExample:0image_urlstring, nullablepropertiesarray of anysnotestring, nullable
shipping_linesarray of objectsShow 5 child attributesHide child attributes
titlestringExample:StandardpricestringExample:6.90discountstringExample:0.00taxstringExample:0.62tax_linesarray of objectsShow 3 child attributesHide child attributes
titlestringExample:New York State TaxratestringExample:4.0amountstringExample:0.28
tax_linesarray of objectsShow 3 child attributesHide child attributes
titlestringExample:New York State TaxratestringExample:4.0amountstringExample:40.42
discount_codesarray of stringsnotesobjectShow 3 child attributesHide child attributes
notestring, nullablecustom_notestring, nullableExample:Thanksnote_attributesarray of anys
custom_fieldsarray of objectsShow 2 child attributesHide child attributes
titlestringExample:RefbodystringExample:X1
tagsarray of anystrackingobjectShow 2 child attributesHide child attributes
companiesarray of anys, nullablenumbersarray of anys, nullable
pdfobjectShow 4 child attributesHide child attributes
availablebooleanExample:falsefilenamestring, nullableurlstring, nullablegenerated_atstring, nullable
e_invoiceobjectShow 3 child attributesHide child attributes
statusobject, nullablerequestedbooleanExample:falseerrorstring, nullable
updated_atstringExample:2026-11-10T08:35:18Z
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request conflicts with the current state (an issued invoice is locked, the next invoice number moved, a template is still in use, a job already finished). Nothing was changed.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl -X PATCH "https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"invoice_number": "INV-77",
"due_on": "2026-03-01",
"po_number": "PO-9",
"custom_note": "Thanks",
"custom_fields": [
{
"title": "Ref",
"body": "X1"
}
]
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059", {
method: "PATCH",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"invoice_number": "INV-77",
"due_on": "2026-03-01",
"po_number": "PO-9",
"custom_note": "Thanks",
"custom_fields": [
{
"title": "Ref",
"body": "X1"
}
]
}),
});
const data = await res.json();import os
import requests
res = requests.patch(
"https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"invoice_number": "INV-77",
"due_on": "2026-03-01",
"po_number": "PO-9",
"custom_note": "Thanks",
"custom_fields": [
{
"title": "Ref",
"body": "X1"
}
]
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059")
req = Net::HTTP::Patch.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
invoice_number: "INV-77",
due_on: "2026-03-01",
po_number: "PO-9",
custom_note: "Thanks",
custom_fields: [
{
title: "Ref",
body: "X1"
}
]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": 980190979,
"document_type": "invoice",
"invoice_number": "INV-77",
"title": "Invoice",
"order": {
"shopify_order_id": "gid://shopify/Order/12213474623569",
"name": "#1001",
"number": 1001
},
"customer": {
"id": 11,
"name": "Customer 1",
"email": "cus1@gmail.com",
"shopify_customer_id": "gid://shopify/Customer/23935678808145",
"phone": null,
"tax_number": null,
"eori_number": null,
"tags": []
},
"financial_status": "paid",
"currency": "USD",
"total": "1100.22",
"issued_on": "2025-12-11",
"due_on": "2026-03-01",
"sent_at": null,
"printed_at": null,
"reminder_sent_at": null,
"paid": true,
"edited": true,
"trashed": false,
"e_invoice_status": null,
"created_at": "2026-11-10T08:35:18Z",
"fulfillment_status": null,
"dates": {
"order_placed_at": "2025-12-11T00:00:00Z",
"issued_on": "2025-12-11",
"due_on": "2026-03-01",
"tax_date": null,
"fulfilled_on": null
},
"po_number": "PO-9",
"payment_terms": null,
"payment_gateway": "manual",
"locale": "en",
"totals": {
"currency": "USD",
"taxes_included": false,
"subtotal": "1497.95",
"discounts": "494.32",
"shipping": "6.90",
"tax": "89.69",
"duties": "0.00",
"total": "1100.22",
"total_paid": "0.00",
"total_refunded": "0.00",
"total_due": "0.00"
},
"billing_address": {
"name": "Customer 1",
"first_name": "Customer",
"last_name": "1",
"company": null,
"address1": null,
"address2": null,
"city": null,
"province": null,
"zip": null,
"country": "United States",
"country_code": "US",
"phone": null,
"tax_number": null,
"eori_number": null
},
"shipping_address": {
"name": "Customer 1",
"first_name": "Customer",
"last_name": "1",
"company": null,
"address1": "New York",
"address2": null,
"city": "New York",
"province": "New York",
"zip": "10004",
"country": "United States",
"country_code": "US",
"phone": null,
"tax_number": null,
"eori_number": null
},
"line_items": [
{
"id": 494,
"title": "The Videographer Snowboard",
"variant_title": null,
"sku": "9506.11.21",
"barcode": null,
"product_type": null,
"quantity": 1,
"unit_price": "885.95",
"discount": "0.00",
"discounted_unit_price": "885.95",
"total_discount": "0.00",
"tax": "78.63",
"tax_lines": [
{
"title": "New York State Tax",
"rate": "4.0"
},
{
"title": "New York City City Tax",
"rate": "4.5"
},
{
"title": "Metropolitan Commuter Transportation District",
"rate": "0.375"
}
],
"total": "885.95",
"refunded_quantity": 0,
"image_url": null,
"properties": [],
"note": null
},
{
"id": 495,
"title": "Custom 1",
"variant_title": null,
"sku": null,
"barcode": null,
"product_type": null,
"quantity": 1,
"unit_price": "12.00",
"discount": "0.00",
"discounted_unit_price": "12.00",
"total_discount": "0.00",
"tax": "1.07",
"tax_lines": [
{
"title": "New York State Tax",
"rate": "4.0"
},
{
"title": "New York City City Tax",
"rate": "4.5"
},
{
"title": "Metropolitan Commuter Transportation District",
"rate": "0.375"
}
],
"total": "12.00",
"refunded_quantity": 0,
"image_url": null,
"properties": [],
"note": null
},
{
"id": 496,
"title": "The Collection Snowboard: Hydrogen",
"variant_title": null,
"sku": "9506.11.21",
"barcode": null,
"product_type": null,
"quantity": 1,
"unit_price": "600.00",
"discount": "0.00",
"discounted_unit_price": "600.00",
"total_discount": "0.00",
"tax": "53.25",
"tax_lines": [
{
"title": "New York State Tax",
"rate": "4.0"
},
{
"title": "New York City City Tax",
"rate": "4.5"
},
{
"title": "Metropolitan Commuter Transportation District",
"rate": "0.375"
}
],
"total": "600.00",
"refunded_quantity": 0,
"image_url": null,
"properties": [],
"note": null
}
],
"shipping_lines": [
{
"title": "Standard",
"price": "6.90",
"discount": "0.00",
"tax": "0.62",
"tax_lines": [
{
"title": "New York State Tax",
"rate": "4.0",
"amount": "0.28"
},
{
"title": "New York City City Tax",
"rate": "4.5",
"amount": "0.31"
},
{
"title": "Metropolitan Commuter Transportation District",
"rate": "0.375",
"amount": "0.03"
}
]
}
],
"tax_lines": [
{
"title": "New York State Tax",
"rate": "4.0",
"amount": "40.42"
},
{
"title": "New York City City Tax",
"rate": "4.5",
"amount": "45.47"
},
{
"title": "Metropolitan Commuter Transportation District",
"rate": "0.375",
"amount": "3.80"
}
],
"discount_codes": [
"Order discount in percentage"
],
"notes": {
"note": null,
"custom_note": "Thanks",
"note_attributes": []
},
"custom_fields": [
{
"title": "Ref",
"body": "X1"
}
],
"tags": [],
"tracking": {
"companies": null,
"numbers": null
},
"pdf": {
"available": false,
"filename": null,
"url": null,
"generated_at": null
},
"e_invoice": {
"status": null,
"requested": false,
"error": null
},
"updated_at": "2026-11-10T08:35:18Z"
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"This shop keeps issued invoices unchanged, so this invoice cannot be edited."
],
"code": "invoice_locked"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}