PayPal connection for LinkyFlow

LinkyFlow brings PayPal ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Catalog

Activate Plan

Activates a plan so subscriptions can be created on it.

Create

Activate Plan

Route: POST /mutation/planActivate

Inputs you can set

Name	Type	Required	Description
`planId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Deactivate Plan

Deactivates a plan. Existing subscriptions keep running; no new one can be created on it.

Create

Deactivate Plan

Route: POST /mutation/planDeactivate

Inputs you can set

Name	Type	Required	Description
`planId`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Plans

Subscription plans: one regular billing cycle, its price and the payment preferences.

Read

Plans

Subscription plans: one regular billing cycle, its price and the payment preferences.

Route: GET /plans

Excel formula: =LF.paypal.plans("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`product_id`	id	No	Plans of this product
`plan_ids`	string	No	Exactly these plans, comma-separated (up to 10)
`per_page`	number	No	Rows per page (max 20) Default: 20
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`can_activate`	boolean	—	-
`can_deactivate`	boolean	—	-
`create_time` default	date	—	-
`description`	string	—	-
`id` default	id	—	-
`name` default	string	—	-
`product_id` default	id	→ products	-
`status` default	enum	—	-
`update_time`	date	—	-
`usage_type`	enum	—	-

Create

Create Plan

Route: POST /mutation/plans

Inputs you can set

Name	Type	Required	Description
`auto_bill_outstanding`	boolean	No	-
`description`	string	No	-
`interval_count`	number	No	-
`interval_unit`	enum	Yes	Values: DAY, WEEK, MONTH, YEAR
`name`	string	Yes	-
`payment_failure_threshold`	number	No	-
`price_currency`	string	Yes	-
`price_value`	number	Yes	-
`product_id`	id	Yes	-
`setup_fee_value`	number	No	-
`status`	enum	No	Values: ACTIVE, INACTIVE
`total_cycles`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Plan

Route: PATCH /mutation/plans

Inputs you can set

Name	Type	Required	Description
`auto_bill_outstanding`	boolean	No	-
`description`	string	No	-
`interval_count`	number	No	-
`interval_unit`	enum	Yes	Values: DAY, WEEK, MONTH, YEAR
`name`	string	Yes	-
`payment_failure_threshold`	number	No	-
`price_currency`	string	Yes	-
`price_value`	number	Yes	-
`product_id`	id	Yes	-
`setup_fee_value`	number	No	-
`status`	enum	No	Values: ACTIVE, INACTIVE
`total_cycles`	number	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Products

Catalog products that subscription plans are built on. Products cannot be deleted.

Used as filter by

Plans · product_id

Read

Products

Catalog products that subscription plans are built on. Products cannot be deleted.

Route: GET /products

Excel formula: =LF.paypal.products("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`per_page`	number	No	Rows per page (max 20) Default: 20
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`category`	string	—	-
`create_time` default	date	—	-
`description` default	string	—	-
`home_url`	string	—	-
`id` default	id	—	-
`image_url`	string	—	-
`name` default	string	—	-
`type`	enum	—	-
`update_time`	date	—	-

Create

Create Product

Route: POST /mutation/products

Inputs you can set

Name	Type	Required	Description
`category`	string	No	-
`description`	string	No	-
`home_url`	string	No	-
`image_url`	string	No	-
`name`	string	Yes	-
`type`	enum	Yes	Values: PHYSICAL, DIGITAL, SERVICE

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Product

Route: PATCH /mutation/products

Inputs you can set

Name	Type	Required	Description
`category`	string	No	-
`description`	string	No	-
`home_url`	string	No	-
`image_url`	string	No	-
`name`	string	Yes	-
`type`	enum	Yes	Values: PHYSICAL, DIGITAL, SERVICE

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoicing

Cancel Invoice

Cancels a sent, unpaid invoice. The recipient can no longer pay it; the number stays used.

Create

Cancel Invoice

Route: POST /mutation/invoiceCancel

Inputs you can set

Name	Type	Required	Description
`invoiceId`	id	Yes	-
`send_to_invoicer`	boolean	No	-
`send_to_recipient`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Invoices

Invoices you send to customers, from draft to paid.

Read

Invoices

Invoices you send to customers, from draft to paid.

Route: GET /invoices

Excel formula: =LF.paypal.invoices("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or a not-found error.
`per_page`	number	No	Rows per page (max 100) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`currency` default	string	—	-
`due` default	number	—	-
`id` default	id	—	-
`invoice_date` default	string	—	-
`invoice_number` default	string	—	-
`recipient_email` default	string	—	-
`recipient_name` default	string	—	-
`status` default	enum	—	-
`total` default	number	—	-

Create

Create Invoice Draft

Route: POST /mutation/invoices

Inputs you can set

Name	Type	Required	Description
`detail.currency_code`	string	Yes	-
`detail.invoice_date`	string	No	-
`detail.invoice_number`	string	No	-
`detail.memo`	string	No	-
`detail.note`	string	No	-
`detail.payment_term.due_date`	string	No	-
`detail.payment_term.term_type`	enum	No	Values: DUE_ON_RECEIPT, DUE_ON_DATE_SPECIFIED, NET_10, NET_15, NET_30
`detail.reference`	string	No	-
`item_description`	string	No	-
`item_name`	string	Yes	-
`item_quantity`	number	No	-
`item_tax_name`	string	No	-
`item_tax_percent`	number	No	-
`item_unit_amount`	number	Yes	-
`recipient_business_name`	string	No	-
`recipient_email`	string	Yes	-
`recipient_given_name`	string	No	-
`recipient_surname`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Delete Draft Invoice

Route: DELETE /mutation/invoices

Inputs you can set

Name	Type	Required	Description
`detail.currency_code`	string	Yes	-
`detail.invoice_date`	string	No	-
`detail.invoice_number`	string	No	-
`detail.memo`	string	No	-
`detail.note`	string	No	-
`detail.payment_term.due_date`	string	No	-
`detail.payment_term.term_type`	enum	No	Values: DUE_ON_RECEIPT, DUE_ON_DATE_SPECIFIED, NET_10, NET_15, NET_30
`detail.reference`	string	No	-
`item_description`	string	No	-
`item_name`	string	Yes	-
`item_quantity`	number	No	-
`item_tax_name`	string	No	-
`item_tax_percent`	number	No	-
`item_unit_amount`	number	Yes	-
`recipient_business_name`	string	No	-
`recipient_email`	string	Yes	-
`recipient_given_name`	string	No	-
`recipient_surname`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Send Invoice

Emails a draft invoice to its recipient, who can then pay it. PayPal sends the mail, not LinkyFlow.

Create

Send Invoice

Route: POST /mutation/invoiceSend

Inputs you can set

Name	Type	Required	Description
`invoiceId`	id	Yes	-
`send_to_invoicer`	boolean	No	-
`send_to_recipient`	boolean	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reports

Balances

Total, available and withheld balance, per currency.

Read

Balances

Total, available and withheld balance, per currency.

Route: GET /balances

Excel formula: =LF.paypal.balances("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`as_of_time`	string	No	The balance at this moment (ISO date-time). Defaults to now.
`currency_code`	string	No	One currency only; empty answers every currency held

Data returned in Excel

Field	Type	Relations	Description
`available_balance` default	number	—	-
`currency` default	string	—	-
`primary` default	boolean	—	-
`total_balance` default	number	—	-
`withheld_balance` default	number	—	-

Disputes

Buyer disputes and chargebacks, with their stage, state and amount.

Read

Disputes

Buyer disputes and chargebacks, with their stage, state and amount.

Route: GET /disputes

Excel formula: =LF.paypal.disputes("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this dispute (its dispute id). Answers one row, or a not-found error.
`createdAfter`	string	No	Only disputes created at or after this moment (ISO date or epoch seconds)
`dispute_state`	enum	No	Values: REQUIRED_ACTION, REQUIRED_OTHER_PARTY_ACTION, UNDER_PAYPAL_REVIEW, RESOLVED, OPEN_INQUIRIES
`disputed_transaction_id`	string	No	Disputes about this transaction
`per_page`	number	No	Rows per page (max 50) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`create_time` default	date	—	-
`currency` default	string	—	-
`dispute_id` default	id	—	-
`dispute_state` default	enum	—	-
`reason` default	enum	—	-
`seller_response_due_date` default	date	—	-
`seller_transaction_id` default	id	→ transactions	-
`status` default	enum	—	-

Transactions

Every movement on the account: sales, refunds, fees, payouts and adjustments, with the payer.

Read

Transactions

Every movement on the account: sales, refunds, fees, payouts and adjustments, with the payer.

Route: GET /transactions

Excel formula: =LF.paypal.transactions("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`createdAfter`	string	No	Start of the window (ISO date or epoch seconds). Defaults to 31 days before the end. PayPal serves at most 31 days per query.
`createdBefore`	string	No	End of the window (ISO date or epoch seconds). Defaults to now.
`transaction_id`	string	No	Exactly this transaction
`transaction_status`	enum	No	D denied, P pending, S success, V reversed Values: D, P, S, V
`transaction_type`	string	No	PayPal transaction event code, e.g. T0006 (payment), T1107 (refund)
`transaction_currency`	string	No	Three-letter ISO code
`payment_instrument_type`	enum	No	Values: CREDITCARD, DEBITCARD
`balance_affecting_records_only`	enum	No	Y (the default at PayPal) leaves out records that did not move the balance Values: Y, N
`per_page`	number	No	Rows per page (max 500) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`amount` default	number	—	-
`currency` default	string	—	-
`date` default	date	—	-
`event_code` default	string	—	-
`fee` default	number	—	-
`payer_email` default	string	—	-
`payer_name` default	string	—	-
`status` default	enum	—	-
`transaction_id` default	id	—	-