GetByPaymentReference()
- Richard Potter (Unlicensed)
- GT (Unlicensed)
Owned by Richard Potter (Unlicensed)
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
Parameter | Description | Parameter Type |
|---|---|---|
reference | the payment reference number | query string |
Returns
200 OK - Invoice
Example
const string paymentReferenceNumber = "123xyz";
var invoice = await invoiceManager.GetByPaymentReference(paymentReferenceNumber);