Get an invoice by payment reference number

Description

Retrieves an invoice by it's payment reference number.

Package Details

Interface

IInvoiceManager

Syntax

await invoiceManager.GetByPaymentReference(string reference);

Returns

Task<Invoice>

API

GET
/api/v1/invoices?reference=your_number

Parameters

Querystring
reference (string): the payment reference number.

Returns

200 OK - Invoice

Example

//get the invoice by payment reference number.
const string paymentReferenceNumber = "123xyz;"
var invoice = await invoiceManager.GetByPaymentReference(paymentReferenceNumber);