Technical Specs

API architecture, authentication, and common patterns.

Key Capabilities

✓
Post-only request architecture for security
✓
Standard JSON request/response bodies
✓
Bearer/Header-based token authentication
✓
Comprehensive validation error reporting
✓
Consistent pagination and filtering logic

API Architecture

All Billspree APIs follow standard RESTful principles and provide consistent request/response structures.

General Notes

  • **Request Method**: All sensitive operations use the POST method for enhanced security.
  • **Content Type**: JSON is used for all request and response bodies (application/json).
  • **Base URL**: https://api.billspree.com/v1

    • Authentication

    Billspree uses Bearer Token authentication to secure all API endpoints.

    Obtaining a Token

    Tokens are generated through the Session API by providing your Client ID and Secret.

    Using the Token

    Include the token in the Authorization header of every request:

    `Authorization: Bearer YOUR_ACCESS_TOKEN`

    Common Patterns

    Pagination

    List endpoints accept limit and offset parameters in the request body.

  • **Limit**: The maximum number of records to return (Default: 20, Max: 100).
  • **Offset**: The number of records to skip (Default: 0).

    • Filtering

    Filtering is performed using a filters array. Each filter consists of a field, operator, and value.

    App Codes

  • **BillSpree**: 200
  • **BookSpree**: 300
  • **PubSpree**: 400
  • **RollSpree**: 900
  • **WorkSpree**: 1100

    • Data & Formats

    Supported Document Formats

    PubSpree supports publishing in the following formats:

  • **PDF**: Standard for invoices and payslips.
  • **DOCX**: Editable documents.
  • **CSV/Excel**: Data exports and reports.
  • **JSON**: Raw data representation.

    • Payment Gateways

    BillSpree integrates natively with major payment providers like Stripe, PayPal, and Square.