API BillingManagement 2.4.0
OAS 2.0
[ Base URL: api.orange.com/billing/b2b/v1 ]https://developer.orange.com/ope-contents/channels/87afd7365baec589/offers/mFtzLgDNX8CvdmSt/products/fBw2ge7S7m3EysH5/contents/swagger/ljCiUkC5lG6z93k3/swagger.json
Describes a Customer API for managing bills.
Resources:
bills : A bill is a request for payment of money owed. It defines the services used, the charges, usage dates and different amounts.
billingAccounts: used to retrieve billing account information.
reports : used to get reports.
customerSpecificReports : used to get customer specific reports.
status: used to know the status of API components.
asyncJobs: used to know the status of asynchronous jobs.
installedOfferIds: used to get a list of all installed offer IDs.
Common query parameter:
- overrideAccept : the query parameter overrideAccept may be used in every request of the API.
If used, this parameter value supersedes the value of theAccept
Header.
Asynchronous mode:
To activate asynchronous mode the X-RESPONSE-MODE
header should be set in the request with the ASYNCHRONOUS
value. All other value will be treated as SYNCHRONOUS
which is the default value.
The header name and values are case insensitive.
This mode is enabled only for the following URLs
GET /bills
GET /bills/{billId}
GET /bills/{billId}/items
GET /reports/{reportId}
GET /customerSpecificReports/{customerSpecificReportId}
POST /bills/search
Date parameter:
Anywhere the syntax date=startDate/endDate is allowed (typically for issuedAt and period parameters), the following syntaxes are also allowed:
date=lastXXXdays where XXX is a number. Returns all resources where date is in the last XXX days.
date=afterYYY-MM-DD. Returns all resources where date is strictly greater than YYYY-MM-DD.
date=atOrAfterYYY-MM-DD. Returns all resources where date is greater than or equal to YYYY-MM-DD.
date=beforeYYY-MM-DD. Returns all resources where date is strictly smaller than YYYY-MM-DD.
date=atOrBeforeYYY-MM-DD. Returns all resources where date is smaller than or equal to YYYY-MM-DD.
date=!=YYYY-MM-DD. Returns all resources where date is NOT YYYY-MM-DD
All date related keywords are case insensitive and all dates may be formatted as simple date (YYYY-MM-DD) or UTC date with time (YYYY-MM-DDThh:mm:ssZ).
You can review the reports for a period of 6 months, while invoices are retained for 2 years only as requested by GDPR.