New Light partners with Amesto GlobalLight partners with Amesto Global Read the announcement

Light API·v1.0.0

Introduction

Welcome to the Light API documentation.

Section
Getting started
Reading
3 min read
Base URL
https://api.light.inc
On this page
  1. 01Where to start
  2. 02Enum values and forward compatibility
  3. 03Breaking changes and notice
  4. 04Amounts
  5. 05What should a finance integration pilot prove?

The Light API is organized around REST and uses standard HTTP response codes, authentication and verbs. Most endpoints accept and return JSON-encoded data in camel case.

All requests go to:

https://api.light.inc

Where to start

Enum values and forward compatibility

Some fields in this API use enumerated (enum) values to represent specific states or types. While these enums are fully documented, they are not guaranteed to be exhaustive. New enum values may be introduced over time as the system evolves.

To maintain forward compatibility:

  • Always handle unexpected or unknown enum values gracefully.
  • Avoid assuming the list of values is complete or immutable.
  • Where possible, use string-based comparisons or a safe fallback rather than exhaustive matching.

This policy allows Light to extend functionality without introducing breaking changes for consumers who implement robust handling.

Breaking changes and notice

A breaking change is one that can stop a working integration, such as an optional field becoming required, an endpoint being removed or a response changing shape. Adding endpoints, optional fields or enum values is not a breaking change.

Before a breaking change ships, Light checks which companies have recently called the affected endpoint and contacts the ones it affects directly. The notice says what is changing, shows an example request and gives the date the change takes effect.

  • A field that becomes required gets at least 30 days' notice.
  • An endpoint that is removed, or a response that changes shape, gets 60 to 90 days' notice.

Where possible, the old request keeps working until that date.

Amounts

Amounts are integers in minor units: 1250 USD is 12.50 USD and 150 JPY is 150 JPY. Each amount is paired with its currency in the same object. Direction (debit or credit) travels separately from size; Reading amounts explains the conventions and the one place their polarity flips.

What should a finance integration pilot prove?

Before writing the connector, name the owner of customers, vendors, contracts, invoices and payment status in each system. Agree the identifiers and direction of updates, then test a correction as well as a successful transfer.

  • Permissions: choose the credential and role using Authentication. Test the actions the integration must refuse as well as those it needs.
  • Record lifecycle: follow Document lifecycle to separate creating a draft, posting it and recording payment.
  • Retries and duplicates: follow Idempotency and each endpoint's notes before retrying a write. Bill creation and four bill actions accept a key, but not every operation does. Test recovery from a timeout without creating a second transaction.
  • Completeness and errors: use Pagination, filtering and errors to check a full extract and retain a recoverable error queue.
  • Ownership: assign a person to failed transfers, credential rotation, mapping changes and reconciliation of totals back to the source.

Use Choosing an endpoint to check supported operations and documented boundaries. The order to cash guide puts those checks into a CRM, billing and accounting workflow.

The documentation

04·API reference

256endpoints

40resources

API reference