Credit Notes via the API explained

Sometimes a Client may need to process a Credit Note (also known as credit memo). Issued to indicate a return of funds in the event of an invoice error, incorrect or damaged products, purchase cancellation or otherwise specified circumstance. This can be processed via the API.

First we create the Credit Note, which is essentially a NEGATIVE Sale Invoice

POST: /{cf_uri}/Sale/Invoice/Service

Here is an example of using only the required fields to create a CREDIT NOTE for $100

{
"Date": "2022-10-25T00:00:00",

"Customer": {
"UID": "bda2dcf4-4db1-4f82-b208-............"
},

"Total": -100.000000,

"Account": {
"UID": "7c60a04e-48ac-4df0-888f-............"
},
"TaxCode": {
"UID": "62324ffa-0dd0-4429-bdb0-............"
}

}

The next Step is processing the Credit to either be applied to an existing Invoice or paying out the Credit amount.

Apply Credit to existing Invoice via the API

We create a POST call to: /{cf_uri}/Sale/CreditSettlement

Here is an example using the required fields.

{
"CreditFromInvoice" : {

"UID":"efb6261b-04a1-47c4-89fe-............"
},

"Customer" : {

"UID":"bda2dcf4-4db1-4f82-b208-............"
},

"Date":"2022-10-25T00:00:00",

"Lines" : [
{

"Type":"Invoice",

"Sale" : {

"UID":"4dc0436d-1e89-4935-b8bb-............"
},

"AmountApplied":100.00

}
]
}

Settle as a Cash refund via the API

We create a POST call to: /{cf_uri}/Sale/CreditRefund
Here is an example using the required fields:

{
"Account" : {
"UID" : "7c60a04e-48ac-4df0-888f-............"
},
"Invoice" : {
"UID" : "2460d043-2c7f-4728-bf4d-............"
},
"Customer" : {
"UID" : "bda2dcf4-4db1-4f82-b208-............"
},
"Date" : "2022-10-25T00:00:00",
"Amount" : 100.00
}

If you have any questions, feel free to log a ticket with the Customisation & Integration Team.