Connexion PayPal pour LinkyFlow

LinkyFlow connecte Excel a PayPal pour consulter, modifier et publier les donnees e-commerce utiles depuis un tableur.

Ressources

Requetes de lecture

Actions ecriture

Champs documentes

Workflows a ramener dans Excel

Chaque ressource ci-dessous correspond a un workflow tableur concret. Les lectures ramenent des colonnes utiles dans Excel; les creations et modifications indiquent ce qui peut etre relu en lignes avant envoi.

Catalog

Activate Plan

Activates a plan so subscriptions can be created on it.

Creation

Activate Plan

Route: POST /mutation/planActivate

Entrees configurables

Name	Type	Required	Description
`planId`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Deactivate Plan

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

Creation

Deactivate Plan

Route: POST /mutation/planDeactivate

Entrees configurables

Name	Type	Required	Description
`planId`	id	Yes	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Plans

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

Lecture

Plans

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

Route: GET /plans

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record. Answers one row, or none when the id is unknown.
`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

Donnees retournees dans Excel

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

Creation

Create Plan

Route: POST /mutation/plans

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Plan

Route: PATCH /mutation/plans

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Products

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

Utilise comme filtre par

Plans · product_id

Lecture

Products

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

Route: GET /products

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

Entrees configurables

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

Donnees retournees dans Excel

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

Creation

Create Product

Route: POST /mutation/products

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Update Product

Route: PATCH /mutation/products

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Invoicing

Cancel Invoice

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

Creation

Cancel Invoice

Route: POST /mutation/invoiceCancel

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Invoices

Invoices you send to customers, from draft to paid.

Lecture

Invoices

Invoices you send to customers, from draft to paid.

Route: GET /invoices

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

Entrees configurables

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

Donnees retournees dans Excel

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

Creation

Create Invoice Draft

Route: POST /mutation/invoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Modification

Delete Draft Invoice

Route: DELETE /mutation/invoices

Entrees configurables

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	-

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Send Invoice

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

Creation

Send Invoice

Route: POST /mutation/invoiceSend

Entrees configurables

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

Donnees retournees dans Excel

Cette action retourne une confirmation plutot qu une table selectionnable.

Reports

Balances

Total, available and withheld balance, per currency.

Lecture

Balances

Total, available and withheld balance, per currency.

Route: GET /balances

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

Entrees configurables

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

Donnees retournees dans Excel

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

Disputes

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

Lecture

Disputes

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

Route: GET /disputes

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

Entrees configurables

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this dispute (its dispute id). Answers one row, or none when the id is unknown.
`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

Donnees retournees dans Excel

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

Transactions

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

Lecture

Transactions

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

Route: GET /transactions

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

Entrees configurables

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

Donnees retournees dans Excel

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