Documentation updates for July 8, 2025
As part of an ongoing effort to better align the documentation with the API, we’ve updated several API references. These changes affect the documentation only. The API itself hasn’t changed.
All /Bill endpoints
We’ve updated the /Bill endpoints response schemas to add complete field coverage and proper structure alignment to match the actual API response format. We made the following changes:
- Updated the bill-related /Query response structure to wrap summary fields under a
Summaryobject to match the actual API response format. - Added missing fields to bill record schemas:
Discount,DocumentsRef,EndDate,EntityID,LotNumber,ParentOrgId,paylinkId, andTotalAmount. - Added
managedpayment method to reflect all supported payment types. - Updated field casing throughout bill-related response schemas (for example,
address1→Address1) to match the actual API responses. - Added standard response fields (
pageIdentifier,roomId,responseCode,isSuccess,responseText) to all bill operation endpoints for consistency. - Enhanced examples with more comprehensive sample data including transaction details, vendor information, and bill event histories to better reflect real-world API responses.
Bill-related file operation endpoints We’ve updated file-related endpoint documentation to properly reflect response structures:
- Updated getAttachedFromBill response documentation to accurately describe both binary file and Base64-encoded object response formats.
- Added standard response fields to file operation endpoints for consistency with other API responses.
Vendor data response schema changes
We’ve updated the vendor data response schemas to ensure complete field coverage and proper casing alignment:
- Updated to include all vendor fields with proper casing to match actual API responses.
- Added missing vendor fields including
CreatedDate,LastUpdated,customField1,customField2,ParentOrgId,ParentOrgName, and various paypoint-related fields. - Enhanced vendor examples with complete billing data, contact information, and additional metadata to better represent actual API responses.