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

Edit Credit Note

Prod Env

{{subdomain}}/api2

PUT

/api2/credit_notes/{{id}}.json

Last modified:2025-03-23 23:11:40

Maintainer:Not configured

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

Path Parameters:

id: Credit Note ID (required)

Request Body Fields:

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

CreditNote Object:

date (string): Credit note date (YYYY-MM-DD)

notes (string): Credit note notes/reason

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": {
    "CreditNote": {
      "id": 345,
      // Updated credit note fields...
    }
  },
  "message": "Credit note updated successfully"
}

Request

Body Params text/plain

Examples

Responses

🟢200Success Response

application/json

Body

🟠404Error - Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT '{{subdomain}}/api2/api2/credit_notes/{{id}}.json' \
--header 'Content-Type: text/plain' \
--data-raw '{
  "CreditNote": {
    "date": "2023-03-24",
    "notes": "Updated credit note for damaged products",
    "InvoiceItem": [
      {
        "id": 678,
        "quantity": 2,
        "unit_price": 45
      },
      {
        "product_id": 3,
        "quantity": 1,
        "unit_price": 25,
        "description": "Additional return item"
      }
    ]
  }
}'

Response Example

200 - Success Response

{
  "result": "success",
  "code": 200,
  "data": {
    "CreditNote": {
      "id": 345,
      "number": "CN-2023-001",
      "client_id": 15,
      "date": "2023-03-24",
      "total": 50.00,
      "notes": "Updated credit note",
      "modified": "2023-03-23 16:45:22"
    }
  },
  "message": "Credit note updated successfully"
}

Modified at 2025-03-23 23:11:40

Delete Estimate

Delete Credit Note