Credit Note¶

Credit Note is a document issued to correct a mistake in case the invoice has overcharged (or contains another mistakes) or in case the seller (you) is crediting some amount to customer’s account. BizBox offers you a default Credit Note template - a basic pattern for simple Credit Note generation. This default template contains parameters which adds to a Credit Note with actual data from Branch, order and customer.

There are some prerequisites you need to fulfil in order to use your Credit Note template successfully: Credit Note Template, E-shop Settings and Document Sequences.

The Credit Note template itself. You can use the default one or code your own in the Templates application
It is necessary to create a Document Sequences in the Administration module in the Document Sequences application. Document Sequence generates unique numbers for your Invoices because every Credit Note must have an identification number. These Document Sequence have to be added to the E-shop Settings.
Created Credit Note template has to be also connected with particular E-shop Settings. Without setting the template, it will not be possible to refund the order.

Create a Credit Note¶

Credit Notes are created in the Templates application in a particular website editor. As a default you can see here a default Credit Note. You can create your own or you can just edit the default one according to your needs. In this tutorial we have created a copy of the default one that will be modified.

Before you start creating your Credit Note you need to know, that the Credit Note is a personalized document. It means that every customer has their own Credit Note that contains information about the customer and the customer’s purchase. This customization is provided by a parameter. Parameter carries particular information (such as a customer’s name of products from order) that is connected with the customer and particular order.

If you insert these parameters into the Credit Note code, you create a personalized document. If you need more information about parameters and how to use them, visit the Credit Note parameters section.

If you want to know how to create and use an Credit Note on your online store, please follow this tutorial. We assume that you already have:

A functional online store with products, so you can test your Invoice after you create it
A Branch which is used to dispatch orders from your online store (information about a Branch will be used and displayed in the Invoice)
An E-shop Setting where you will define the usage of the Invoice we will create in this tutorial
Document Sequence for an Invoice that generates a unique number of Invoices
A little experience with coding in HTML. You don’t need to be a programmer, but you should know the base and be able to create a valid HTML document.

If you don’t have something from the list above, please follow related tutorials and create all these prerequisites before you start with the Invoice.

If you have it, you can start with the tutorial:

Run a partiuclar website editor.
Run the Templates application (Tools and Settings tab) by simply clicking on its name.
Double-click the record named „Credit Note” which is the default Credit Note.
Here click the „Content” tab, mark all of its content and, copy it to the clipboard.
Close the window with the default Credit Note.
In the toolbar click the „New” button.
- Insert Name (a required field that is never displayed to customers and serves only for your own and BizBox Admin purposes).
- Description field is optional, but we recommend you to insert short info about this Invoice, because it can save your time in the future.
- Parent Template field is used in case you want to insert this template into another one. Leave this field blank, because we are not creating such a thing in this tutorial.
- System Language defines the language in which this template is coded. This is really important if you are using a multilingual Website because you can subsequently create translations for it. Offered languages are dependent on the languages you have added into BizBox. If you are looking for a language that is not a part of this selection, add it in the Languages application first. Remember that the default Invoice has not created the translation strings. In case you translate it, don’t forget to create them. Otherwise you won’t be able to translate it.
Click the Add button.
The Content tab is opened automatically and you have to insert the copied content from the default Credit Note here. When you are done, click the Save button located in the toolbar. Now you have created the copy of the default Credit Note which you can freely edit.
As you can see, Credit Note is coded in table form. Right in the beginning you can see a parameter {{ invoice.number }} that carries the number of the Invoice. This number is generated thanks to Document Sequences (this is why it is necessary to have created and added Document Sequences in the E-shop Settings).
Parameter display a particular value in the final Credit Note. To see all the parameters you can use on your Credit Note, visit the Credit Note parameters section.
Code and change the template according to your needs. After that click the Save button and your Credit Note is ready for add to E-shop Settings.

Now it’s the time to add this Credit Note to your e-shop settings. We assume that you already have created your E-shop Settings and you are only missing a Credit Note.

Run the Administration module by double-clicking. Its icon is located on the desktop.
Run the E-shop Settings application by simply clicking on its name.
Double-click the particular E-shop Settings you are using on your online store.
Navigate to the Documents tab and click the Add button.
- In the Type field select Credit Note, because you want to add a Credit Note to this E-shop Setting.
- In the Template field select the Name of the template you have created in the first part of this tutorial.
Click the Add button and also the Save button located in the tool bar.
Now is your Credit Note ready!

Credit Note Parameters¶

Parameter	Type of a Parameter	Short Parameter Description
invoice	Object	An object used to unite all Invoice parameters listed below.
invoice.number	String	An Invoice number.
invoice.issueDate	NetteDateTime	The date when the Invoice was issued.
invoice.paymentDueDate	NetteDateTime	The date until the Invoice should be paid.
invoice.taxPointDate	NetteDateTime	The date on which VAT becomes chargeable on a transaction.
order	Object	An object used to unite all Order parameters listed below.
order.taxInclusiveAmount	Integer	A total purchase price with tax included.
order.taxExclusiveAmount	Integer	A total purchase price without tax included.
order.taxInclusivePaidAmount	Integer	A total paid purchase price with tax included.
order.taxExclusivePaidAmount	Integer	A total paid purchase price without tax included.
order.taxAmount	Integer	A total tax amount for purchase.
order.currency.iso	String	Currency connected with a particular purchase.
order.createdDate	NetteDateTime	The date of order creation.
order.id	Integer	A system generated identification order number.
order.orderNumber	Integer	Number of a particular order generated according to Document Sequences.
order.items	Array of objects	All items connected with this Order.
product	Object; used locally in the template	A particular item (Product, Payment or Delivery Method) on this order.
order.item.name	String	A name of a particular item.
order.item.quantity	Integer	A quantity of a particular item.
order.item.taxInclusiveAmount	Integer	A tax-inclusive amount of a particular item.
order.item.taxExclusiveAmount	Integer	A tax-exclusive amount of a particular item.
order.item.taxAmount	Integer	A tax amount of a particular item.
order.item.currencyName	String	A currency name connected with a particular item.
order.item.currencySymbol	String	A currency symbol of a particular item.
order.item.taxInclusiveUnitPrice	Integer	A tax-inclusive unit price of a particular item.
order.item.taxExclusiveUnitPrice	Integer	A tax-exclusive unit price of a particular item.
order.item.taxes	Array of objects	All taxes connected with a particular Product.
order.item.tax.rate	String	A rate of a particular Tax connected with this Product.
order.deliveryDetail.name	String	A name of Delivery Method used for order.
order.deliveryDetail.taxExclusiveAmount	Integer	A tax-exclusive amount of a selected Delivery Method.
order.deliveryDetail.taxInclusiveAmount	Integer	A tax-inclusive amount of a selected Delivery Method.
order.deliveryDetail.taxType.rate	String	A rate of particular Tax of a selected Delivery Method.
order.deliveryDetail.taxAmount	Integer	A tax amount of a selected Delivery Method.
order.handlingDetail.taxExclusiveAmount	Integer	A tax-exclusive amount of a selected Handling Method.
order.handlingDetail.taxAmount	Integer	A tax amount of a selected Handling Method.
order.handlingDetail.taxInclusiveAmount	Integer	A tax-inclusive amount of a selected Handling Method.
order.paymentDetail.taxInclusiveAmount	Integer	A tax-inclusive amount of a selected Payment Method.
order.paymentDetail.paymentMethod.name	String	A name of Payment Method used for order.
order.paymentDetail.taxExclusiveAmount	Integer	A tax-exclusive amount of a selected Payment Method.
order.paymentDetail.taxType.rate	String	A rate of particular Tax of a selected Payment Method.
order.paymentDetail.taxAmount	Integer	A tax amount of a selected Payment Method.
order.amountDue	Integer
order.roundingTaxRate	Integer	Rounded tax rate.
order.roundingTaxAmount	Integer	Rounded tax amount.
order.taxInclusiveRoundingAmount	Integer	Rounded tax-inclusive amount.
order.taxExclusiveRoundingAmount	Integer	Rounded tax-exclusive amount.
order.taxSummary.taxExclusiveAmount	Integer	A tax-exclusive amount.
order.taxSummary.taxType.rate	Integer	A rate of particular tax type.
order.taxSummary.amount	Integer	A total tax amount.
order.taxSummary.taxInclusiveAmount	Integer	A tax-inclusive amount.
order.customer.honorific	String	A customer’s honorific.
order.customer.firstName	String	A customer’s first name.
order.customer.lastName	String	A customer’s last name.
order.customer.email	String	A customer’s e-mail address.
order.customer.ipAddress	String	A customer’s IP Address.
order.billingAddress	Object	An object used to unite all customer billing address parameters listed below.
order.billingAddress.company	String	A customer’s company name.
order.billingAddress.street	String	A customer’s street.
order.billingAddress.country.name	String	A customer’s country name.
order.billingAddress.city	String	A customer’s city.
order.billingAddress.region	String	A customer’s region.
order.billingAddress.postalCode	String	A customer’s postal code.
order.billingAddress.county	String	A customer’s county.
order.branch	Object	An object used to unite all Branch parameters listed below.
order.branch.name	String	A name of a Branch used for order.
order.branch.street	String	A street of a Branch used for order.
order.branch.city	String	A city of a Branch used for order.
order.branch.postalCode	String	A postal code of a Branch used for order.
order.branch.countryName	String	A country name of a Branch used for order.
order.branch.legalNotice	String	A legal notice of a Branch used for order.
order.branch.www	String	A URL site of a Branch used for order.
order.branch.taxIdentity	String	A tax identity of a Branch used for order.
order.branch.vatPayer	Boolean	Defines if a particular Branch is a VAT Payer.
order.branch.identificationNumber	String	An identification number of a Branch used for order.
order.branch.supportPhone	String	A support phone of a Branch used for order.
order.branch.supportEmail	String	A support e-mail address of a Branch used for order.
order.branch.bankCode	String	A bank code of a Branch used for order.
order.branch.accountNumber	String	An account number of a Branch used for order.
order.branch.iban	String	An IBAN of a Branch used for order.
order.branch.swift	String	A SWIFT of a Branch used for order.
creditNote.discounts	Object	An object used to unite all Discounts parameters listed below.
creditNote.discounts.taxAmount	Integer	A tax amount applied on a discount.
creditNote.discounts.taxExclusiveAmount	Integer	A total discount tax-exclusive price.
creditNote.discounts.taxInclusiveAmount	Integer	A total discount tax-inclusive price.
creditNote.discounts.name	String	A particular Discount’s name.
creditNote.discounts.voucherCode	String	A particular Discount’s Voucher code.
creditNote.customerPaymentDetail	Object	An object used to unite all customer payment details parameters listed below.
creditNote.customerPaymentDetail.accountNumber	String	A customer’s account number used for refundation.
creditNote.customerPaymentDetail.bankName	String	A name of customer’s bank.
creditNote.customerPaymentDetail.bankCode	String	A code of customer’s bank.
creditNote.customerPaymentDetail.iban	String	An IBAN of customer’s bank.
creditNote.customerPaymentDetail.swift	String	A SWIFT of customer’s bank.