How to Use Credit Memos
Creating a Credit Memo in Our Platform
transactionType
parameter within the PUT /v1/transactions/source/{source}/externalId/{externalId}
endpoint allows for the creation of credit memos through two specific types: REFUND
and TAXABLE_REFUND
.REFUND
/ TAXABLE_REFUND
):REFUND
credit memo if we have a linked invoice in order to avoid discrepancies in our transactions.shippingAddress
provided in the request.REFUND
:transactionType
is set to REFUND
, the system generates a credit memo from the createdFrom
transactionId. otherwise, it issues a stand-alone credit memo with the total amount.createdFrom
(string): Specifies the original transactionId
from which this credit memo is derived. If provided, the system retrieves the original transaction and uses its amount and tax details for the new credit memo.refundLinkedPercentage
(number, 0-1): Determines the percentage of the original sales tax amount to credit. For example, if the original sales tax is $30
and refundLinkedPercentage
is 0.5
, the credit memo will reflect a sales tax of $15
.TAXABLE_REFUND
:transactionType
is set to TAXABLE_REFUND
, the system creates a credit memo based on the totalAmount
provided. The sales tax is calculated according to the shippingAddress
specified in the request.{
"externalId": "INV172037616",
"source": "9",
"items": [
{
"unitPrice": 100,
"quantity": 1,
"totalPrice": 100,
"description": "Product Return",
"name": "Product XYZ",
"taxCode": "C1S1",
"manualSalesTax": false,
"manualSalesTaxRate": 0
}
],
"shippingAddress": {
"city": "Example City",
"country": "US",
"state": "EX",
"street": "123 Example St",
"zip": "12345"
},
"customerId": "vG9s_bmFkw7Km3OuIwgL7Q",
"transactionStatus": "ACTIVE",
"transactionType": "REFUND",
"createdFrom": "INV172037615",
"currency": "USD"
}
transactionType
parameter, please refer to our API documentation.Modified at 2025-03-12 11:00:04