Skip to main content
PUT
/
v1
/
invoices
/
{id}
Update Invoice
curl --request PUT \
  --url https://api.wizcommerce.com/v1/invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reference_id": "INV-20250101",
  "order_id": "ORD-20250101",
  "invoice_number": "INV-20250101",
  "total_amount": 1000000,
  "paid_amount": 0,
  "due_date": "2025-01-01T00:00:00Z",
  "items": [
    {
      "reference_id": "ITEM-20250101",
      "sku": "SKU-20250101",
      "quantity": 1000000,
      "amount": 1000000,
      "name": "Item Name"
    }
  ],
  "status": "PAID",
  "remarks": "Remarks",
  "url": "https://example.com/invoice/INV-20250101",
  "created_at": "2025-01-01T00:00:00Z",
  "updated_at": "2025-01-01T00:00:00Z"
}
'
{
  "data": {
    "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
    "reference_id": "INV-20250101",
    "order_id": "ORD-20250101",
    "invoice_number": "INV-20250101",
    "total_amount": 269.96,
    "paid_amount": 100,
    "status": "PAID",
    "due_date": "2025-01-01T00:00:00Z",
    "remarks": "Remarks",
    "url": "https://example.com/invoice/INV-20250101",
    "created_at": "2025-01-01T00:00:00Z",
    "updated_at": "2025-01-01T00:00:00Z",
    "items": [
      {
        "name": "Item Name",
        "product_id": "1234567890",
        "amount": 1000000,
        "item_total": 1000000,
        "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
        "quantity": 1000000,
        "reference_id": "ITEM-20250101"
      }
    ]
  }
}
The PUT request is used to fully replace an existing entity with a new one based on the provided ID. This means:
  • All fields in the request body will overwrite the existing entity.
  • Any missing fields will be removed from the entity.
  • The request is idempotent, meaning multiple identical PUT requests will always result in the same final state.

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Invoice ID

Body

application/json

Invoice

​
reference_id
string
required
Maximum string length: 255
Example:

"INV-20250101"

​
order_id
string
required
Maximum string length: 255
Example:

"ORD-20250101"

​
invoice_number
string
required
Maximum string length: 255
Example:

"INV-20250101"

​
total_amount
number
required
Example:

1000000

​
paid_amount
number
required
Required range: x >= 0
Example:

0

​
due_date
string
required
Example:

"2025-01-01T00:00:00Z"

​
items
object[]
required
​
status
enum<string>
Available options:
PAID,
PENDING,
PARTIALLY_PAID,
OVERPAID
Example:

"PAID"

​
remarks
string
Maximum string length: 255
Example:

"Remarks"

​
url
string
Example:

"https://example.com/invoice/INV-20250101"

​
created_at
string
Example:

"2025-01-01T00:00:00Z"

​
updated_at
string

Updated at must be later than the order creation date

Example:

"2025-01-01T00:00:00Z"

Response

Created

​
data
object