Accessing invoices and credit memos
Learn how to access order invoices and credit memos and then share them with your customers
Last updated
Learn how to access order invoices and credit memos and then share them with your customers
Last updated
For some transactions, Digital River automatically generates the order invoice and credit memo files that you can access and then share with your customers. To do this, you can implement nearly identical solutions.
To localize these files, set the locale
.
For testing purposes, we also allow you to generate mock order invoices and credit memos.
In transactions assigned to one of the following selling entities, Digital River generates an order invoice in PDF that you can share with customers:
Digital River, Inc.
DR globalTech Inc.
Digital River Ireland Ltd.
Digital River UK
DR Japan
By listening for the order invoice created event or by retrieving the order, you can get an invoice's file identifier and then use it to generate a shareable link.
You can also download an invoice in Digital River Dashboard.
You'll need to use invoicePDFs[].id
to create a publicly accessible link.
The response contains a url
you can share with your customers by email, in their account management portals, or by another method of your choice.
A credit memo is a document issued to customers notifying them of a reduced amount they owe.
By listening for the credit memo created event or by retrieving the order, you can get a credit memo's file identifier and then use it to generate a shareable link.
You'll need to use creditMemoPDFs[].id
to create a publicly accessible link.
The response contains a url
you can share with your customers by email, in their account management portals, or by another method of your choice.
The following are example mock tax invoice and credit memo PDFs:
You can be notified when the invoice is created by listening for the with a type
of order.invoice.created
.
The event's data.object
contains an id
and a fileId
, both of which are identical and contain the invoice's identifier. You can use either to create a publicly accessible link.
In the event's data.object
, the invoiceURL
can only be accessed with your . Since your customers won't be able to access the contents of this link, don't share it with them.
To access the customer invoice file, you can also .
Once invoices are generated, Digital River populates the invoicePDFs[]
. If invoicePDFs[]
doesn't exist, then the have yet to be created.
Each element of this array contains a unique id
and url
.
In the , the invoicePDFs[].url
can only be accessed with your . Since your customers won't be able to access the contents of this link, don't share it with them.
To create a publicly accessible link to the invoice , assign its identifier to fileId
and send it in the body of a request.
You can be notified when a credit memo is created by listening for the with a type
of order.credit_memo.created
.
The event's data.object
contains an id
and a fileId
, both of which are identical and contain the credit memo's identifier. You can use either to create a publicly accessible link.
In the event's data.object
, the invoiceURL
can only be accessed with your . Since your customers won't be able to access the contents of this link, don't share it with them.
To access a customer's credit memo file, you can also .
Once credit memos are generated, Digital River populates the creditMemoPDFs[]
. If creditMemoPDFs[]
doesn't exist, then the have yet to be created.
Each element of this array contains a unique id
and url
.
In the , the creditMemoPDFs[].url
can only be accessed with your . Since your customers won't be able to access the contents of this link, don't share it with them.
To create a publicly accessible link to a customer's credit memo , assign its identifier to fileId
and send it in the body of a request.
You can also generate the order invoice and credit memo files in . Accessing them is the same as in the production environment.