Skip to content
Nappai Documentation

PayPal Invoice

PayPal Invoice manages the invoices in your PayPal account. It can create an invoice for a customer, email it to them so they pay with PayPal, cancel it, record that it was paid another way, and look up one invoice or the list of invoices.

When to use it

  • You finish a job for a customer and want to send them the PayPal invoice from the same flow.
  • A customer pays you by bank transfer or in cash and you want to mark the PayPal invoice as paid.
  • An order is cancelled and you want to cancel its invoice and let the customer know.
  • You want a weekly summary of unpaid invoices.

Configuration

You need a PayPal API credential with the Client ID and Client Secret of your PayPal app, and the environment: Sandbox for testing or Live for real payments. See Credentials.

FieldWhat it does
Credential (required)The PayPal API credential of your account.
Operation (required)The action the component performs. Defaults to Create. See Operations.
Get ModeOnly in Get. By ID looks up one invoice; All returns the list of invoices. Defaults to By ID.
Invoice IDThe invoice’s identifier in PayPal. Required in Cancel, Mark As Paid, Send and Get with By ID.
Recipient EmailOnly in Create, and required there. The email of the customer who receives the invoice.
CurrencyOnly in Create. The invoice’s currency, such as EUR or USD. Defaults to USD.
Item NameOnly in Create, and required there. The product or service being invoiced.
QuantityOnly in Create. How many units are invoiced. Left empty, 1.
Unit AmountOnly in Create, and required there. The price of each unit with decimals, for example 25.00.
Due DateOnly in Create. Payment due date, in the format YYYY-MM-DD, for example 2026-11-30.
NoteIn Create, a note for the customer shown on the invoice. In Cancel, the message that goes with the cancellation.
Terms and ConditionsOnly in Create. The terms shown on the invoice.
Payment MethodOnly in Mark As Paid. How the payment was received: BANK_TRANSFER, CASH, CHECK, CREDIT_CARD, DEBIT_CARD, PAYPAL, WIRE_TRANSFER or OTHER. Defaults to PAYPAL.
Payment DateOnly in Mark As Paid, and required there. The date the payment was received, in the format YYYY-MM-DD.
LimitOnly in Get with All. Maximum number of invoices returned, between 1 and 100. Defaults to 20.

Each invoice this component creates has a single line: the one given by Item Name, Quantity and Unit Amount.

Operations

  • Cancel: cancels an invoice that has already been sent, with the Note message if you write one.
  • Create: creates the invoice as a draft. The customer does not receive it until you send it with Send.
  • Get: with By ID returns one invoice; with All returns the list of invoices.
  • Mark As Paid: records a payment received outside PayPal, with its payment method and date.
  • Send: emails the invoice to the customer so they can pay it.

Output

The Data output returns the invoice you worked with, with its details as they are after the operation. With Get and All, it returns one item per invoice. Each item includes the invoice’s identifier and number, status, currency, total and due amount, the customer’s email, the issue and due dates, the note and the link where the customer views and pays the invoice (payer_view_url).

You can connect it to an email, to your billing sheet or to a condition that checks the status. The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.

Example

A graphic designer invoices each job when she delivers it.

  1. When the job is marked as delivered in her task manager, the flow receives the customer’s email and the price.
  2. Add PayPal Invoice with Operation set to Create. Put the email in Recipient Email, “Logo design” in Item Name, 350.00 in Unit Amount, Currency set to EUR and a Due Date 15 days ahead.
  3. Add another PayPal Invoice with Operation set to Send and pass the new invoice’s identifier to Invoice ID.
  4. The customer receives the invoice by email and can pay it with PayPal.

Good practices

  • Test your flows with a Sandbox credential before you use a Live one.
  • Remember that Create leaves the invoice as a draft: always add a Send step if you want it to reach the customer.