Summit Finance API Documentation

1. Introduction

Welcome to the Summit API documentation. Summit is an open-source invoicing and financial management application. This API allows developers to interact with Summit's core functionalities programmatically.

Authentication

All API requests must be authenticated using an API key. The API key should be included in the Authorization header as a Bearer token.

Example: Authorization: Bearer <YOUR_API_TOKEN>

Base URL

The base URL for all API endpoints is: https://your-summit-instance.com (Replace your-summit-instance.com with your actual Summit instance URL). All API paths are prefixed with /api.

2. Getting Started

Obtaining an API Key

API keys can be generated from the Summit application:

1. Log in to your Summit account.
2. Navigate to Settings.
3. Go to the API Tokens tab.
4. Click on "Generate New Token".
5. Provide a name for your token and click "Generate Token".
6. Important: Copy the generated token immediately. You will not be able to see it again.

The token will look like skt_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx.

Authentication Process

Include your API token in the Authorization header for every request:

Authorization: Bearer skt_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxx

Common Headers

• Authorization: Bearer token for authentication.
• Content-Type: Should be application/json for requests with a JSON body (e.g., POST, PUT).