{"info":{"_postman_id":"45b1d74d-de76-4e10-ad66-ce0fc1fd2603","name":"CustomerBill","description":"

TMF API Reference: TMF 678 - Customer bill Management

\n

Release: 19.5 - December 2019

\n

The Customer Bill Management API allows to find and retrieve one or several customer bills (also called invoices) produced for a customer. A customer bill is an electronic or paper document produced at the end of the billing process. The customer bill gathers and displays different items (applied customer billing rates generated during the rating and billing processes) to be charged to a customer. It represents a total amount due for all the products during the billing period and all significant information like dates, bill reference...\nThis API provides also operations to find and retrieve the details of applied customer billing rates presented on a customer bill. \nFinally, this API allows to request in real-time a customer bill creation and to manage this request.

\n

Resources

\n\n

Operations

\n

Customer Bill Management API performs the following operations :

\n\n

Copyright © TM Forum 2018. All Rights Reserved.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11528456","collectionId":"45b1d74d-de76-4e10-ad66-ce0fc1fd2603","publishedId":"2sAYX9kzcG","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-02-09T13:29:53.000Z"},"item":[{"name":"customerBillOnDemand","item":[{"name":"{id}","item":[{"name":"Retrieves a CustomerBillOnDemand by ID","id":"e8f2e82c-41d7-4741-a6fa-46f59c548c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","description":"

This operation retrieves a CustomerBillOnDemand entity. Attribute selection is enabled for all first level attributes.

\n","urlObject":{"path":["customerBillOnDemand",":id"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to provide in response

\n","type":"text/plain"},"key":"fields","value":""}],"variable":[{"id":"ac3b3cb9-a962-4ed5-ac14-a753378b3348","description":{"content":"

(Required) Identifier of the CustomerBillOnDemand

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"23726c3b-b99d-406c-8120-bc762256c5f2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"href\": \"\",\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"inProgress\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"127adfde-e613-464c-a0ea-fbeaf956caf1","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"c97d1dde-eb43-432a-a6a6-d0b5cd2565ff","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"5f4c6289-2890-4a97-9a5d-8e77ab6230ca","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"dcc49c92-eb83-475d-8f7c-da088baac8c6","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"e3cf47cd-f0ea-4c0e-b2b0-febd04f59ef8","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"751603b9-586c-43bb-b5b1-0f590f4a939d","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"ccc2c136-1c26-42f0-97f3-9078d9a929dc","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"e8f2e82c-41d7-4741-a6fa-46f59c548c3d"}],"id":"5b6bece9-30ad-4936-9bd7-85f4c965faac","_postman_id":"5b6bece9-30ad-4936-9bd7-85f4c965faac","description":""},{"name":"List or find CustomerBillOnDemand objects","id":"f3fd898f-245b-4c98-87f1-e8eefb903537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","description":"

This operation list or find CustomerBillOnDemand entities

\n","urlObject":{"path":["customerBillOnDemand"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to be provided in response

\n","type":"text/plain"},"key":"fields","value":""},{"description":{"content":"

Requested index for start of resources to be provided in response

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Requested number of resources to be provided in response

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"92e5ae15-76eb-4a7c-b221-0b47500e9b84","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"disabled":false,"description":{"content":"Actual number of items returned in the response body","type":"text/plain"},"key":"X-Result-Count","value":""},{"disabled":false,"description":{"content":"Total number of items matching criteria","type":"text/plain"},"key":"X-Total-Count","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"href\": \"\",\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"rejected\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"rejected\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n]"},{"id":"7c0c5c73-c594-47f0-8d5a-a7a1e41327b6","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"9d5fca11-c2d2-4594-bab8-748d7d9212c5","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"654c106b-c923-4f36-9912-a1184bb8aeec","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"c59d72b2-4e71-44d5-8047-5b065290f5e2","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"a4812f1a-0cbb-4ae3-ab83-97777a330a7c","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"418514f2-988e-40a6-99ba-6298d6eb2e3c","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"e33bf64d-12c5-4079-9c28-64781061239f","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBillOnDemand"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"f3fd898f-245b-4c98-87f1-e8eefb903537"},{"name":"Creates a CustomerBillOnDemand","id":"bfb4bfd6-f537-4b73-ab9a-b6d8135bc5cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand","description":"

This operation creates a CustomerBillOnDemand entity.

\n","urlObject":{"path":["customerBillOnDemand"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[],"variable":[]}},"response":[{"id":"fe6b7165-ed73-46a8-83ab-d205fca26a16","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"href\": \"\",\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"inProgress\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"44d2c2ec-b971-4128-bf3d-0966f32b27dc","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"e5cc5776-0dd1-452b-baed-02b65c9554f0","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"bb167b5a-894d-4e36-a45e-8b1b84315510","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"6efa9971-6de5-4901-a92e-cb5660c9e3d2","name":"Method Not allowed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"40057959-f07a-4a85-8908-2cb100370b60","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"aceca38d-35ec-4e75-92e7-94e8c8afa036","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"description\": \"\",\n \"lastUpdate\": \"\",\n \"name\": \"\",\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"customerBill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"state\": \"terminatedWithError\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBillOnDemand"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"bfb4bfd6-f537-4b73-ab9a-b6d8135bc5cc"}],"id":"118b66b3-bbdc-440c-9ddd-d23b26c7eb7d","description":"

Diagram

\n\n\n

Example

\n
{\n    \"id\": \"D123\",\n    \"href\": \"http://server:port/tmf-api/Customer_Bill_Management/v4/customerBillOnDemand/D123\",\n    \"description\": \"Customer bill on demand\",\n    \"lastUpdate\": \"2020-01-19T12:34:56.123Z\",\n    \"name\": \"BillOnCustomerDemand\",\n    \"billingAccount\": {\n        \"id\": \"A0815\",\n        \"href\": \"http://server:port/tmf-api/Account_Management/v4/billingAccount/A0815\",\n        \"name\": \"BA Peter Retep\",\n        \"@referredType\": \"BillingAccount\",\n        \"@type\": \"BillingAccountRef\",\n        \"@baseType\": \"BillingAccountREf\",\n        \"@schemaLocation\": \"...some href...\"\n    },\n    \"customerBill\": {},\n    \"relatedParty\": {\n        \"id\": \"RP0815\",\n        \"href\": \"http://server:port/tmf-api/Party_Management/v4/party/RP0815\",\n        \"name\": \"Peter Retep\",\n        \"role\": \"requester\",\n        \"@referredType\": \"RelatedParty\",\n        \"@type\": \"RelatedParty\",\n        \"@baseType\": \"RelatedParty\",\n        \"@schemaLocation\": \"...some href...\"\n    },\n    \"state\": \"inProgress\",\n    \"@type\": \"CustomerBillOnDemand\",\n    \"@baseType\": \"CustomerBillOnDemand\",\n    \"@schemaLocation\": \"http://server:port/tmf-api/Customer_Bill_Management/v4/schemas/customerBillOnDemand\"\n}\n\n
\n","_postman_id":"118b66b3-bbdc-440c-9ddd-d23b26c7eb7d"},{"name":"customerBill","item":[{"name":"{id}","item":[{"name":"Retrieves a CustomerBill by ID","id":"903dce50-8621-46f3-88a4-4dd45aca023a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","description":"

This operation retrieves a CustomerBill entity. Attribute selection is enabled for all first level attributes.

\n","urlObject":{"path":["customerBill",":id"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to provide in response

\n","type":"text/plain"},"key":"fields","value":""}],"variable":[{"id":"71852842-e3df-497f-83cd-991b3939fe13","description":{"content":"

(Required) Identifier of the CustomerBill

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b79e13af-63be-4bb1-9c9e-bebb695bb1f3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"href\": \"\",\n \"billDate\": \"\",\n \"billNo\": \"\",\n \"category\": \"\",\n \"lastUpdate\": \"\",\n \"nextBillDate\": \"\",\n \"paymentDueDate\": \"\",\n \"runType\": \"\",\n \"amountDue\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"appliedPayment\": [\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"billDocument\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingPeriod\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"financialAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"accountBalance\": [\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"paymentMethod\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"remainingAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"state\": \"new\",\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxItem\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"2166abe8-ac32-4984-9ca5-2a4f03eddf10","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"67bb5998-3924-4429-9797-49ead8a116f5","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"ecd5b3d4-6a63-45d8-8178-90ebcdf1febd","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"bbb88497-0e01-4a2e-9ff5-61a049f4c433","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"70e11bd9-13dd-424a-99aa-7a585dc35561","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"027d7623-4993-4697-878b-5f633d20efaf","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"474254e2-0be9-442f-8da7-35ae5fa841e6","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"903dce50-8621-46f3-88a4-4dd45aca023a"},{"name":"Updates partially a CustomerBill","id":"26f260c0-28dc-463c-8f96-441d1a9e6eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","description":"

This operation updates partially a CustomerBill entity.

\n","urlObject":{"path":["customerBill",":id"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[],"variable":[{"id":"6dd9ed63-1f75-4b84-817f-9b520c3b8cd8","description":{"content":"

(Required) Identifier of the CustomerBill

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"951fed78-68c1-41b7-acd7-fccf875be120","name":"Updated","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"href\": \"\",\n \"billDate\": \"\",\n \"billNo\": \"\",\n \"category\": \"\",\n \"lastUpdate\": \"\",\n \"nextBillDate\": \"\",\n \"paymentDueDate\": \"\",\n \"runType\": \"\",\n \"amountDue\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"appliedPayment\": [\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"billDocument\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingPeriod\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"financialAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"accountBalance\": [\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"paymentMethod\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"remainingAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"state\": \"new\",\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxItem\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"6c59cd78-96fb-439c-b165-763c43c1c677","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"def58614-b8ab-47a6-a44b-2c47777da8cd","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"6fc0c0fd-a735-4314-a3ab-629b979c52b2","name":"Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"4b1d6a0e-7f19-4592-8ed6-133cce74d24a","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"9b9d9c28-6ec3-4497-82cb-648c046fd5bd","name":"Method Not allowed","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"ec00b5e3-59ca-45e6-8c56-24fe7a4ccb5e","name":"Conflict","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"1fd1180d-3c45-43c7-8144-e19ec18989ab","name":"Internal Server Error","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"state\": \"sent\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"26f260c0-28dc-463c-8f96-441d1a9e6eb8"}],"id":"34390567-4534-4616-8686-253e3a22be09","_postman_id":"34390567-4534-4616-8686-253e3a22be09","description":""},{"name":"List or find CustomerBill objects","id":"23cb3859-a16d-46cf-86a1-d1df00b81d7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","description":"

This operation list or find CustomerBill entities

\n","urlObject":{"path":["customerBill"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to be provided in response

\n","type":"text/plain"},"key":"fields","value":""},{"description":{"content":"

Requested index for start of resources to be provided in response

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Requested number of resources to be provided in response

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"2532f99d-8094-470d-8eb7-e6fc9afad6c2","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"disabled":false,"description":{"content":"Actual number of items returned in the response body","type":"text/plain"},"key":"X-Result-Count","value":""},{"disabled":false,"description":{"content":"Total number of items matching criteria","type":"text/plain"},"key":"X-Total-Count","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"href\": \"\",\n \"billDate\": \"\",\n \"billNo\": \"\",\n \"category\": \"\",\n \"lastUpdate\": \"\",\n \"nextBillDate\": \"\",\n \"paymentDueDate\": \"\",\n \"runType\": \"\",\n \"amountDue\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"appliedPayment\": [\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"billDocument\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingPeriod\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"financialAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"accountBalance\": [\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"paymentMethod\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"remainingAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"state\": \"onHold\",\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxItem\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"billDate\": \"\",\n \"billNo\": \"\",\n \"category\": \"\",\n \"lastUpdate\": \"\",\n \"nextBillDate\": \"\",\n \"paymentDueDate\": \"\",\n \"runType\": \"\",\n \"amountDue\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"appliedPayment\": [\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"appliedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"payment\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"billDocument\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"attachmentType\": \"\",\n \"content\": \"\",\n \"description\": \"\",\n \"mimeType\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"size\": {\n \"amount\": 1,\n \"units\": \"\"\n },\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingPeriod\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"financialAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"accountBalance\": [\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"amount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"balanceType\": \"\",\n \"validFor\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"paymentMethod\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"relatedParty\": [\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n }\n ],\n \"remainingAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"state\": \"sent\",\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxItem\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n]"},{"id":"af465327-471a-46f7-beed-92e4eb4e4016","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"f4c7a8e2-7976-455c-b071-44982a668ed0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"99c873f0-ea61-4278-b530-573044b69f5b","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"5f92aa8b-7620-45a8-8f91-3585d9674a86","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"69ad2b9f-b84c-42f6-815c-8a8fcd6301b2","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"96591ed1-4fbe-4eae-ac82-773def150168","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"6848d67d-01d8-4cfc-8cac-8b54926af2ce","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/customerBill?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["customerBill"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"23cb3859-a16d-46cf-86a1-d1df00b81d7e"}],"id":"a989b20a-511e-45ff-8903-4f84db9320db","description":"

Diagram

\n\n\n

Example

\n
{\n    \"id\": \"CB-123\",\n    \"href\": \"https://server:port/tmf-api/Customer_Bill_Management/v4/customerBill/CB-123\",\n    \"billNo\": \"780123456\",\n    \"amountDue\": {\n        \"unit\": \"EUR\",\n        \"value\": 0.00\n        },\n    \"appliedPayment\": [\n        {\n            \"appliedAmount\": {\n                \"unit\": \"EUR\",\n                \"value\": 50.00\n            },\n            \"payment\": {\n                \"id\": \"PAY-9876\",\n                \"href\": \"https://server:port/tmf-api/Payment_Management/v4/payment/PAY-9876\",\n                \"name\": \"csp-bill\",\n                \"@referredtype\": \"Payment\",\n                \"@type\": \"PaymentRef\",\n                \"@baseType\": \"PaymentRef\",\n                \"@schemaLocation\": \"...some href...\"\n            },  \n            \"@type\": \"AppliedPayment\",\n            \"@baseType\": \"AppliedPayment\",\n            \"@schemaLocation\": \"...some href...\"\n        }\n    ],\n    \"billCycle\": {\n        \"id\": \"BC-1234\",\n        \"href\": \"http://server:port/tmf-api/Customer_Bill_Management/v4/billcycle/BC-1234\",\n        \"@referredType\": \"BillCycle\",\n        \"@type\": \"BillCycleRef\",\n        \"@baseType\": \"BillCycleRef\",\n        \"@schemaLocation\": \"...some href...\"\n        },\n    \"billDate\": \"2020-01-05T12:00:56.982Z\",\n    \"billDocument\": [\n        {\n            \"id\": \"DOC_1234\",\n            \"href\": \"http://server:port/tmf-api/Document_Management/v4/document/DOC_1234\",\n            \"attachmentType\": \"application/pdf\",\n            \"content\": \"bill\",\n            \"description\": \"regular monthly bill\",\n            \"mimeType\": \"application/pdf\",\n            \"size\": 172851,\n            \"uri\": \"\",\n            \"validfor\": {\n                \"startDateTime\": \"2020-01-05T12:00:56.982Z\",\n                \"endDateTime\": \"9999-12-31T23:59:59.999Z\"\n            },\n            \"@referredType\": \"application/pdf\",\n            \"@type\": \"AttachmentRefOrValue\",\n            \"@baseType\": \"AttachmentRefOrValue\",\n            \"@schemaLocation\": \"...some href...\"\n        }\n    ],\n    \"billingAccount\": {\n        \"id\": \"A0815\",\n        \"href\": \"http://host:port/tmf-api/Account_Management/v4/billingAccount/A0815\",\n        \"name\": \"BA Peter Retep\",\n        \"@referredType\": \"BillingAccount\",\n        \"@type\": \"BillingAccountRef\",\n        \"@baseType\": \"BillingAccountRef\",\n        \"@schemaLocation\": \"...some href...\"\n        },\n    \"financialAccount\": {\n        \"id\": \"FA12345\",\n        \"href\": \"http://host:port/tmf-api/Account_Management/v4/financialAccount/FA12345\",\n        \"name\": \"FA Peter Retep\",\n        \"@referredType\": \"FinancialAccount\",\n        \"@type\": \"FinancialAccountRef\",\n        \"@baseType\": \"FinancialAccountRef\",\n        \"@schemaLocation\": \"...some href...\"\n        },\n    \"billingPeriod\": {},\n    \"category\": \"normal\",\n    \"lastUpdate\": \"2020-01-05T12:00:56.982Z\",\n    \"nextBillDate\": \"2020-02-05T12:00:00.000Z\",\n    \"paymentDueDate\": \"2020-01-15T00:00:00.000Z\",\n    \"paymentMethod\": {},\n    \"relatedParty\": [\n        {}\n    ],\n    \"remainingAmount\": {\n        \"unit\": \"EUR\",\n        \"value\": 0.00\n        },\n    \"runType\": \"regular bill run\",\n    \"status\": \"settled\",\n    \"taxExcludedAmount\": {\n        \"unit\": \"EUR\",\n        \"value\": 40.00\n        },\n    \"taxIncludedAmount\": {\n        \"unit\": \"EUR\",\n        \"value\": 50.00\n        },\n    \"taxItem\": [\n        {\n            \"taxAmount\": {\n                \"unit\": \"EUR\",\n                \"value\": 10.00\n            },\n            \"taxCategory\": \"VAT\",\n            \"taxRate\": 0.25,\n            \"@type\":\"TaxItem\",\n            \"@baseType\": \"TaxItem\",\n            \"@schemalocation\":\"...some uri...\"\n        }\n    ],\n    \"@type\":\"CustomerBill\",\n    \"@baseType\": \"CustomerBill\",\n    \"@schemalocation\":\"...some uri...\"\n}\n\n
\n","_postman_id":"a989b20a-511e-45ff-8903-4f84db9320db"},{"name":"appliedCustomerBillingRate","item":[{"name":"{id}","item":[{"name":"Retrieves a AppliedCustomerBillingRate by ID","id":"46506cf7-94b0-4b81-94f7-44aad381eda1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","description":"

This operation retrieves a AppliedCustomerBillingRate entity. Attribute selection is enabled for all first level attributes.

\n","urlObject":{"path":["appliedCustomerBillingRate",":id"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to provide in response

\n","type":"text/plain"},"key":"fields","value":""}],"variable":[{"id":"d1dbb51c-3cb2-4303-9ca6-78a76c122db3","description":{"content":"

(Required) Identifier of the AppliedCustomerBillingRate

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0451aa5b-5a4c-4cd0-8f61-bc316523aa1f","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"href\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"isBilled\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"appliedTax\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"bill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"characteristic\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"periodCoverage\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"product\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"690910c0-81b1-4050-b5e1-6a5b05dd4c40","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"615daaaf-582f-4647-9e17-9399377eb61c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"dcb81bfd-e9e4-4047-bf88-79836f04cc54","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"3086c4ed-2738-4b0c-9524-6de4f14a5fc5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"fc455c4b-fa4a-40d2-bf6c-dc2d776bf7b9","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"1c5bfcee-ff0d-4c74-b386-fd179c9572bd","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"73bb91e0-6286-469f-ab67-5267da82b2cd","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate/:id?fields=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate",":id"],"query":[{"description":"Comma-separated properties to provide in response","key":"fields","value":""}],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"46506cf7-94b0-4b81-94f7-44aad381eda1"}],"id":"5b65700b-868d-4780-8afc-9bb656d3c71e","_postman_id":"5b65700b-868d-4780-8afc-9bb656d3c71e","description":""},{"name":"List or find AppliedCustomerBillingRate objects","id":"1cd042a6-9832-405b-bf72-4f68561aef1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","description":"

This operation list or find AppliedCustomerBillingRate entities

\n","urlObject":{"path":["appliedCustomerBillingRate"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[{"description":{"content":"

Comma-separated properties to be provided in response

\n","type":"text/plain"},"key":"fields","value":""},{"description":{"content":"

Requested index for start of resources to be provided in response

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Requested number of resources to be provided in response

\n","type":"text/plain"},"key":"limit","value":""}],"variable":[]}},"response":[{"id":"cfea31a2-cab9-4b48-9011-d0b5a4c5c5f3","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"disabled":false,"description":{"content":"Actual number of items returned in the response body","type":"text/plain"},"key":"X-Result-Count","value":""},{"disabled":false,"description":{"content":"Total number of items matching criteria","type":"text/plain"},"key":"X-Total-Count","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"\",\n \"href\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"isBilled\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"appliedTax\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"bill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"characteristic\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"periodCoverage\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"product\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"id\": \"\",\n \"href\": \"\",\n \"date\": \"\",\n \"description\": \"\",\n \"isBilled\": \"\",\n \"name\": \"\",\n \"type\": \"\",\n \"appliedTax\": [\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"taxCategory\": \"\",\n \"taxRate\": \"\",\n \"taxAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"bill\": {\n \"id\": \"\",\n \"href\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"billingAccount\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"characteristic\": [\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n },\n {\n \"name\": \"\",\n \"value\": {},\n \"valueType\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n ],\n \"periodCoverage\": {\n \"endDateTime\": \"\",\n \"startDateTime\": \"\"\n },\n \"product\": {\n \"id\": \"\",\n \"href\": \"\",\n \"name\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\",\n \"@referredType\": \"\"\n },\n \"taxExcludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"taxIncludedAmount\": {\n \"unit\": \"\",\n \"value\": \"\"\n },\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n }\n]"},{"id":"1856c82a-b1cd-4946-8abe-f0e877b8c955","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"c8003d06-270b-451d-99f5-e2bd3b7ec955","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"5648b110-230b-4f93-b257-aee1a9de6bf0","name":"Forbidden","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"5f20813b-8e98-4253-994b-9a7a9b9c7002","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"af378fc8-2c7c-4242-ae1a-46ab4e56479d","name":"Method Not allowed","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"00fa4781-dffc-4108-994c-de988de6751b","name":"Conflict","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"fb77d4d4-1703-4f0b-b167-ee9a7f056393","name":"Internal Server Error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/appliedCustomerBillingRate?fields=&offset=&limit=","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["appliedCustomerBillingRate"],"query":[{"description":"Comma-separated properties to be provided in response","key":"fields","value":""},{"description":"Requested index for start of resources to be provided in response","key":"offset","value":""},{"description":"Requested number of resources to be provided in response","key":"limit","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"1cd042a6-9832-405b-bf72-4f68561aef1e"}],"id":"cc1ded55-cb6b-4d3f-848b-306a05c04d12","description":"

Diagram

\n\n\n

Example

\n
{\n  \"id\": \"ABR123\",\n  \"href\": \"http://server:port/api/appliedCustomerBillingRate/v4.0/ABR123\",\n  \"appliedBillingRateType\": \"monthly\",\n  \"date\": \"2020-01-19T13:38:18.938Z\",\n  \"description\": \"...some description...\",\n  \"isBilled\": true,\n  \"name\": \"...some meaningful name (maybe coming from catalogue?)...\",\n  \"appliedTax\": [\n    {\n      \"taxCategory\": \"VAT\",\n      \"taxRate\": 20,\n      \"taxAmount\": {\n        \"unit\": \"EUR\",\n        \"value\": 10.00\n      },\n      \"@type\": \"AppliedBillingTaxRate\",\n      \"@baseType\": \"AppliedBillingTaxRate\",\n      \"@schemaLocation\": \"...href...\"\n    }\n  ],\n  \"bill\": {\n    \"id\": \"B123\",\n    \"href\": \"http://server:port/api/bill/v4.0/B123\",\n    \"name\": \"customer bill\",\n    \"@referredType\": \"CustomerBill\",\n    \"@type\": \"CustomerBillRef\",\n    \"@baseType\": \"CustomerBillRef\",\n    \"@schemaLocation\": \"...href...\"\n  },\n  \"billingAccount\": {\n    \"id\": \"A0815\",\n    \"href\": \"http://server:port/api/billingAccount/v4.0/A0815\",\n    \"name\": \"BA Peter Retep\",\n    \"@referredType\": \"BillingAccount\",\n    \"@type\": \"BillingAccountRef\",\n    \"@baseType\": \"BillingAccountRef\",\n    \"@schemaLocation\": \"...href...\"\n  },\n  \"characteristic\": [\n    {\n      \"id\": \"string\",\n      \"name\": \"string\",\n      \"valueType\": \"string\",\n      \"characteristicRelationship\": [\n        {\n          \"id\": \"string\",\n          \"relationshipType\": \"string\",\n          \"@type\": \"CharacteristicRelationship\",\n          \"@baseType\": \"CharacteristicRelationship\",\n          \"@schemaLocation\": \"...href...\"\n        }\n      ],\n      \"@type\": \"Characteristic\",\n      \"@baseType\": \"Characteristic\",\n      \"@schemaLocation\": \"...href...\"\n    }\n  ],\n  \"periodCoverage\": {\n    \"endDateTime\": \"2019-12-31T23:59:59.999Z\",\n    \"startDateTime\": \"2019-12-01T00:00:00.000Z\"\n  },\n  \"product\": {\n    \"id\": \"P-wfs-123\",\n    \"href\": \"http://server:port/api/product/v4.0/P-wfs-123\",\n    \"name\": \"CSPs wonderful fiber service\",\n    \"@referredType\": \"Product\",\n    \"@type\": \"ProductRef\",\n    \"@baseType\": \"ProductRef\",\n    \"@schemaLocation\": \"...href...\"\n  },\n  \"taxExcludedAmount\": {\n    \"unit\": \"EUR\",\n    \"value\": 40.00\n  },\n  \"taxIncludedAmount\": {\n    \"unit\": \"EUR\",\n    \"value\": 50.00\n  },\n  \"@type\": \"AppliedCustomerBillingRate\",\n  \"@baseType\": \"AppliedCustomerBillingRate\",\n  \"@schemaLocation\": \"...href...\"\n}\n\n
\n","_postman_id":"cc1ded55-cb6b-4d3f-848b-306a05c04d12"},{"name":"hub","item":[{"name":"{id}","item":[{"name":"Unregister a listener","id":"1d079d82-0f83-4700-99e5-e66ac7fd7b63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","description":"

Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.

\n","urlObject":{"path":["hub",":id"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[],"variable":[{"id":"0f950957-a035-44ce-861d-af491c22ea43","description":{"content":"

(Required) The id of the registered listener

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"846a2de4-7185-4ad6-a53b-ae607b847538","name":"Deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"af399e9f-857c-4c98-a3e4-7caeb5bff31f","name":"Bad request","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"e5c8acc5-03ae-4eef-9eff-7304dc687eb0","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"63fbcb8e-1aab-4953-826c-74e8faf12885","name":"Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"5dbb54dc-2e97-4255-a81c-d7a774ffcd8b","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"d985b150-8ef5-406d-8918-4a7803f0f600","name":"Method not allowed","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"2a26569c-f7d4-4cb8-bec6-01c1ba84d22e","name":"Internal Server Error","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json;charset=utf-8"}],"url":{"raw":"https://serverRoot/tmf-api/customerBillManagement/v4/hub/:id","host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"path":["hub",":id"],"variable":[{"key":"id"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"1d079d82-0f83-4700-99e5-e66ac7fd7b63"}],"id":"2c7881ef-82c7-4a61-90d1-be578b6b08d2","_postman_id":"2c7881ef-82c7-4a61-90d1-be578b6b08d2","description":""},{"name":"Register a listener","id":"b9be6b5d-d739-49fb-8eb1-3a1b1cd59620","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub","description":"

Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.

\n","urlObject":{"path":["hub"],"host":["https://serverRoot/tmf-api/customerBillManagement/v4"],"query":[],"variable":[]}},"response":[{"id":"9dc5279c-2881-4298-9290-ea7d250f42b7","name":"Subscribed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"\",\n \"callback\": \"\",\n \"query\": \"\"\n}"},{"id":"f3a8e0ff-4c96-4097-8dc8-ab0fbb9d3bf9","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"bf0b4642-20ee-4529-b485-90131e60f381","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"0b766a9b-6c35-4eee-bd59-f2408c39c707","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"a0601c98-12e2-41a3-9ba0-54d2b8d98fee","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"295a4eae-7e23-4db1-aa1f-025d2d7f77b0","name":"Method Not allowed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Method Not Allowed","code":405,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"f9134f21-4598-4dec-a244-640bf1dc45bd","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"},{"id":"8644da46-83e9-4d65-81ab-3752c1a6fb10","name":"Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"},{"key":"Accept","value":"application/json;charset=utf-8"}],"body":{"mode":"raw","raw":"{\n \"callback\": \"\",\n \"query\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://serverRoot/tmf-api/customerBillManagement/v4/hub"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json;charset=utf-8"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"\",\n \"reason\": \"\",\n \"message\": \"\",\n \"status\": \"\",\n \"referenceError\": \"\",\n \"@baseType\": \"\",\n \"@schemaLocation\": \"\",\n \"@type\": \"\"\n}"}],"_postman_id":"b9be6b5d-d739-49fb-8eb1-3a1b1cd59620"}],"id":"f47fcc16-97f3-467d-9db8-192fb180d867","_postman_id":"f47fcc16-97f3-467d-9db8-192fb180d867","description":""}],"variable":[{"key":"baseUrl","value":"https://serverRoot/tmf-api/customerBillManagement/v4"}]}