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

Optional Fields for Invoice Creation

You can include these optional fields when sending create invoice requests:

clientReferenceInformation.partner.developerId: Set to your developer ID.
clientReferenceInformation.partner.solutionId: Set to your partner solution ID (PSID).
customerInformation.company.name
customerInformation.email
customerInformation.merchantCustomerId
customerInformation.name
invoiceInformation.allowPartialPayments: Set to one of these possible values:
false
: The invoice must be paid in a single payment.
true
: The invoice is payable in installments.
invoiceInformation.deliveryMode
invoiceInformation.description: This field becomes optional when either one of these conditions is met:

The line item fields are present in the request message.
When drafting a deliverable invoice, the
invoiceInformation.deliveryMode
request field is set to
email
.
invoiceInformation.invoiceNumber: Set to a unique number to create an invoice number.

If you do not include this field and a unique value, the invoicing API automatically generates an invoice number for the new invoice.

IMPORTANT

You cannot update this invoice number after sending the API request.
orderInformation.amountDetails.freight.amount
orderInformation.amountDetails.freight.taxable
orderInformation.amountDetails.freight.taxRate
orderInformation.amountDetails.minimumPartialAmount
orderInformation.amountDetails.subAmount

Back to top