PATCH
/
coa
/
api
/
v1
/
credit-memo
/
{id}
curl --request PATCH \
  --url https://api.meetcampfire.com/coa/api/v1/credit-memo/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "750.00",
  "internal_message": "Adjusted credit amount per client request - approval #CM-2024-456"
}'
{
  "id": "9a4bc225-ebe6-41fa-9a2f-de7947899c6c",
  "number": "CM-2024-001",
  "date": "2024-03-15",
  "amount": "750.00",
  "currency": "USD",
  "exchange_rate": "1.0000",
  "amount_used": "0.00",
  "amount_available": "750.00",
  "status": "open",
  "client": {
    "id": "client-uuid-123",
    "name": "Acme Corporation",
    "currency": "USD"
  },
  "entity": {
    "id": "entity-uuid-456",
    "name": "Tech Solutions LLC"
  },
  "internal_message": "Adjusted credit amount per client request - approval #CM-2024-456",
  "client_message": "Credit for overpayment on Invoice #INV-2024-001",
  "line_items": [
    {
      "id": "line-item-uuid-789",
      "account": {
        "id": "account-uuid-revenue",
        "name": "Revenue - Software Licenses",
        "code": "4001"
      },
      "description": "Credit for software license overpayment",
      "amount": "750.00",
      "department": {
        "id": "dept-uuid-sales",
        "name": "Sales Department"
      },
      "product": {
        "id": "product-uuid-license",
        "name": "Enterprise License"
      }
    }
  ],
  "applied_payments": [],
  "tags": [
    "overpayment",
    "software-license"
  ],
  "contract": null,
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-16T14:22:00Z"
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Body

Response

200 - application/json

The response is of type object.