Partially update a credit memo

Partially updates a credit memo with a specified ID.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json
object

Allocations reduce the unused amount of a credit memo.

Array of objects

Items of the credit memo.

reason
string

Reason for the credit memo.

Enum: "return" "product-unsatisfactory" "order-change" "order-cancellation" "chargeback" "write-off" "waiver" "customer-credit" "other"
description
string

Public description, that is visible to customers, which describes the purpose of the credit memo.

shippingAmount
number <double>
Default: 0

Shipping amount of an invoice to credit.

Responses
200

Credit memo updated.

Response Schema: application/json
id
string <= 50 characters

ID of the credit memo.

number
integer

Auto-incrementing number based on the sequence of credit memos for any particular customer.

object

Allocations reduce the unused amount of a credit memo.

Array of objects

Items of the credit memo.

status
string

Status of the credit memo.

Enum: Description
issued

The credit memo is available with a full amount to be applied.

applied

The full amount of the credit memo has been applied. No more credit can be created from it.

partially-applied

A partial amount of the credit memo has been applied. A credit can be created from the remaining amount.

voided

Credit memo has been voided and cannot be used anymore.

reason
string

Reason for the credit memo.

Enum: "return" "product-unsatisfactory" "order-change" "order-cancellation" "chargeback" "write-off" "waiver" "customer-credit" "other"
description
string

Public description, that is visible to customers, which describes the purpose of the credit memo.

shippingAmount
number <double>
Default: 0

Shipping amount of an invoice to credit.

taxAmount
number <double>
Default: 0

Sum of items tax amount of an invoice to credit.

totalAmount
number <double>
Default: 0

Total amount of all credits in the credit memo, including items, shipping, and tax.

unusedAmount
number <double>
Default: 0

Unused credit memo amount that has not been allocated.

revision
integer

Number of times the credit memo has been modified.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects

Related links.

customerId
required
string (CustomerId) <= 50 characters

ID of the customer resource.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

invoiceId
string or null <= 50 characters

ID of the invoice to which the credit memo is issued.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

422

Invalid data sent.

patch/credit-memos/{id}
Request samples
application/json
{
  • "allocations": {
    },
  • "items": [
    ],
  • "reason": "return",
  • "description": "string",
  • "shippingAmount": 0
}
Response samples
application/json
{
  • "id": "crmm_0YVCNN22TWC3G8H82QNPNVZCHG",
  • "number": 0,
  • "allocations": {
    },
  • "items": [
    ],
  • "status": "issued",
  • "reason": "return",
  • "description": "string",
  • "shippingAmount": 0,
  • "taxAmount": 0,
  • "totalAmount": 0,
  • "unusedAmount": 0,
  • "revision": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "customerId": "cus_0YV7DDSDD1C8DA64KHH2W33CPF",
  • "currency": "USD",
  • "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT"
}