private EnvelopeDefinition MakeEnvelope(string signerEmail, string signerName, string ccEmail, string ccName)
{
// Data for this method
// signerEmail
// signerName
// ccEmail
// ccName
// document 1 (html) has multiple tags:
// /l1q/ and /l2q/ -- quantities: drop down
// /l1e/ and /l2e/ -- extended: payment lines
// /l3t/ -- total -- formula
//
// The envelope has two recipients.
// recipient 1 - signer
// recipient 2 - cc
// The envelope will be sent first to the signer.
// After it is signed, a copy is sent to the cc person.
///////////////////////////////////////////////////////////////////
// //
// NOTA BENA: This method programmatically constructs the //
// order form. For many use cases, it would be //
// better to create the order form as a template //
// using the DocuSign web tool as a WYSIWYG //
// form designer. //
// //
///////////////////////////////////////////////////////////////////
// Order form constants
string l1Name = "Harmonica";
int l1Price = 5;
string l1Description = $"${l1Price} each"
, l2Name = "Xylophone";
int l2Price = 150;
string l2Description = $"${l2Price} each";
int currencyMultiplier = 100;
// read file from a local directory
// The read could raise an exception if the file is not available!
string doc1HTML1 = System.IO.File.ReadAllText("order_form.html");
// Substitute values into the HTML
// Substitute for: {signerName}, {signerEmail}, {ccName}, {ccEmail}
var doc1HTML2 = doc1HTML1.Replace("{signerName}", signerName)
.Replace("{signerEmail}", signerEmail)
.Replace("{ccName}", ccName)
.Replace("{ccEmail}", ccEmail);
// create the envelope definition
EnvelopeDefinition env = new EnvelopeDefinition
{
EmailSubject = "Please complete your order"
};
// add the documents
string doc1b64 = Convert.ToBase64String(Encoding.UTF8.GetBytes(doc1HTML2));
Document doc1 = new Document
{
DocumentBase64 = doc1b64,
Name = "Order form", // can be different from actual file name
FileExtension = "html", // Source data format. Signed docs are always pdf.
DocumentId = "1" // a label used to reference the doc
};
env.Documents = new List <Document> {
doc1
};
// create a signer recipient to sign the document, identified by name and email
// We're setting the parameters via the object creation
Signer signer1 = new Signer
{
Email = signerEmail,
Name = signerName,
RecipientId = "1",
RoutingOrder = "1"
};
// routingOrder (lower means earlier) determines the order of deliveries
// to the recipients. Parallel routing order is supported by using the
// same integer as the order for two or more recipients.
// create a cc recipient to receive a copy of the documents, identified by name and email
// We're setting the parameters via setters
CarbonCopy cc1 = new CarbonCopy
{
Email = ccEmail,
Name = ccName,
RoutingOrder = "2",
RecipientId = "2"
};
// Create signHere fields (also known as tabs) on the documents,
// We're using anchor (autoPlace) positioning
SignHere signHere1 = new SignHere
{
AnchorString = "/sn1/",
AnchorYOffset = "10",
AnchorUnits = "pixels",
AnchorXOffset = "20"
};
ListItem listItem0 = new ListItem {
Text = "none", Value = "0"
}
, listItem1 = new ListItem {
Text = "1", Value = "1"
}
, listItem2 = new ListItem {
Text = "2", Value = "2"
}
, listItem3 = new ListItem {
Text = "3", Value = "3"
}
, listItem4 = new ListItem {
Text = "4", Value = "4"
}
, listItem5 = new ListItem {
Text = "5", Value = "5"
}
, listItem6 = new ListItem {
Text = "6", Value = "6"
}
, listItem7 = new ListItem {
Text = "7", Value = "7"
}
, listItem8 = new ListItem {
Text = "8", Value = "8"
}
, listItem9 = new ListItem {
Text = "9", Value = "9"
}
, listItem10 = new ListItem {
Text = "10", Value = "10"
}
;
List listl1q = new List
{
Font = "helvetica",
FontSize = "size11",
AnchorString = "/l1q/",
AnchorYOffset = "-10",
AnchorUnits = "pixels",
AnchorXOffset = "0",
ListItems = new List <ListItem> {
listItem0, listItem1, listItem2,
listItem3, listItem4, listItem5, listItem6,
listItem7, listItem8, listItem9, listItem10
},
Required = "true",
TabLabel = "l1q"
},
listl2q = new List
{
Font = "helvetica",
FontSize = "size11",
AnchorString = "/l2q/",
AnchorYOffset = "-10",
AnchorUnits = "pixels",
AnchorXOffset = "0",
ListItems = new List <ListItem> {
listItem0, listItem1, listItem2,
listItem3, listItem4, listItem5, listItem6,
listItem7, listItem8, listItem9, listItem10
},
Required = "true",
TabLabel = "l2q"
};
// create two formula tabs for the extended price on the line items
FormulaTab formulal1e = new FormulaTab
{
Font = "helvetica",
FontSize = "size11",
AnchorString = "/l1e/",
AnchorYOffset = "-8",
AnchorUnits = "pixels",
AnchorXOffset = "105",
TabLabel = "l1e",
Formula = $"[l1q] * {l1Price}",
RoundDecimalPlaces = "0",
Required = "true",
Locked = "true",
DisableAutoSize = "false",
},
formulal2e = new FormulaTab
{
Font = "helvetica",
FontSize = "size11",
AnchorString = "/l2e/",
AnchorYOffset = "-8",
AnchorUnits = "pixels",
AnchorXOffset = "105",
TabLabel = "l2e",
Formula = $"[l2q] * {l2Price}",
RoundDecimalPlaces = "0",
Required = "true",
Locked = "true",
DisableAutoSize = "false",
},
// Formula for the total
formulal3t = new FormulaTab
{
Font = "helvetica",
Bold = "true",
FontSize = "size12",
AnchorString = "/l3t/",
AnchorYOffset = "-8",
AnchorUnits = "pixels",
AnchorXOffset = "50",
TabLabel = "l3t",
Formula = $"[l1e] + [l2e]",
RoundDecimalPlaces = "0",
Required = "true",
Locked = "true",
DisableAutoSize = "false",
};
// Payment line items
PaymentLineItem paymentLineIteml1 = new PaymentLineItem
{
Name = l1Name,
Description = l1Description,
AmountReference = "l1e"
},
paymentLineIteml2 = new PaymentLineItem
{
Name = l2Name,
Description = l2Description,
AmountReference = "l2e"
};
PaymentDetails paymentDetails = new PaymentDetails
{
GatewayAccountId = Config.GatewayAccountId,
CurrencyCode = "USD",
GatewayName = Config.GatewayName,
GatewayDisplayName = Config.GatewayDisplayName,
LineItems = new List <PaymentLineItem> {
paymentLineIteml1, paymentLineIteml2
}
};
// Hidden formula for the payment itself
FormulaTab formulaPayment = new FormulaTab
{
TabLabel = "payment",
Formula = $"([l1e] + [l2e]) * {currencyMultiplier}",
RoundDecimalPlaces = "0",
PaymentDetails = paymentDetails,
Hidden = "true",
Required = "true",
Locked = "true",
DocumentId = "1",
PageNumber = "1",
XPosition = "0",
YPosition = "0"
};
// Tabs are set per recipient / signer
Tabs signer1Tabs = new Tabs
{
SignHereTabs = new List <SignHere> {
signHere1
},
ListTabs = new List <List> {
listl1q, listl2q
},
FormulaTabs = new List <FormulaTab> {
formulal1e, formulal2e, formulal3t, formulaPayment
}
};
signer1.Tabs = signer1Tabs;
// Add the recipients to the envelope object
Recipients recipients = new Recipients
{
Signers = new List <Signer> {
signer1
},
CarbonCopies = new List <CarbonCopy> {
cc1
}
};
env.Recipients = recipients;
// Request that the envelope be sent by setting |status| to "sent".
// To request that the envelope be created as a draft, set to "created"
env.Status = RequestItemsService.Status;
return(env);
}
} // end createEmbeddedConsoleViewTest()
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
public EnvelopeSummary requestPaymentOnDocumentTest()
{
// Enter your DocuSign credentials below. Note: You only need a DocuSign account to SEND documents,
// signing is always free and signers do not need an account.
string username = "******";
string password = "******";
// Enter recipient (signer) name and email address
string recipientName = "[RECIPIENT_NAME]";
string recipientEmail = "[RECIPIENT_EMAIL]";
string paymentGatewayId = "[PAYMENT_GATEWAY_ID]";
// the document (file) we want signed
const string SignTest1File = @"[PATH/TO/DOCUMENT/TEST.PDF]";
// instantiate api client with appropriate environment (for production change to www.docusign.net/restapi)
configureApiClient("https://demo.docusign.net/restapi");
//===========================================================
// Step 1: Login()
//===========================================================
// call the Login() API which sets the user's baseUrl and returns their accountId
string accountId = loginApi(username, password);
//===========================================================
// Step 2: Payment Request (AKA create & send Envelope)
//===========================================================
// Read a file from disk to use as a document.
byte[] fileBytes = File.ReadAllBytes(SignTest1File);
EnvelopeDefinition envDef = new EnvelopeDefinition();
envDef.EmailSubject = "[DocuSign C# SDK] - Please Pay on this doc";
// Add a document to the envelope
Document doc = new Document();
doc.DocumentBase64 = System.Convert.ToBase64String(fileBytes);
doc.Name = "TestFile.pdf";
doc.DocumentId = "1";
envDef.Documents = new List <Document>();
envDef.Documents.Add(doc);
// Add a recipient to sign the documeent
Signer signer = new Signer();
signer.Email = recipientEmail;
signer.Name = recipientName;
signer.RecipientId = "1";
// Create a NumberTab to hold payment information
signer.Tabs = new Tabs();
signer.Tabs.NumberTabs = new List <Number>();
Number numberTab = new Number();
numberTab.DocumentId = "1";
numberTab.PageNumber = "1";
numberTab.RecipientId = "1";
numberTab.XPosition = "100";
numberTab.YPosition = "100";
numberTab.TabLabel = "tabvalue1";
numberTab.Value = "10.00";
numberTab.Locked = "true";
signer.Tabs.NumberTabs.Add(numberTab);
// Create a FormulaTab to hold the payment, references NumberTab for amounts of lineItems
signer.Tabs = new Tabs();
signer.Tabs.FormulaTabs = new List <FormulaTab>();
FormulaTab formulaTab = new FormulaTab();
formulaTab.Required = "true";
formulaTab.DocumentId = "1";
formulaTab.PageNumber = "1";
formulaTab.RecipientId = "1";
formulaTab.XPosition = "1"; // placement doesnt really matter, it doesnt show up
formulaTab.YPosition = "1"; // placement doesnt really matter, it doesnt show up
formulaTab.TabLabel = "tabpayment1";
formulaTab.Formula = "[tabvalue1] * 100";
formulaTab.RoundDecimalPlaces = "2";
// Create LineItems
// - this is what will show up on receipts, credit card statements, and in your Payment Gateway
PaymentLineItem lineItem = new PaymentLineItem();
lineItem.Name = 'Name1';
lineItem.Description = 'description1';
lineItem.ItemCode = 'ITEM1';
lineItem.AmountReference = 'tabvalue1';
PaymentDetails paymentDetails = new PaymentDetails();
paymentDetails.CurrencyCode = 'USD';
paymentDetails.GatewayAccountId = paymentGatewayId;
paymentDetails.LineItems = new List <PaymentLineItem>();
paymentDetails.LineItems.Add(lineItem);
formulaTab.PaymentDetails = paymentDetails;
signer.Tabs.FormulaTabs.Add(formulaTab);
envDef.Recipients = new Recipients();
envDef.Recipients.Signers = new List <Signer>();
envDef.Recipients.Signers.Add(signer);
// set envelope status to "sent" to immediately send the signature request
envDef.Status = "sent";
// |EnvelopesApi| contains methods related to creating and sending Envelopes (aka signature requests)
EnvelopesApi envelopesApi = new EnvelopesApi();
EnvelopeSummary envelopeSummary = envelopesApi.CreateEnvelope(accountId, envDef);
// print the JSON response
Console.WriteLine("EnvelopeSummary:\n{0}", JsonConvert.SerializeObject(envelopeSummary));
return(envelopeSummary);
} // end requestPaymentOnDocumentTest()
public ActionResult GetPayments()
{
try
{
var oSB = new StringBuilder();
var oPayments = new List<Payment>();
foreach (var oIAPayment in m_oDataAccess.IAPayments.Where(row => row.IAPaymentLineItems.Count(child => child.QBInvoiceID > 0 && !child.IsSynched) > 0))
{
var oPayment = new Payment();
oPayment.CreditCardFirstName = m_oMemberProtect.Cryptography.Decrypt(oIAPayment.CreditCardFirstName);
oPayment.CreditCardLastName = m_oMemberProtect.Cryptography.Decrypt(oIAPayment.CreditCardLastName);
oPayment.CreditCardType = m_oMemberProtect.Cryptography.Decrypt(oIAPayment.CreditCardType);
oPayment.AuthorizeNetID = oIAPayment.AuthorizeNetTransactionID;
oPayment.CreatedDateTime = oIAPayment.CreatedDateTime;
foreach (var oIAPaymentLineItem in oIAPayment.IAPaymentLineItems.Where(row => row.QBInvoiceID > 0 && !row.IsSynched))
{
var oPaymentLineItem = new PaymentLineItem();
oPaymentLineItem.InvoiceID = oIAPaymentLineItem.Invoice;
oPaymentLineItem.QBInvoiceID = oIAPaymentLineItem.QBInvoiceID.ToString();
oPaymentLineItem.Amount = oIAPaymentLineItem.Amount;
oPayment.LineItems.Add(oPaymentLineItem);
oIAPaymentLineItem.IsSynched = true;
}
oPayments.Add(oPayment);
}
// Update all payment line items as synched
m_oDataAccess.SubmitChanges();
var json = JsonConvert.SerializeObject(oPayments, Formatting.Indented);
m_oResult.Code = 1;
m_oResult.Data = json;
return new ObjectResult<Result>(m_oResult);
}
catch (Exception e)
{
m_oResult.Code = 0;
m_oResult.Message = e.Message + Environment.NewLine + Environment.NewLine + e.StackTrace;
return new ObjectResult<Result>(m_oResult);
}
}
public IActionResult Create(string signerEmail, string signerName, string ccEmail, string ccName)
{
// Data for this method
// signerEmail
// signerName
// ccEmail
// ccName
var accessToken = RequestItemsService.User.AccessToken;
var basePath = RequestItemsService.Session.BasePath + "/restapi";
var accountId = RequestItemsService.Session.AccountId;
bool tokenOk = CheckToken(3);
if (!tokenOk)
{
// We could store the parameters of the requested operation
// so it could be restarted automatically.
// But since it should be rare to have a token issue here,
// we'll make the user re-enter the form data after
// authentication.
RequestItemsService.EgName = EgName;
return(Redirect("/ds/mustAuthenticate"));
}
// Order form constants
string l1Name = "Harmonica";
int l1Price = 5;
string l1Description = $"${l1Price} each"
, l2Name = "Xylophone";
int l2Price = 150;
string l2Description = $"${l2Price} each";
// Payment line items
PaymentLineItem paymentLineIteml1 = new PaymentLineItem
{
Name = l1Name,
Description = l1Description,
AmountReference = "l1e"
},
paymentLineIteml2 = new PaymentLineItem
{
Name = l2Name,
Description = l2Description,
AmountReference = "l2e"
};
PaymentDetails paymentDetails = new PaymentDetails
{
GatewayAccountId = Config.GatewayAccountId,
CurrencyCode = "USD",
GatewayName = Config.GatewayName,
GatewayDisplayName = Config.GatewayDisplayName,
LineItems = new List <PaymentLineItem> {
paymentLineIteml1, paymentLineIteml2
}
};
string envelopeId = Examples.CollectPaymentInEnvelope.CreateEnvelopeWithPayment(signerEmail, signerName, ccEmail,
ccName, accessToken, basePath, accountId, RequestItemsService.Status, paymentDetails);
Console.WriteLine("Envelope was created.EnvelopeId " + envelopeId);
ViewBag.h1 = "Envelope sent";
ViewBag.message = "The envelope has been created and sent!<br/>Envelope ID " + envelopeId + ".";
return(View("example_done"));
}
