Credit memo partially appliedWebhook

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Credit memo webhook request body resource.

creditMemoId
string <= 50 characters

ID of the credit memo.

eventType
string

Rebilly webhooks event type.

Enum: "credit-memo-applied" "credit-memo-created" "credit-memo-modified" "credit-memo-partially-applied" "credit-memo-voided"
object

Embedded objects.

object (CreditMemo)

Credit memo object.

customerId
required
string (CustomerId) <= 50 characters

Customer resource ID.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

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.

invoiceId
string or null <= 50 characters

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

Array of objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "creditMemo"
Responses
2xx

Returns any 2xx status to indicate that the data received.

Request samples
application/json
{
  • "creditMemoId": "cm_0YV7DE1YYBC7C9JJ79J2PBB5RR",
  • "eventType": "credit-memo-applied",
  • "_embedded": {
    },
  • "_links": [
    ]
}