Home » Reseller Guides » Reseller API Guide » HTTP API » API Requests » Common » Billing

Adding a Debit Note in a Customer Account

Description

Adds a debit note for Customer account.

Parameters

Name Data Type Required / Optional Description
auth-userid Integer Required Authentication Parameter
api-key or auth-password String Required Authentication Parameter
customer-id Integer Required Customer Id of Customer for whom debit note to be added
selling-amount Float Required Amount of debit note in the selling currency of parent Reseller
description String Required Description for the debit note.
debit-note-date Integer Required Date in epoch time format on which debit note 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 parent Reseller. Required if selling and accounting currencies of parent Reseller are different.
conversion-rate Float Optional Conversion rate between selling and accounting amounts. Required if selling and accounting currencies of 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 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 Debit Note Id (Transaction Id) if debit note added successfully in the specified Customer's account.