Create Credit Note

Creates a new credit note to offset or reduce a customer's outstanding invoice.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supported Apps

AppApp IDRemarks
Xeroxero
QuickbooksquickbooksThe fields status, lineItem.accountId, lineItem.itemCode, lineItem.itemName, and lineItem.taxAmount will not be honored.
Zohobookszohobookcurrency expects currencyId as input, which can be obtained using List Currencies..
FreshbooksfreshbooksThe API response does not return creditNoteId. Use the List Credit Notes API to fetch Credit Note details.
Microsoft Dynamics Business Centralmicrosoft-dynamics-business-centralAllowed values for status are DRAFT and SUBMITTED. Once credit note is submitted, it cannot be updated or deleted.
Netsuitenetsuite
Sage 200 Standardsage200contactId, date, referenceNumber, exchangeRate are honored fields.
Odoo Accounting OnlineodooitemId, quantity, unitAmount, discount, accountId are honored fields in lineItems. the status is by default draft when an vendor credit is created, use Update Credit Note to change it to posted. currency expects currencyId as input, which can be obtained using List Currencies.
Body Params
string
required
lineItems
array of objects
required

At least one lineItem is required to create a Credit Note.

lineItems*
string

The issue date of the credit note. It should be in format yyyy-mm-dd'T'hh:mm:ssZ

string

Status values can vary depending upon apps . It could be DRAFT, VOID, SUBMITTED, PAID etc.

string
string
double
string
string

Standard currency codes like USD, INR etc

string

JSON-formatted string containing set of key-value attributes to provide additional data

Response

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json