API Overview

Invoicing Developer Guide
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introduction to Invoicing

Invoicing API
- Create a Draft Invoice
  - Line Items
  - Required Fields for Drafting an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Drafting an Invoice
  - REST Interactive Example: Create an Invoice Draft
- Create a Deliverable Draft Invoice
  - Line Items
  - Required Fields for Drafting an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Drafting a Deliverable Invoice
  - REST Interactive Example: Create an Invoice Draft
- Create and Send an Invoice Immediately
  - Line Items
  - Required Fields for Creating and Sending an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Creating and Sending an Invoice
  - REST Interactive Example: Create and Send an Invoice
- Create an Invoice without Sending it
  - Line Items
  - Required Fields for Creating an Invoice
  - Optional Fields for Invoice Creation
  - Optional Fields for Discounts and Taxes
  - Example: Creating an Invoice
  - REST Interactive Example: Create a New Invoice
- Get a List of Invoices
  - Generate an Endpoint with Query Parameters
  - Example: Get a List of Invoices
  - REST Interactive Example: Get a List of Invoices
- Get Invoice Details
  - Example: Get Invoice Details
  - REST Interactive Example: Get Invoice Details
- Update an Invoice
  - Line Items
  - Required Fields for Updating an Invoice
  - Optional Fields for Updating an Invoice
  - Example: Updating an Invoice
  - Example: Updating an Invoice with Optional Fields
  - REST Interactive Example: Update an Invoice
- Send an Invoice
  - Example: Send an Invoice
  - REST Interactive Example: Send an Invoice
- Cancel an Invoice
  - Example: Cancelling an Invoice
  - REST Interactive Example: Cancel an Invoice

Invoice Settings API
- Update Invoice Settings
  - Fields for Updating Invoice Settings
  - Example: Update Invoice Settings
  - REST Interactive Example: Update Invoice Settings
- Get Invoice Settings
  - Example: Get Invoice Settings
  - REST Interactive Example: Get Invoice Settings

Add Payer Authentication to Invoicing

Add Invoicing Add-In to Outlook
- Set Up Add-In with Existing Account
- Set Up Add-In with New Account
- Create a Simple Invoice
- Create an Itemized Invoice
- Manage Invoices
- Revoke and Reconnect Outlook Permissions
- Sign Out

Webhooks for Invoicing
- Example: Subscribe to Invoicing Webhooks

Manage Invoices Using the Business Center

Example: Subscribe to Invoicing Webhooks

IMPORTANT

There are additional requirements for implementing webhooks that are not discussed in this guide. To subscribe to invoicing webhook notifications, see the Webhooks Implementation Guide for the REST API
.

Only use this example to reference how to format the

eventTypes

request field and its values.

Request

{
  "name": "Invoicing Webhooks",
  "description": "Webhooks for Invoicing Events",
  "organizationId": "organizationId",
  "productId": "customerInvoicing",
  "eventTypes": [
    "invoicing.customer.invoice.cancel",
    "invoicing.customer.invoice.paid",
    "invoicing.customer.invoice.partial-payment",
    "invoicing.customer.invoice.send"
  ],
  "webhookUrl": "https://test.com:443/test",
  "healthCheckUrl": "https://test.com:443/test",
  "notificationScope": "SELF",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": "false",
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external"
  }
}

Response to a Successful Request

{
  "organizationId": "invoicetest",
  "productId": "customerInvoicing",
  "eventTypes": [
    "invoicing.customer.invoice.cancel",
    "invoicing.customer.invoice.paid",
    "invoicing.customer.invoice.partial-payment",
    "invoicing.customer.invoice.send"
  ],
  "webhookId": "fc880f5a-2145-44db-e053-9e588e0a6a26",
  "name": "Invoicing Webhooks",
  "webhookUrl": "https://test.com:443/test",
  "healthCheckUrl": "https://test.com:443/test",
  "createdOn": "2023-05-25T16:24:51.886Z",
  "status": "INACTIVE",
  "description": "Webhooks for Invoicing Events",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": false,
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external",
    "digitalSignatureEnabled": "yes"
  },
  "version": "3",
  "deliveryType": "nrtdCentral",
  "notificationScope": "SELF"
}

Back to top