How to get all Customer Credit Invoices

[Thomas Adrian - Consili]

I am trying to understand which endpoint I should use to get invoice credit notes.

I have found a few:

1 /CustomerInvoice (with "document type" Credit Note, which is deprecated)

2 /CustomerCreditNotes (without "document type" because it is deprecated)

3 /Customer/Invoice (with "document type" Credit Note, which is deprecated)

4 /Customer/Document (with "document type" Credit Note, which is deprecated)

5 /CustomerDocument (with "document type" Credit Note, which is deprecated)

6 /CustomerPayment (with "paymenttype" set to Credit Note) 

My questions are:

1. which endpoint I should use to get invoice credit notes. do all point to the same "notes" (credit invoice)?

2. Can a /CustomerInvoice have a minus amount and be classified as a credit note?

3. is a "credit note" the same as a "credit invoice"?

thanks

Thomas

[Magnus Johnsen · Accepted solution]

Hi,

1. If you want to get all creditNotes for one customer you use the customer/document endpoint with the document type parameter:

As it is mentioned in the message, the deprecration is only for the specific endpoints. It works for the document endpoint.

If you want to get creditNotes for all customers, you either use, customerCreditNote:

Or, customerPayment with the paymentType CreditNote:

2. No an invoice needs to have a positive amount.

3. A credit note created in the invoice module is a credit note, and will also show up in the customer payment module. 

I would recommend that you have a look at how it behaves in the UI on the screenId's that are shown in the screenshots.