MEF Billing Management (Mef Lso Cantata Billing Management) is one of 95 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
6 operations
across 5 paths,
organized into 2 resource areas,
and defines 41 schemas.
It is described by OpenAPI 3.0.1, at version 3.0.1.
Requests are made against a single base URL, https://{serverBase}/mefApi/cantata/customerBillManagement/v3/.
The identity and technical contract details declared by the specification.
AppliedPayment
object
A list of details of a payment that has been received from the Buyer.
2 properties
AttachmentURL
object
The URL pointing to an Attachment for download.
1 property
BillingAccountRef
object
An identifier for the Billing Account that is unique within the Seller
1 property
1 required
CustomerBill
object
A legal document generated by the Seller to the Buyer relating to charges associated to Products provided by the Seller to the Buyer.
25 properties
24 required
CustomerBillCategory
string
The type of Bill. | Value | MEF 134 |Description | | ----------- | --------- |---------------------------------------------------------------------------------…
CustomerBillItem
object
One or more rows in a Bill that represent charges associated with a Product instance.
15 properties
14 required
CustomerBillItemFee
object
Fees associated with the Bill Item.
4 properties
CustomerBillItemFeeCategory
string
The category of the Fee. One of the following: - recurring - nonRecurring - other
CustomerBillItemRef
object
A reference to a Customer Bill resource.
2 properties
1 required
CustomerBillItemStateType
string
The state of the Bill Item. | state | MEF 134 name | Description | | -------------------------- | -------------------------- | --------------------------------…
CustomerBillItemTax
object
The applied billing tax rate represents the taxes applied billing rate it refers to. It is calculated during the billing process.
4 properties
CustomerBillItemTaxCategory
string
The category of the Tax. One of the following: - country - state - county - city - other
CustomerBillRunType
string
The Billing cycle as set by the Seller. | Value | MEF 134 | Description | | ---------- | --------- | ----------------------------------------------------------…
CustomerBillStateType
string
The state of the Bill. | state | MEF 134 name | Description | | ----------------------- | ---------------------- | --------------------------------------------…
CustomerBill_Find
object
A legal document generated by the Seller to the Buyer relating to charges associated to Products provided by the Seller to the Buyer.
6 properties
4 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error400
Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
Error401
Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired
Error403
Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property the Seller has expected is not present in the payload - invalidValue: The property has an inc…
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
Error501
Not Implemented. Used in case Seller is not supporting an optional operation (https://tools.ietf.org/html/rfc7231section-6.6.2)
EventSubscription
object
Sets the communication endpoint address the service instance must use to deliver notification information
3 properties
2 required
EventSubscriptionInput
object
Sets the communication endpoint address the service instance must use to deliver notification information
2 properties
1 required
FieldedAddressRepresentation
object
A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example "street number" i…
20 properties
FinancialAccountRef
object
A Financial Account within the Seller.
4 properties
1 required
MEFPriceType
string
The type of charge related to the Bill Item.
MEFProductOrderItemRef
object
It's a ProductOrder item
3 properties
2 required
Money
object
A base value business entity used to represent money
2 properties
2 required
PaymentItem
object
A payment that has been received.
4 properties
1 required
PaymentMethod
string
The specific means of payment.
ProductRef
object
2 properties
1 required
RelatedContactInformation
object
Contact data for a person or organization that is involved in the product offering qualification. In a given context it is always specified by the Seller (e.g.…
7 properties
4 required
SubUnit
object
Allows for sub unit identification
2 properties
2 required
TaxItem
object
A tax item is created for each tax rate and tax type used in the bill.
3 properties
TimePeriod
object
A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
