Overview
- The Optimum Parcel Paper Invoice Preference API lets you manage billing delivery settings for users and websites. You can develop applications that integrate with Optimum Parcel to programmatically opt accounts in or out of physical mailings, ensuring that billing preferences align with organizational sustainability goals or accounts payable workflows.
- View Doc →
- The following figure shows the relationship between your Optimum Parcel app, the Optimum Parcel API, and Paper Invoice Preferences.
Optimum Parcel App
Optimum Parcel’s preference services give users control over how they receive financial documents, allowing them to toggle between digital-only delivery and traditional paper statements based on their administrative needs.
Optimum Parcel API
The REST API that allows users to retrieve current settings and update invoice delivery methods for specific users or websites from within your app.
Preference Management
A system that stores and enforces the delivery flags (enabled/disabled), ensuring that the billing engine generates and mails physical copies only to those entities that have explicitly requested them.
What can users do with the Optimum Parcel Paper Invoice Preference API?
Users can use the Optimum Parcel Paper Invoice Preference API to perform common workflows, such as:
- Retrieve the current paper invoice setting for a specific user ID
- Check if a specific website profile is configured for physical mail
- Programmatically disable paper invoices to support "Go Green" initiatives
- Enable paper billing for accounts requiring physical audit trails
- Synchronize billing preferences between internal systems and Optimum Parcel
Paper Invoice Preference properties available to view and modify through the Optimum Parcel Paper Invoice Preference API:
- Paper Invoices Enabled (Boolean)
- User IDs
- Website IDs
Additional info
- Learn more about developing with Optimum Parcel Paper Invoice Preference API, including handling authentication, authorization, reference the Develop on Optimum Parcel API for your workspace.
- More →
- Learn more about how to launch and run a Optimum Parcel Paper Invoice Preference API app, read the Developer Getting Started Guide.
- More →
