Get PayPal Invoice

Checks the status and amount due on one PayPal invoice by its ID.

Unverified

Add this first. This tool needs an access token, so add Get PayPal Access Token to the same bot. The bot calls it first and passes the token in.

What the model is told

Get a PayPal invoice by its invoice ID (it looks like INV2-XXXX-XXXX-XXXX-XXXX). Get a PayPal access token first if you do not already have one. Use it when the customer asks if an invoice has been paid. Report the status (such as DRAFT, SENT, PAID or CANCELLED) and the amount due. Never read out recipient contact details.

Request

GEThttps://api-m.paypal.com/v2/invoicing/invoices/{{invoiceId}}

Headers

Content-Typeapplication/json
AuthorizationBearer {{accessToken}}

Parameters

invoiceId stringThe PayPal invoice ID.
accessToken stringThe access_token value returned by Get PayPal Access Token. Reuse it for the rest of the conversation.

Engage payload

{
  "source": "VOICE_AI",
  "tool": {
    "id": "775b1c9f-a617-4adf-b6aa-64b8daf1d247",
    "type": "HTTP_REQUEST",
    "label": "Get PayPal Invoice",
    "name": "get_paypal_invoice",
    "customName": false,
    "description": "Get a PayPal invoice by its invoice ID (it looks like INV2-XXXX-XXXX-XXXX-XXXX). Get a PayPal access token first if you do not already have one. Use it when the customer asks if an invoice has been paid. Report the status (such as DRAFT, SENT, PAID or CANCELLED) and the amount due. Never read out recipient contact details.",
    "parameters": [
      {
        "name": "invoiceId",
        "type": "string",
        "description": "The PayPal invoice ID."
      },
      {
        "name": "accessToken",
        "type": "string",
        "description": "The access_token value returned by Get PayPal Access Token. Reuse it for the rest of the conversation."
      }
    ],
    "config": {
      "endpoint": {
        "method": "GET",
        "url": "https://api-m.paypal.com/v2/invoicing/invoices/{{invoiceId}}"
      },
      "headers": [
        {
          "name": "Content-Type",
          "value": "application/json"
        },
        {
          "name": "Authorization",
          "value": "Bearer {{accessToken}}"
        }
      ],
      "body": null,
      "timeout": null
    }
  }
}

IDs are regenerated on every copy.