Entegrations.io, inc provides 3 broad set of features. 1) PayPal Invoicing, Payouts and IPN features leveraging your PayPal account. 2) Webhooks for Invoicing and Contacts leveraging your Xero account. 3) QBO Inovice leveraging your QuickBooks Online account.
Status: Preview |
Tier: Premium |
Version: 1.0 |
Name |
Summary |
Advanced Use: When invoicing, payouts updates received |
|
Whenever an invoice (at PayPal) is paid |
|
Whenever payouts is paid |
|
Advanced Use: When an IPN (generic) update is received |
|
Whenever Express Checkout payment is completed |
|
Whenever New Case is created |
|
Whenever Recurring Payment is completed |
|
Whenever an Invoice is created or updated at Xero |
|
Whenever a Contact is created or updated at Xero |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedCreateRequest |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Create a PayPal Invoice
Description: Create a draft PayPal Invoice and immediately sends it to a receiver as per their APIs https://developer.paypal.com/docs/api/invoicing/v1/#invoices_create and https://developer.paypal.com/docs/api/invoicing/v1/#invoices_send
Syntax:
Entegrations.io.CreateAndSendPayPalInvoice (EntegrationsInvoice4PayPalCreateRequest Create Invoice payload)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Create Invoice payload |
EntegrationsInvoice4PayPalCreateRequest
|
|
True |
Returns:
Type:EntegrationsInvoice4PayPalCreateResponse
Description: Response details including status.
Summary: Create PayPal Payouts
Description: Create PayPal Payouts to one or more receivers as per their API https://developer.paypal.com/docs/api/payments.payouts-batch/v1/#payouts_create
Syntax:
Entegrations.io.CreatePayouts (EntegrationsPayouts4PayPalCreateRequest Create Payouts payload)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Create Payouts payload |
EntegrationsPayouts4PayPalCreateRequest
|
|
True |
Returns:
Type:EntegrationsPayouts4PayPalCreateResponse
Summary: Advanced Use: Delete the invoicing, payouts etc webhook
Description: Advanced Use: Deletes the Entegrations.io webhook that corresponds to the PayPal webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the invoice paid webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal Invoice paid webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalInvoiceDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the payouts success webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal Payouts success webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalPayoutsDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the generic IPN webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's generic webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnDynamicDeleteTrigger (string txnType, string txnStatus, string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
txnType |
string (txnType of the Webhook being deleted) |
txnType of the Webhook being deleted |
True |
|
txnStatus |
string (txnStatus of the Webhook being deleted) |
txnStatus of the Webhook being deleted |
True |
|
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the IPN's express_checkout completed webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's express_checkout completed webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnEcCompletedDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the IPN's new_case created webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's new_case created webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnNewCaseCreatedDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the IPN's recurring_payment completed webhook
Description: Deletes the Entegrations.io webhook that corresponds to the PayPal IPN's recurring_payment completed webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the Invoices webhook
Description: Deletes the Entegrations.io webhook that corresponds to the Xero Invoices webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4XeroInvoicesDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Delete the Contacts webhook
Description: Deletes the Entegrations.io webhook that corresponds to the Xero Contacts updates webhook.
Syntax:
Entegrations.io.EntegrationsWebhook4XeroContactsDeleteTrigger (string webhookId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webhookId |
string (ID of the Webhook being deleted) |
ID of the Webhook being deleted |
True |
Returns:
Summary: Create a QBO Invoice
Description: Create and sends and a QuickBooks Online Invoice as per their API https://developer.intuit.com/app/developer/qbo/docs/api/accounting/ecommerce/invoice
Syntax:
Entegrations.io.CreateAndSendQuickBooksInvoice (EntegrationsInvoice4IntuitCreateRequest Create QBO Invoice payload)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Create QBO Invoice payload |
EntegrationsInvoice4IntuitCreateRequest
|
|
True |
Returns:
Type:EntegrationsInvoice4IntuitCreateResponse
Description: Response details including status.
Summary: Advanced Use: When invoicing, payouts updates received
Description: Advanced Use: Creates an entegrations.io webhook for PayPal Invoicing, Payouts etc webhooks data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalDefaultCreateTrigger (EntegrationsWebhook4PayPalDefaultCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalDefaultCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever an invoice (at PayPal) is paid
Description: Creates an entegrations.io webhook for PayPal Invoicing Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Invoice Paid from PayPal.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalInvoicingPaidCreateTrigger (EntegrationsWebhook4PayPalInvoicingPaidCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalInvoicingPaidCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever payouts is paid
Description: Creates an entegrations.io webhook for PayPal Payouts Paid data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Payouts Paid from PayPal.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalPayoutsPaidCreateTrigger (EntegrationsWebhook4PayPalPayoutsPaidCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalPayoutsPaidCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Advanced Use: When an IPN (generic) update is received
Description: Advanced Use: Creates an entegrations.io webhook for PayPal IPN event data and it triggers whenever entegrations.io receives an on-behalf-of IPN payload from PayPal. Note that this is default payload, getting you whatever PayPal sends out.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnDynamicCreateTrigger (string txnType, string txnStatus, EntegrationsWebhook4PayPalDefaultCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
txnType |
string (txn_type of the IPN being created.) |
txn_type of the IPN being created. Leave all for all txn_types. |
True |
|
txnStatus |
string (txn or payment status of the Webhook being created.) |
txn or payment status of the Webhook being created. Leave all for all statuses. |
True |
|
Request body of the webhook |
EntegrationsWebhook4PayPalDefaultCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever Express Checkout payment is completed
Description: Creates an entegrations.io webhook for PayPal express_checkout completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnEcCompletedCreateTrigger (EntegrationsWebhook4PayPalIpnEcCompletedCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalIpnEcCompletedCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever New Case is created
Description: Creates an entegrations.io webhook for PayPal new case created IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnNewCaseCreatedCreateTrigger (EntegrationsWebhook4PayPalIpnNewCaseCreatedCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalIpnNewCaseCreatedCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever Recurring Payment is completed
Description: Creates an entegrations.io webhook for PayPal recurring payment completed IPN event and it triggers whenever entegrations.io receives an on-behalf-of ipn payload from PayPal.
Syntax:
Entegrations.io.EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedCreateTrigger (EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4PayPalIpnRecurringPaymentCompletedCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4PayPalBaseCreateResponse
Summary: Whenever an Invoice is created or updated at Xero
Description: Creates an entegrations.io webhook for Xero Invoices updates data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Invoices from Xero.
Syntax:
Entegrations.io.EntegrationsWebhook4XeroInvoicesCreateTrigger (EntegrationsWebhook4XeroInvoicesCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4XeroInvoicesCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4XeroBaseCreateResponse
Summary: Whenever a Contact is created or updated at Xero
Description: Creates an entegrations.io webhook for Xero Contacts data and it triggers whenever entegrations.io receives an on-behalf-of webhook payload for Contacts from Xero.
Syntax:
Entegrations.io.EntegrationsWebhook4XeroContactsCreateTrigger (EntegrationsWebhook4XeroContactsCreateRequest Request body of the webhook)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
Request body of the webhook |
EntegrationsWebhook4XeroContactsCreateRequest
|
|
True |
Returns:
Type:EntegrationsWebhook4XeroBaseCreateResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
SenderEmail |
string
|
Sender's email which corresponds to Intuit QuickBooks Online account. |
RealmId |
string
|
Sender's Realm ID or Company ID which corresponds to Intuit QuickBooks Online account. |
TxnDate |
string
|
Transaction Date in YYYY-MM-DD format |
DueDate |
string
|
Due Date in YYYY-MM-DD format |
DocNumber |
string
|
DocNumber |
Line |
array of (IntuitQBOInvoiceLineItem)
|
Line Item |
CustomerRef |
|
|
Summary:
Description: Response details including status.
Properties:
Name |
Type |
Summary |
status |
string
|
Status of creating the Invoice. Possible values: success or error. |
details |
|
Response details. |
errorMessage |
string
|
Error message, if there is any error. |
Summary:
Description: Response details.
Properties:
Name |
Type |
Summary |
intuit_invoice_id |
string
|
Invoice ID generated by QuickBooks. |
intuit_invoice_number |
string
|
Invoice Number generated by QuickBooks. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
merchant_info |
|
Invoice sender's information. |
billing_info |
array of (Billing_infoItem)
|
Billing information. |
shipping_info |
|
Shiping information |
items |
array of (ItemsItem)
|
Invoice line items |
discount |
|
Discount details |
shipping_cost |
|
Shipping cost |
note |
string
|
Invoice note |
terms |
string
|
Invoice terms |
Summary:
Description: Invoice sender's information.
Properties:
Name |
Type |
Summary |
|
string
|
Sender's email which corresponds to PayPal account. |
first_name |
string
|
Sender's first name. |
last_name |
string
|
Sender's last name. |
business_name |
string
|
Sender's business name. |
phone |
|
Sender's phone details. |
address |
|
Address of the sender. |
Summary:
Description: Sender's phone details.
Properties:
Name |
Type |
Summary |
country_code |
string
|
Country code of the phone. |
national_number |
string
|
Phone nuber with area code. |
Summary:
Description: Address of the sender.
Properties:
Name |
Type |
Summary |
line1 |
string
|
Line 1 of address. |
city |
string
|
City |
state |
string
|
State |
postal_code |
string
|
Postal Code |
country_code |
string
|
Two character ISO country code. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string
|
Bill to email. This may be an email of reciever's PayPal account. |
first_name |
string
|
First name |
last_name |
string
|
Last name |
Summary:
Description: Shiping information
Properties:
Name |
Type |
Summary |
first_name |
string
|
First name |
last_name |
string
|
Last name |
address |
|
Shipping address |
Summary:
Description: Shipping address
Properties:
Name |
Type |
Summary |
line1 |
string
|
Line 1 of address. |
city |
string
|
City |
state |
string
|
State |
postal_code |
string
|
Postal code |
country_code |
string
|
Country code |
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string
|
Item name |
quantity |
string
|
Quantity. For e.g. 1.5 |
unit_price |
|
Unit price details. |
tax |
|
Tax information |
Summary:
Description: Unit price details.
Properties:
Name |
Type |
Summary |
currency |
string
|
Currency |
value |
string
|
Value |
Summary:
Description: Tax information
Properties:
Name |
Type |
Summary |
name |
string
|
Tax type/name |
percent |
string
|
Percent. For e.g. 8.5 |
Summary:
Description: Discount details
Properties:
Name |
Type |
Summary |
percent |
string
|
Percent |
Summary:
Description: Shipping cost
Properties:
Name |
Type |
Summary |
amount |
|
Shipping Amount |
Summary:
Description: Shipping Amount
Properties:
Name |
Type |
Summary |
currency |
string
|
Currency |
value |
string
|
Value |
Summary:
Description: Response details including status.
Properties:
Name |
Type |
Summary |
status |
string
|
Status of creating the Invoice. Possible values: success or error. |
details |
|
Response details. |
errorMessage |
string
|
Error message, if there is any error. |
Summary:
Description: Response details.
Properties:
Name |
Type |
Summary |
paypal_invoice_id |
string
|
Invoice ID generated by PayPal. |
paypal_invoice_number |
string
|
Invoice Number generated by PayPal. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
merchant_info |
|
Sender's email information. PayPal api won't require this but as an extra security check entegrations.io would require it. |
sender_batch_header |
|
Sender's batch header information. |
items |
array of (ItemsItem)
|
Payout items |
Summary:
Description: Sender's email information. PayPal api won't require this but as an extra security check entegrations.io would require it.
Properties:
Name |
Type |
Summary |
|
string
|
Sender's email which corresponds to PayPal account. |
Summary:
Description: Sender's batch header information.
Properties:
Name |
Type |
Summary |
sender_batch_id |
string
|
Sender's Batch ID (Should be unique value, in last 30 days, per PayPal). |
email_subject |
string
|
Subject of the email notification that would be sent out by PayPal. |
recipient_type |
string
|
Recipient type. Valid values are either of EMAIL / PAYER_ID / PHONE. Either this value or the ones in Payout item/details is mandatory. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
recipient_type |
string
|
Recipient type. Valid values are either of EMAIL / PAYER_ID / PHONE. Either this value or the one in Payout batch header is mandatory. |
receiver |
string
|
Receiver's email / PayPal payer_id / phone number. |
note |
string
|
Payout item level note. |
sender_item_id |
string
|
Sender's Payout Item ID (Should be unique value, in last 30 days, per PayPal). |
amount |
|
Payout amount |
Summary:
Description: Payout amount
Properties:
Name |
Type |
Summary |
currency |
string
|
Currency |
value |
string
|
Value |
Summary:
Description:
Properties:
Name |
Type |
Summary |
status |
string
|
Status of creating the Payouts. Possible values: success or error. |
details |
|
Response details. |
errorMessage |
string
|
Error message, if there is any error. |
Summary:
Description: Response details.
Properties:
Name |
Type |
Summary |
paypal_payout_batch_id |
string
|
Batch ID generated by the PayPal for this Payout. |
sender_batch_id |
string
|
Batch ID that was sent in the request (echoing back the same value) |
Summary:
Description:
Properties:
Name |
Type |
Summary |
status |
string
|
|
details |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
webhook_id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paypalEmailAddress |
string
|
Email address of the PayPal account. You must use the same PayPal email address you have used to on-board for the connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
status |
string
|
|
details |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
webhook_id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
xeroEmailAddress |
string
|
Email address of the Xero account. You must use the same Xero email address you have used to onboard for the custom connector. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
xeroEmailAddress |
string
|
Email address of the Xero account. You must use the same Xero email address you have used to onboard for the custom connector. |
shouldGetInvoiceAsPdf |
boolean
|
Indicate if invoice has also to be gotten as PDF from Xero in addition to invoice resource. |
config |
|
Configuration of the Trigger |
Summary:
Description: Configuration of the Trigger
Properties:
Name |
Type |
Summary |
content_type |
string
|
Type of the response |
url |
string
|
Callback URL |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
string
|
Customer Ref |
Summary:
Description:
Properties:
Name |
Type |
Summary |
value |
string
|
Value |
name |
string
|
Name |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Amount |
number(double)
|
Amount |
DetailType |
string
|
Detail Type |
SalesItemLineDetail |
IntuitQBOInvoiceSalesItemLineDetail
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
ItemRef |
|
|