๐ API v1.1.0 Released - Enhanced Budget Management & UBS Support
We're excited to announce the release of Billoget API v1.1.0, our biggest update yet! This release introduces significant improvements to budget management, customer data handling, product catalog features, and introduces the revolutionary UBS (Unified Budgeting Standard) for public budget access.
๐ What's Newโ
๐ Enhanced Budget Managementโ
Read-Only Budget API for Data Integrity
- Budgets are now read-only via API to maintain data integrity
- All budget creation/modification happens through the secure web interface
- Enhanced filtering with new fields:
state
,ubs_id
,ubs_version
- New budget states:
0=Generated
,1=Approved
,2=Rejected
New Budget Fields:
{
"id": "budget_123",
"state": 0,
"ubs_id": "ubs_456",
"ubs_version": "1.0",
"publicToken": "pub_token_abc123",
"minimumPaymentToConfirm": 500.0,
"paymentUrl": "https://payment.billoget.com/budget_123",
"comments": "Updated budget notes",
"isArchived": false
}
๐ฅ Enhanced Customer Dataโ
DNI and CUIT Support
- Added
dni
(number) field for national identification - Added
cuit
(string) field for tax identification - Separated
firstName
andlastName
for better data structure - Enhanced search capabilities by DNI and CUIT
Updated Customer Structure:
{
"id": "customer_456",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phoneNumber": "+1-555-123-4567",
"dni": 12345678,
"cuit": "20-12345678-9",
"businessId": "business_001"
}
๐ฆ Product Variants Supportโ
Complete Variant Management
- Create products with multiple variants
- Each variant has independent pricing, stock, and attributes
- Custom attributes support for flexible product configurations
- New product types:
PRODUCT
,SERVICE
,SUBSCRIPTION
Product with Variants Example:
{
"productCode": "MKT-PREM-001",
"description": "Premium Marketing Package",
"type": "SERVICE",
"variants": [
{
"name": "Basic",
"price": 1500.0,
"attributes": {
"duration": "1 month",
"channels": "2"
}
},
{
"name": "Premium",
"price": 2500.0,
"attributes": {
"duration": "3 months",
"channels": "5"
}
}
]
}
๐ Budget Approval Systemโ
Complete Approval Workflow
- Submit budgets for approval with request notes
- Track approval status:
PENDING
,APPROVED
,REJECTED
- Approval actions:
APPROVE
,REJECT
,REQUEST_CHANGES
- Full audit trail with timestamps and comments
Approval Example:
{
"budgetId": "budget_123",
"requestNotes": "Please review Q1 marketing budget",
"action": "APPROVE",
"status": "PENDING"
}
๐ UBS (Unified Budgeting Standard)โ
Public Budget Access Revolution
- Access budgets via public tokens without authentication
- Public confirmation and rejection workflows
- Secure token-based system for customer interactions
- Perfect for client-facing budget review processes
UBS Endpoints:
# Get budget by public token
GET /api/public/ubs/budget/{token}
# Confirm budget publicly
POST /api/public/ubs/budget/{token}/confirm
# Reject budget with reason
POST /api/public/ubs/budget/{token}/reject
๐ ๏ธ Technical Improvementsโ
๐ก Enhanced API Structureโ
New Endpoint Categories:
- Budget Approvals API - Complete approval management
- UBS API - Public budget access and interactions
- Product Variants API - Variant management endpoints
- Enhanced Filtering - Advanced search and filter options
๐ Security Enhancementsโ
- Token-based UBS access with secure validation
- Read-only budget operations for data integrity
- Enhanced API key scopes for granular permissions
- Audit trails for all approval actions
๐ Better Data Validationโ
- TypeScript interfaces for all new endpoints
- Enhanced error handling with descriptive messages
- Input validation for DNI, CUIT, and other fields
- Consistent response formats across all endpoints
๐ฅ Updated Resourcesโ
๐ง Postman Collection v1.1.0โ
Download the updated collection with all new endpoints:
- Postman Collection v1.1.0 - Interactive documentation and collection download
New Collection Features:
- โ All new API endpoints with examples
- โ Automated tests for response validation
- โ Environment variables for easy switching
- โ Pre-request scripts for authentication
- โ Rate limiting awareness
๐ SDK Updatesโ
The billoget-sdk v1.1.0 has been updated to support all new features:
npm install billoget-sdk@1.1.0
New SDK Features:
- Budget approval methods
- UBS token operations
- Product variant management
- Enhanced customer operations
- TypeScript support for all new types
๐ Migration Guideโ
From v1.0.0 to v1.1.0โ
Budget Operations:
// โ No longer available (v1.0.0)
await billoget.budgets.create(budgetData);
await billoget.budgets.update(id, updateData);
await billoget.budgets.delete(id);
// โ
Use read-only methods (v1.1.0)
const budgets = await billoget.budgets.list({ state: 0 });
const budget = await billoget.budgets.getById(id);
Customer Structure:
// โ Old structure (v1.0.0)
{
"name": "John Doe",
"taxId": "12-3456789"
}
// โ
New structure (v1.1.0)
{
"firstName": "John",
"lastName": "Doe",
"dni": 12345678,
"cuit": "20-12345678-9"
}
Product Variants:
// โ
New in v1.1.0
const product = await billoget.products.createWithVariants({
productCode: "PROD-001",
description: "Main Product",
variants: [
{ name: "Small", price: 100 },
{ name: "Large", price: 200 },
],
});
๐ฏ Use Casesโ
๐ผ Business Scenariosโ
1. Client Budget Review
// Generate UBS token for client review
const budget = await billoget.budgets.getById("budget_123");
const ubsUrl = `https://budgets.billoget.com/${budget.publicToken}`;
// Send URL to client for review and approval
2. Product Catalog with Variants
// Create service with multiple tiers
const service = await billoget.products.createWithVariants({
description: "Consulting Service",
type: "SERVICE",
variants: [
{ name: "Basic", price: 500, attributes: { hours: "5" } },
{ name: "Premium", price: 1000, attributes: { hours: "10" } },
],
});
3. Approval Workflow
// Submit budget for approval
const approval = await billoget.budgetApprovals.submit({
budgetId: "budget_123",
requestNotes: "Please review Q1 budget",
action: "APPROVE",
});
๐ฎ What's Nextโ
Upcoming Features (v1.2.0)โ
- Real-time notifications via WebSockets
- Bulk operations for products and customers
- Advanced analytics endpoints
- Custom approval workflows
- Multi-currency support enhancements
Community Feedbackโ
We'd love to hear your feedback on the new features! Join our community:
- ๐ฌ GitHub Discussions
- ๐ง Developer Support
- ๐ Documentation
๐ Get Startedโ
Ready to upgrade? Here's how to get started:
- ๐ฅ Download the new Postman collection v1.1.0
- ๐ Review the updated documentation
- ๐ง Update your integration to use new endpoints
- ๐งช Test with the enhanced SDK v1.1.0
- ๐ Deploy with confidence
Happy coding! ๐
The Billoget Development Team
For technical questions or support, reach out to our developer community or contact us at developers@billoget.com.