Credit Balance operations via REST

[Viktor]

Question:

How do I create / apply credit balances via REST?

[Viktor · Accepted solution]

Answer:

Here are the calls you can use for the various CB operations: 

POST https://rest.apisandbox.zuora.com/v1/object/credit-balance-adjustment

{
"Amount": 55.0,
"Comment" : "TRANSFER NEGATIVE INVOICE BALANCE TO ACCOUNT CB",
"SourceTransactionNumber": "INV00003019",
"Type": "Increase"
}

POST https://rest.apisandbox.zuora.com/v1/object/credit-balance-adjustment

{
"Amount": 55.0,
"Comment" : "APPLY EXISTING CREDIT BALANCE TO AN UNSETTLED INVOICE",
"SourceTransactionNumber": "INV00003020",
"Type": "Decrease"
}

TO CREATE AN OVERPAYMENT AND APPLY THE AMOUNT TO THE ACCOUNT'S CREDIT BALANCE:

POST https://rest.apisandbox.zuora.com/v1/object/payment

{
"AccountId": "2c92c0f95bae6218015bafd38d45109e",
"Amount": 100,
"AppliedCreditBalanceAmount": 100,
"EffectiveDate": "2017-04-20",
"PaymentMethodId": "2c92c0f848a2eacf0148a38c70a54512",
"Status": "Processed",
"Type": "External"
}