Invoice Creation | Novalnet Docs

 Invoice Creation

This action is used to create the Customer Invoice pdf generation.

This is only necessary if you use the additional feature of Novalnet for the invoice generation. But before, please activate the additional service named End customer invoicing on Novalnet Admin Portal under Additional Services menu.

Header Authentication

To authenticate your payment requests, use Novalnet's custom header authentication. The custom header field is constructed as follows:

  1. Each header request is built using the Payment access key. To get your Payment Access Key, login to your Novalnet Admin Portal and navigate to the path Projects -> [Select Desired Project] -> API credentials -> Payment access key.
  2. The Payment Access Key should be encoded using a variant of Base64.
  3. The resultant base64_encoded value should be passed in the Novalnet's custom header key X-NN-Access-Key.
    The custom header field is formulated in the format
    X-NN-Access-Key:base64_encoded_value.

All requests must be carried out through an HTTPS connection along with the header values, otherwise, the request will fail with authorization error messages.

Your Payment Access Key carry many privileges, so be sure to keep them secure! Do not share your secret Payment Access Key in publicly accessible areas such as GitHub, client-side code, and so forth.

HTTP request headers

X-NN-Access-Key
base64_encode({PAYMENT_ACCESS_KEY})
Content-Type
application/json
Accept
application/json
Charset
utf-8

End Point

URL:

https://payport.novalnet.de/v2/transaction/invoice

Parameter List

Each request is separated into so-called objects which indicate an entity

Each parameter is marked with attributes Mandatory, Conditional, Optional. Based on your necessity, you can use these parameters accordingly.

- Icon denotes the parameter is used on the conditional attribute basis, and hovering on this icon will give you the details about that condition.

- Icon denotes the payment methods supported or relevant to the parameter defined, and hovering on this icon will give you the details of the list of payment methods supported.

transaction
Object
invoicing
Object
customer_support
String
Optional
Max Mustermann | Email: support@yourshop.de Customize the customer support details here notice
Object
Optional
{'1' : 'Notice 1', '2' : 'Notice 2', '3' : 'Notice 3'} The notification which you wants to provide to the end-customer in invoice PDF. You can add upto three notifications per transaction. reference
String
Conditional
4-20-270 The reference value returned during the Initial (DEBIT) transaction Invoice process

Note: It is mandatory for the following types: CREDIT, CORRECTION, CANCEL date
String
Optional
2026-08-19 The date in which the invoice need to be generated

Note: The format to be specified is "YYYY-MM-DD".

type
String
Optional
DEBIT The invoice type denotes the reason for the invoice generation

The following values are permitted:
  • DEBIT for "Regular invoice (by default)"
  • CREDIT for "Credit note invoice"
  • CORRECTION for "Invoice correction"
  • CANCEL for "Cancellation invoice"



custom_invoice_no
String
Optional
INV-32 A customized invoice number which will be used instead of the default system generated invoice number.

Note: The value should be unique for each invoice generation request. send_invoice_pdf
Integer
Conditional
1 The end customer will receive an Invoice PDF as an attachment in the invoicing email.

  • 1 - send the Invoice PDF to the end customer
  • 0 - skip the delivery of the Invoice PDF.
coupon_percent
Integer
Optional
1 Discount percentage assigned for the coupon. coupon_amount
Integer
Optional
10 Discount amount calculated from the cart value. accounting
Object
Hide child object
end_date
String
Optional
2022-02-25 The end date of Invoice accounting
custom
Object
customer
Object
result
Object
invoicing
Object