/// <summary>
/// Mark the status of the invoice as refunded.
/// </summary>
/// <param name="apiContext">APIContext used for the API call.</param>
/// <param name="invoiceId">ID fo the invoice to mark as refunded.</param>
/// <param name="refundDetail">RefundDetail</param>
public static void RecordRefund(APIContext apiContext, string invoiceId, RefundDetail refundDetail)
{
// Validate the arguments to be used in the request
ArgumentValidator.ValidateAndSetupAPIContext(apiContext);
ArgumentValidator.Validate(invoiceId, "invoiceId");
ArgumentValidator.Validate(refundDetail, "refundDetail");
// Configure and send the request
var pattern = "v1/invoicing/invoices/{0}/record-refund";
var resourcePath = SDKUtil.FormatURIPath(pattern, new object[] { invoiceId });
PayPalResource.ConfigureAndExecute(apiContext, HttpMethod.POST, resourcePath, refundDetail.ConvertToJson());
}
/// <summary>
/// Marks the status of an invoice, by ID, as refunded. In the JSON request body, include a payment detail object that defines the payment method and other details.
/// </summary>
/// <param name="apiContext">APIContext used for the API call.</param>
/// <param name="refundDetail">RefundDetail</param>
public void RecordRefund(APIContext apiContext, RefundDetail refundDetail)
{
Invoice.RecordRefund(apiContext, this.id, refundDetail);
}
/// <summary>
/// Mark the status of the invoice as refunded.
/// </summary>
/// <param name="apiContext">APIContext used for the API call.</param>
/// <param name="invoiceId">ID fo the invoice to mark as refunded.</param>
/// <param name="refundDetail">RefundDetail</param>
public static void RecordRefund(APIContext apiContext, string invoiceId, RefundDetail refundDetail)
{
// Validate the arguments to be used in the request
ArgumentValidator.ValidateAndSetupAPIContext(apiContext);
ArgumentValidator.Validate(invoiceId, "invoiceId");
ArgumentValidator.Validate(refundDetail, "refundDetail");
// Configure and send the request
var pattern = "v1/invoicing/invoices/{0}/record-refund";
var resourcePath = SDKUtil.FormatURIPath(pattern, new object[] { invoiceId });
PayPalResource.ConfigureAndExecute(apiContext, HttpMethod.POST, resourcePath, refundDetail.ConvertToJson());
}
/// <summary>
/// Mark the status of the invoice as refunded.
/// </summary>
/// <param name="apiContext">APIContext used for the API call.</param>
/// <param name="refundDetail">RefundDetail</param>
public void RecordRefund(APIContext apiContext, RefundDetail refundDetail)
{
Invoice.RecordRefund(apiContext, this.id, refundDetail);
}
protected override void RunSample()
{
// ### Api Context
// Pass in a `APIContext` object to authenticate
// the call and to send a unique request id
// (that ensures idempotency). The SDK generates
// a request id if you do not pass one explicitly.
// See [Configuration.cs](/Source/Configuration.html) to know more about APIContext.
var apiContext = Configuration.GetAPIContext();
// ### Create an invoice
// For demonstration purposes, we will create a new invoice for this sample.
var invoice = new Invoice()
{
// #### Merchant Information
// Information about the merchant who is sending the invoice.
merchant_info = new MerchantInfo()
{
email = "*****@*****.**",
first_name = "Dennis",
last_name = "Doctor",
business_name = "Medical Professionals, LLC",
phone = new Phone()
{
country_code = "001",
national_number = "4083741550"
},
address = new InvoiceAddress()
{
line1 = "1234 Main St.",
city = "Portland",
state = "OR",
postal_code = "97217",
country_code = "US"
}
},
// #### Billing Information
// Email address of invoice recipient and optional billing information.
// > Note: PayPal currently only allows one recipient.
billing_info = new List<BillingInfo>()
{
new BillingInfo()
{
// **(Required)** Email address of the invoice recipient.
email = "*****@*****.**"
}
},
// #### Invoice Items
// List of items to be included in the invoice.
// > Note: 100 max per invoice.
items = new List<InvoiceItem>()
{
new InvoiceItem()
{
name = "Sutures",
quantity = 100,
unit_price = new Currency()
{
currency = "USD",
value = "5"
}
}
},
// #### Invoice Note
// Note to the payer. Maximum length is 4000 characters.
note = "Medical Invoice 16 Jul, 2013 PST",
// #### Payment Term
// **(Optional)** Specifies the payment deadline for the invoice.
// > Note: Either `term_type` or `due_date` can be sent, **but not both.**
payment_term = new PaymentTerm()
{
term_type = "NET_30"
},
// #### Shipping Information
// Shipping information for entities to whom items are being shipped.
shipping_info = new ShippingInfo()
{
first_name = "Sally",
last_name = "Patient",
business_name = "Not applicable",
address = new InvoiceAddress()
{
line1 = "1234 Broad St.",
city = "Portland",
state = "OR",
postal_code = "97216",
country_code = "US"
}
}
};
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.AddNewRequest("Create the invoice", invoice);
#endregion
// Create the invoice
var createdInvoice = invoice.Create(apiContext);
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.RecordResponse(createdInvoice);
this.flow.AddNewRequest("Send the invoice", createdInvoice);
#endregion
// Send the created invoice
createdInvoice.Send(apiContext);
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.RecordActionSuccess("Invoice sent successfully.");
#endregion
// Use the `PaymentDetail` object to specify the details of the payment.
var paymentDetail = new PaymentDetail
{
method = "CASH",
date = "2014-07-06 03:30:00 PST",
note = "Cash received."
};
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.AddNewRequest("Mark the invoice as paid", paymentDetail);
#endregion
// Mark the invoice as paid.
createdInvoice.RecordPayment(apiContext, paymentDetail);
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.RecordActionSuccess("Invoice successfully updated.");
#endregion
// Use the `PaymentDetail` object to specify the details of the payment.
var refundDetail = new RefundDetail
{
date = "2014-07-06 03:30:00 PST",
note = "Refund provided by cash."
};
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.AddNewRequest("Mark the invoice as refunded", refundDetail);
#endregion
createdInvoice.RecordRefund(apiContext, refundDetail);
// ^ Ignore workflow code segment
#region Track Workflow
this.flow.RecordActionSuccess("Invoice successfully updated.");
#endregion
// For more information, please visit [PayPal Developer REST API Reference](https://developer.paypal.com/docs/api/).
}
