# Invoices API

> Invoices API on Apizie: 22 endpoints (List invoices, Create draft invoice, Send invoice, Send invoice reminder, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/payments:paypal-invoicing/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `payments:paypal-invoicing`
- Category: Payments
- Status: byok
- Source: https://paypal
- Page: https://apizie.tech/api/payments/paypal-invoicing
- OpenAPI: https://apizie.tech/api/payments/paypal-invoicing/openapi.json

Use the Invoicing API to create, send, and manage invoices. You can also use the API or webhooks to track invoice payments. When you send an invoice to a customer, the invoice moves from draft to payable state. PayPal…

## Endpoints

### List invoices
`GET https://apizie.tech/v1/payments:paypal-invoicing/invoices-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The page number to be retrieved, for the list of templates. So, a combination of `page=1` and `page_size=20` returns the first 20… |
| page_size | integer | no | The maximum number of templates to return in the response. |
| total_required | boolean | no | Indicates whether the to show total_pages and total_items in the response. |
| fields | string | no | The fields to return in the response. Value is `all` or `none`. To return only the template name, ID, and default attributes, specify… |

### Create draft invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-send` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | no | JSON request body |

### Send invoice reminder
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-remind` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | no | JSON request body |

### Cancel sent invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | yes | JSON request body |

### Record payment for invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-payments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | yes | JSON request body |

### Delete external payment
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-payments-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| transaction_id | string | yes | The ID of the external refund transaction to delete. |

### Record refund for invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-refunds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | yes | JSON request body |

### Delete external refund
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-refunds-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| transaction_id | string | yes | The ID of the external refund transaction to delete. |

### Generate QR code
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-generate-qr-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| body | object | no | JSON request body |

### Generate invoice number
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoicing-generate-next-invoice-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Show invoice details
`GET https://apizie.tech/v1/payments:paypal-invoicing/invoices-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |

### Fully update invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |
| send_to_recipient | boolean | no | Indicates whether to send the invoice update notification to the recipient. |
| send_to_invoicer | boolean | no | Indicates whether to send the invoice update notification to the merchant. |
| body | object | yes | JSON request body |

### Delete invoice
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | yes | The ID of the draft invoice to delete. |

### Search for invoices
`POST https://apizie.tech/v1/payments:paypal-invoicing/invoices-search-invoices` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | The page number to be retrieved, for the list of templates. So, a combination of `page=1` and `page_size=20` returns the first 20… |
| page_size | integer | no | The maximum number of templates to return in the response. |
| total_required | boolean | no | Indicates whether the to show total_pages and total_items in the response. |
| body | object | no | JSON request body |

### List templates
`GET https://apizie.tech/v1/payments:paypal-invoicing/templates-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | The fields to return in the response. Value is `all` or `none`. To return only the template name, ID, and default attributes, specify… |
| page | integer | no | The page number to be retrieved, for the list of templates. So, a combination of `page=1` and `page_size=20` returns the first 20… |
| page_size | integer | no | The maximum number of templates to return in the response. |

### Create template
`POST https://apizie.tech/v1/payments:paypal-invoicing/templates-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Show template details
`GET https://apizie.tech/v1/payments:paypal-invoicing/templates-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_id | string | yes | The ID of the template to delete. |

### Fully update template
`POST https://apizie.tech/v1/payments:paypal-invoicing/templates-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_id | string | yes | The ID of the template to delete. |
| body | object | yes | JSON request body |

### Delete template
`POST https://apizie.tech/v1/payments:paypal-invoicing/templates-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_id | string | yes | The ID of the template to delete. |

### List Connections.
`GET https://apizie.tech/v1/payments:paypal-invoicing/connections-get` (byok)

### List Connection Status for an Invoice.
`GET https://apizie.tech/v1/payments:paypal-invoicing/invoice-connection-details-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The invoice id of the account. |

## Example
```
curl "https://apizie.tech/v1/payments:paypal-invoicing/invoices-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Invoices API?
Create a free Apizie key, then send GET https://apizie.tech/v1/payments:paypal-invoicing/invoices-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Invoices API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Invoices itself also needs your own key from paypal.

### Can AI agents use the Invoices API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key payments:paypal-invoicing.

### What is the status of the Invoices API?
Needs your own provider key (bring your own key)