Title: Create Credit Notes or Discounts for Invoices via API
PrimaryCategory: Account Management &amp; Billing
Type: Procedural
Tags: credit_note, discount, invoice, api, billing
Source UI Terms: auth-userid, api-key, invoice-id, amount, transaction-key, role
Source Reference: Create Credit Notes or Discounts for Invoices via API

Prerequisites:
- Have valid authentication credentials: auth-userid (Integer) and api-key (String).
- Know the invoice-id (Integer) to which you want to apply the credit note or discount.
- Prepare a unique transaction-key (String) for this operation.
- Determine the amount (Float) of credit or discount.
- Identify the role (String) as either reseller or customer.

Steps:
1) Construct a POST HTTP request to the endpoint:  
   `https://test.httpapi.com/api/billing/credit-note.json`
2) Include the following URL query parameters with your request:  
   - auth-userid: your authentication user ID (Integer)  
   - api-key: your API key (String)  
   - invoice-id: the invoice ID to discount (Integer)  
   - amount: the credit or discount amount (Float)  
   - transaction-key: a unique transaction key (String)  
   - role: specify &#39;reseller&#39; or &#39;customer&#39; (String)
3) Send the POST request to apply the credit note or discount.
4) Check the response.  
   - A successful request returns `true`.  
   - On error, the response contains a `status` key with value `ERROR` and an error message.

Summary:
You can create a credit note or apply a discount to an invoice by sending a POST request with required authentication, invoice ID, amount, unique transaction key, and role parameters. A successful response returns true.

Evaluation Pairs:
Q: What parameters are required to create a credit note or discount via the API?  
A: You must provide auth-userid, api-key, invoice-id, amount, transaction-key, and role.

Q: What HTTP method is used to apply a credit note or discount on an invoice?  
A: POST.

Q: How can you tell if the API request to discount an invoice was successful?  
A: The API returns &#39;true&#39; on success; an error includes a status key with value ERROR and an error message.

<p>When you want to create a credit note or apply a discount to an invoice using the API. This article explains the required parameters, API request format, and response details for discounting invoices.</p>
<div class="region region-content">
<div class="block block-core block-page-title-block" id="block-twostates-page-title">
<div class="content">
<h1 class="title page-title"><span class="field field--name-title field--type-string field--label-hidden">Discounting an Invoice</span><a href="/help/article/answer/2414#heading_0" target="_blank"></a></h1>
</div>
</div>
<div class="node__content clearfix">
<div class="layout layout--onecol">
<div class="layout__region layout__region--content">
<div class="clearfix text-formatted field field--name-body field--type-text-with-summary field--label-hidden field__item">
<h2><a name="heading_0"></a>Description</h2>
<p>Create a credit note or give a discount for a given invoice.</p>
<h2><a name="heading_1"></a>Parameters</h2>
<table class="codetable"><tbody><tr><th colspan="1" rowspan="1">Name</th><th colspan="1" rowspan="1">Data Type</th><th colspan="1" rowspan="1">Required / Optional</th><th colspan="1" rowspan="1">Description</th></tr><tr><td colspan="1" rowspan="1">auth-userid</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">api-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Authentication Parameter</td></tr><tr><td colspan="1" rowspan="1">invoice-id</td><td colspan="1" rowspan="1">Integer</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">Invoice id to be discounted</td></tr><tr><td colspan="1" rowspan="1">amount</td><td colspan="1" rowspan="1">Float</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">The amount for which the credit note is issued</td></tr><tr><td colspan="1" rowspan="1">transaction-key</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">A unique Transaction key</td></tr><tr><td colspan="1" rowspan="1">role</td><td colspan="1" rowspan="1">String</td><td colspan="1" rowspan="1">Required</td><td colspan="1" rowspan="1">reseller/customer</td></tr></tbody></table>
<h2><a name="heading_2"></a>HTTP Method</h2>
<p>POST</p>
<h2><a name="heading_3"></a>Example Test URL Request</h2>
<p><code>https://test.httpapi.com/api/billing/credit-note.json?auth-userid=0&amp;api-key=0&amp;invoice-id=0&amp;amount=0.0&amp;transaction-key=transaction-key-text&amp;role=customer </code></p>
<h2><a name="heading_4"></a>Response</h2>
<p>Returns &#39;true&#39; when successful.</p>
<p>In case of any errors, a status key with value as ERROR along with an error message will be returned.</p>
</div>
</div>
</div>
</div>
</div>

When you want to create a credit note or apply a discount to an invoice using the API. This article explains the required parameters, API request format, and response details for discounting invoices.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
invoice-id	Integer	Required	Invoice id to be discounted
amount	Float	Required	The amount for which the credit note is issued
transaction-key	String	Required	A unique Transaction key
role	String	Required	reseller/customer