EPASS xAPI Guide

This guide is version 0.1 and was last updated on Oct. 8, 2021

Welcome to the EPASS xAPI User’s Guide. This guide will help you with set-up and install of the EPASS xAPI as well as understanding how you can interact with your EPASS installation through the xAPI endpoints.

Use this guide together with the EPASS xAPI Reference Guide to develop and deploy your EPASS xAPI integration.

This guide is divided into these sections:


Overview

EPASS xAPI is a lightweight web API providing methods to read and write data to EPASS.

Getting Started

What does your user need to know to try your project?

Invoices

The External API (XAPI) provides two method types for adding or modifying invoice-related data - single-transaction, and independent-transaction.

Customers

This section includes information on using the xAPI to add new customers or modify existing ones.