API Endpoints

This section provides detailed documentation for all GLAPI endpoints organized by resource type.

Accounting Dimensions

Core accounting dimension endpoints for managing your chart of accounts structure:

• Customers - Customer management
• Vendors - Vendor management
• Organizations - Organization management
• Subsidiaries - Subsidiary entities
• Departments - Department tracking
• Locations - Location management
• Classes - Class/cost center tracking
• Accounts - Chart of accounts

People & Entities

Endpoints for managing people and related entities:

• Employees - Employee records
• Leads - Lead management
• Prospects - Prospect tracking
• Contacts - Contact information

Inventory & Products

Endpoints for inventory and product management:

• Items - Item and product management
• Warehouses - Warehouse management
• Price Lists - Pricing management
• Units of Measure - UOM management

Financial Operations

Endpoints for financial transactions and operations:

• Invoices - Invoice management
• Payments - Payment tracking
• Business Transactions - Transaction handling

Revenue Recognition

Advanced revenue recognition endpoints (ASC 606 compliant):

• Subscriptions - Subscription management
• Revenue - Revenue recognition and schedules

Common Patterns

All endpoints follow consistent patterns for CRUD operations:

List Resources

GET /api/{resource}

Returns a paginated list of resources.

Query Parameters:

• includeInactive (optional): Include inactive records

Get Single Resource

GET /api/{resource}/{id}

Returns a single resource by ID.

Path Parameters:

• id (required): UUID of the resource

Create Resource

POST /api/{resource}

Creates a new resource.

Request Body: Resource object (see individual endpoint documentation)

Update Resource

PUT /api/{resource}/{id}

Updates an existing resource.

Path Parameters:

• id (required): UUID of the resource

Request Body: Partial resource object with fields to update

Delete Resource

DELETE /api/{resource}/{id}

Deletes a resource.

Path Parameters:

• id (required): UUID of the resource

Response Codes

All endpoints use standard HTTP status codes:

• 200 OK - Request successful
• 201 Created - Resource created successfully
• 400 Bad Request - Invalid request data
• 401 Unauthorized - Authentication required or failed
• 403 Forbidden - Insufficient permissions
• 404 Not Found - Resource not found
• 429 Too Many Requests - Rate limit exceeded
• 500 Internal Server Error - Server error

Error Response Format

Errors are returned in a consistent format:

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable error message",
    "details": {
      // Additional error context (when applicable)
    }
  }
}

Next Steps

• Explore individual endpoint documentation in the sidebar
• Try out endpoints in the Interactive API Reference
• Review Object Types for request/response schemas
• Check out Code Examples for common use cases