This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Edit Invoice

Prod Env

{{subdomain}}/api2

PUT

/api2/invoices/{{id}}.json

Last modified:2025-03-23 22:24:55

Maintainer:Not configured

Updates an existing invoice.

Required URL Parameter

Parameter	Type	Description
id	integer	Invoice ID to update

Editable Fields

Field	Type	Description
date	string	Invoice date (YYYY-MM-DD)
notes	string	Invoice notes
discount	number	Percentage discount
discount_amount	number	Fixed amount discount
draft	integer	Draft status (0/1)
po_number	string	Purchase order number
payment_status	integer	Payment status (only if sufficient permissions)

Important Notes

Cannot update client_id after creation

Cannot update InvoiceItems directly with this endpoint

Some fields may be restricted based on invoice status

Example Request

{
  "Invoice": {
    "date": "2023-03-24",
    "notes": "Updated invoice for March services",
    "discount": 5
  }
}

Response

{
  "code": 200,
  "result": "successful"
}

Request

Path Params

Header Params

Body Params text/plain

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '{{subdomain}}/api2/api2/invoices/{{id}}.json' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "Invoice": {
    "date": "2023-03-24",
    "notes": "Updated invoice for March services",
    "discount": 5
  }
}'

Response Example

{}

Modified at 2025-03-23 22:24:55

Add New Invoice

Delete Invoice

Edit Invoice

Required URL Parameter#

Editable Fields#

Important Notes#

Example Request#