Can't fill documents using Advanced example
wstewarttennes opened this issue · 8 comments
I have the advanced example copied and pasted exactly (using my own document IDs of course). I am able to send the document for signature but the fields are not filled out when I use the add_file_payloads method with the FillPDFPayload. See code below
def __init__(self) -> None:
self.ANVIL = Anvil(api_key=self.ANVIL_API_KEY, environment=self.ANVIL_API_ENVIRONMENT)
def create_proforma_invoice(self, order, buyer, body):
packet = CreateEtchPacket(
name="Proforma Invoice " + str(body['invoice_no']),
signature_email_subject="PLEASE SIGN FORMS ()",
)
signer1 = EtchSigner(
name=body['firstName'] + " " + body['lastName'],
email=body['email'],
fields=[SignerField(
file_id="fileAlias",
field_id="buyer_signature",
)],
signer_type="email",
signature_mode="draw",
accept_each_field=True,
redirect_url=f'<REDACTED>',
)
packet.add_signer(signer1)
file1 = EtchCastRef(
id="fileAlias",
cast_eid="<REDACTED>"
)
packet.add_file(file1)
packet.add_file_payloads("fileAlias", FillPDFPayload(data={
"buyer_information": body['buyer_information'],
"consignee_information": body['consignee_information'],
"invoice_no": body['invoice_no'],
"items": body['items'],
"approx_total": body['approx_total'],
"issue_date": body['issue_date'],
"order_no": body['order_no'],
"terms": body['terms'],
"place_of_delivery": body['place_of_delivery'],
"country_of_origin": body['country_of_origin'],
"estimated_quantity": body['estimated_quantity'],
"contract_no": body['contract'],
"shipped_via": body['shipped_via'],
"estimated_ship_date": body['estimated_ship_date'],
"incoterms": body['incoterms'],
"down_payment_due": body['down_payment_due'],
"buyer_name": {
"firstName": body['firstName'],
"mi": "",
"lastName":body['lastName']
}
}))
payload = packet.create_payload()
res = self.ANVIL.create_etch_packet(payload=payload)Hi @wstewarttennes. Thanks for reporting this issue. Can you confirm that your body variable in your example has data? You could replace some of your payload items with test strings to confirm that your fields prefill -- Also make sure to use an email that you have access to on the signer object. You'll need that to go to the signing page to confirm.
Example:
packet.add_file_payloads("first", FillPDFPayload(
data={
"name": "Prefilled Name",
"email": "enteremailhere@example.com",
"text1": "Prefilled text1"
}
))Also one tiny thing on your last few lines of code:
# Currently
payload = packet.create_payload()
res = self.ANVIL.create_etch_packet(payload=payload)
# Could be replaced with below (basically the same thing). You should use `create_payload()` if you want to override options.
res = self.ANVIL.create_etch_packet(packet)Explicitly calling create_payload() isn't necessary for most cases, so you could just pass in packet to the create_etch_packet function.
Let me know if that helps.
@aalmazan thanks for the quick reply! yes, i have data in the example (i've debugged to the line before for verification). Are you saying name and email are required for FillPDFPayload? That might be it I'll give it a shot!
@wstewarttennes Ah, no those aren't required. The snippet I sent was an example payload for a test packet that I had. Here's a full example below. This is also here: https://github.com/anvilco/python-anvil/blob/master/examples/create_etch_existing_cast.py with full documentation comments.
from python_anvil.api import Anvil
from python_anvil.api_resources.mutations.create_etch_packet import CreateEtchPacket
from python_anvil.api_resources.payload import EtchCastRef, EtchSigner, SignerField, FillPDFPayload
def main():
anvil = Anvil(api_key=API_KEY)
# Create an instance of the builder
packet = CreateEtchPacket(
name="Etch packet with existing template",
signature_email_subject="Please sign these forms",
signature_email_body="This form requires information from your driver's "
"license. Please have that available.",
)
pdf_template = EtchCastRef(
id="first",
cast_eid="my_cast_id",
)
# Gather your signer data
signer1 = EtchSigner(
name="Morgan",
email="morgan3@example.com",
fields=[
SignerField(
file_id="first",
field_id="sign1",
)
],
)
# Add your signer.
packet.add_signer(signer1)
# Add your file(s)
packet.add_file(pdf_template)
packet.add_file_payloads("first", FillPDFPayload(
data={
"name": "Prefilled Name",
"email": "enteremailhere@example.com",
"text1": "Prefilled text1"
}
))
res = anvil.create_etch_packet(packet)
print(res)@aalmazan the link you provided is exactly what I took code from. I've looked over it a few times and don't see any differences with what I'm doing. Will this only work in production? I do see a "DEMO" overlay on my generated PDF, but the fields are still not filled in.
For reference, here is the actual data I'm passing in. Are all fields required? Could that prevent it?
data={
'approx_total':259943.74,
'buyer_information':'Tigerton\n200 Lexington Ave #430\nNew York, NY 10016 \nTEL: 5102194402 \nTAX ID: None \n',
'buyer_name':{'firstName': 'Mike', 'lastName': 'McGoo', 'mi': ''},
'consignee_information':'Tigerton\n200 Lexington Ave #430\nNew York, NY 10016 \nTEL: 5102194402 \nTAX ID: None \n',
'country_of_origin':'United States',
'down_payment_due':259943.74,
'email':'weston@mickeytrading.com',
'estimated_quantity':19592.0,
'estimated_ship_date':'03/19/22',
'incoterms':'',
'invoice_no':'10029469557',
'issue_date':'03/18/22',
'items':'',
'name':'Mike McGoo',
'order_no':'10029469557',
'place_of_delivery':'New York, NY',
'shipped_via':'',
'terms':''
}
@aalmazan OMGGGG I found this issue. Looks like my templated defaulted to white text. I don't think I changed this (possible I did on accident of course) but if white is the default for templates I think that should be updated....
Ah, was about to reply, but yeah I could see how that could happen. When you have styling changes you can click on that arrow on the right to reset your styling settings back, but I'm going to assume you figured that out too. Glad you got it working! Let us know if you have any other issues.
Thanks for your help!!!