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

Daftra API Docs

Edit Invoice

Prod Env

{{subdomain}}/api2

PUT

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

Last modified:2025-03-23 22:41:10

Maintainer:Not configured

Updates an existing invoice by ID. You can provide only the fields you want to update.

Path Parameters:

id: Invoice ID (required)

Request Body Fields:

The request body allows partial updates. You only need to include the fields you want to change.

Invoice Object:

date (string): Invoice date (YYYY-MM-DD)

due_date (string): Due date (YYYY-MM-DD)

notes (string): Invoice notes

discount (number): Invoice-level discount amount

discount_type (integer): Discount type (1: percentage, 2: fixed amount)

InvoiceItem Array (optional):

To update existing items, include the item id along with the fields to update

To add new items, omit the id field and include required item fields

To remove items, you must use a separate DELETE request for each item

Response:

{
  "result": "success",
  "code": 200,
  "data": {
    "Invoice": {
      "id": 123,
      // Updated invoice fields...
    }
  },
  "message": "Invoice updated successfully"
}

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '{{subdomain}}/api2/api2/invoices/{{id}}.json' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "Invoice": {
    "date": "2023-03-24",
    "notes": "Updated invoice notes",
    "discount": 5,
    "discount_type": 1,
    "InvoiceItem": [
      {
        "id": 456,
        "quantity": 2,
        "unit_price": 95
      },
      {
        "product_id": 3,
        "quantity": 1,
        "unit_price": 75,
        "description": "New item added during update"
      }
    ]
  }
}'

Response Example

200 - Success Response

{
  "result": "success",
  "code": 200,
  "data": {
    "Invoice": {
      "id": 123,
      "number": "INV-2023-001",
      "client_id": 15,
      "date": "2023-03-24",
      "due_date": "2023-04-22",
      "total": 114,
      "discount": 5,
      "discount_type": 1,
      "notes": "Updated invoice notes",
      "modified": "2023-03-23 16:45:22"
    }
  },
  "message": "Invoice updated successfully"
}

Request

Body Params text/plain

Examples

Responses

🟢200Success Response

application/json

Body

result

string

required

code

integer

required

data

object

required

Invoice

object

required

message

string

required

🟠404Error - Not Found

Add New Invoice

Edit Invoice