Description
Adds a Debit Note against Customer's Account.
Parameters
| Name |
Data Type |
Required / Optional |
Description |
|---|
| auth-userid |
Integer |
Required |
Authentication Parameter |
| api-key |
String |
Required |
Authentication Parameter |
| customer-id |
Integer |
Required |
Customer Id of Customer against whom Debit Note is to be added |
| selling-amount |
Float |
Required |
Amount of Debit Note in the Selling Currency of the Parent Reseller |
| description |
String |
Required |
Description for the Debit Note |
| debit-note-date |
Integer |
Required |
Date in epoch time format on which Debit Note is to be added |
| transaction-key |
String |
Required |
Unique Transaction key |
| update-total-receipt |
Boolean |
Required |
Possible values are true or false. Pass true if you want to update total receipt of Customer. |
| accounting-amount |
Float |
Optional |
Amount of Debit Note in the Accounting Currency of the Parent Reseller. Required if Selling and Accounting Currencies of the Parent Reseller are different. |
| conversion-rate |
Float |
Optional |
Conversion rate between selling and accounting amounts. Required if Selling and Accounting Currencies of the Parent Reseller are different. |
| payment-reminder-days |
Integer |
Optional |
No of days in which Customer needs to be reminded about Debit Note |
| greedy |
Boolean |
Optional |
Possible values are true or false. Pass true if you want the Debit Note to be Greedy. |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/add-customer-debit-note.json?auth-userid=0&api-key=key&customer-id=0&selling-amount=0.0&description=description-text&debit-note-date=0000000000&transaction-key=transaction-key-text&update-total-receipt=true
Response
Returns a Transaction Id (Integer) if the Debit Note is added successfully in the specified Customer's Account.
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.