If usageType is not specified, only currency balance adjustments are retrieved.", "required":false, "schema":{ "type":"string" } }, { "name":"status", "in":"query", "description":"Retrieves the adjustment with the specified item status. Use status=completed to retrieve closed currency balance adjustments or status=created to retrieve open currency balance adjustments.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The adjusted balances were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/AdjustBalance" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"adjustBalance-get", "x-filename-id":"adjustbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Adjusted Balances" ], "summary":"Create an Adjusted Balance", "description":"Creates an adjusted balance.", "operationId":"createAdjustBalance", "requestBody":{ "description":"The details describe the adjusted balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"The adjusted balance was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"adjustBalance", "x-internal-id":"adjustBalance-post", "x-filename-id":"adjustbalance-post" } }, "/adjustBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Adjusted Balances" ], "summary":"Get an Adjusted Balance by ID", "description":"Gets the specified adjusted balance.", "operationId":"retrieveAdjustBalance", "parameters":[ { "name":"id", "in":"path", "description":"The adjustment ID or adjustment number.", "examples":{ "adjustIdExample":{ "value":"0.0.0.1+-item-adjustment+216265", "summary":"id=0.0.0.1+-item-adjustment+216265" }, "adjustIdExample2":{ "value":"A1-19", "summary":"id=A1-19" } }, "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "adjustFieldsExample":{ "value":"description,amount", "summary":"fields=description,amount" } }, "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return. Use @type=AdjustBalance for a base object. Use @type=AdjustBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The adjusted balance was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"adjustBalance-{id}-get", "x-filename-id":"adjustbalance-id-get" } }, "/disputeBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Get a Disputed Balance by ID", "description":"Gets the specified disputed balance.", "operationId":"retrieveDisputeBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "disputeExample":{ "value":"amount,billItem", "summary":"fields=amount,billItem" } }, "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "required":true, "description":"The item dispute ID or item dispute number.", "examples":{ "disputeIdExample":{ "value":"0.0.0.1+-item-dispute+209114", "summary":"id=0.0.0.1+-item-dispute+209114" }, "disputeIdExample2":{ "value":"D1-85", "summary":"id=D1-85" } }, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return. Use @type=DisputeBalance for a base object. Use @type=DisputeBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The disputed balance was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-{id}-get", "x-filename-id":"disputebalance-id-get" } }, "/disputeBalance":{ "get":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Get Disputed Balances", "description":"Gets the disputed balances that match the specified query criteria.", "operationId":"listDisputeBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getDisputeTypeExample":{ "value":"amount,billItem", "summary":"fields=amount,billItem" } }, "required":false, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getDisputeLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getDisputeOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return. Use @type=DisputeBalance for a base object. Use @type=DisputeBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"Retrieves the dispute with the specified ID or dispute number.", "examples":{ "getDisputeIdExample":{ "value":"0.0.0.1+-item-dispute+209114", "summary":"id=0.0.0.1+-item-dispute+209114" } }, "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate", "in":"query", "description":"Retrieves disputes with a requestedDate that is equal to the specified date and time.", "examples":{ "getDisputeReqDateExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"requestedDate=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gte", "in":"query", "description":"Retrieves disputes with a requestedDate that is greater than or equal to the specified date and time.", "examples":{ "getDisputeReqDateGteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"requestedDate.gte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lte", "in":"query", "description":"Retrieves disputes with a requestedDate that is less than or equal to the specified date and time.", "examples":{ "getDisputeReqDateLteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"requestedDate.lte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gt", "in":"query", "description":"Retrieves disputes with a requestedDate that is greater than the specified date and time.", "examples":{ "getDisputeReqDateGtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"requestedDate.gt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lt", "in":"query", "description":"Retrieves disputes with a requestedDate that is less than the specified date and time.", "examples":{ "getDisputeReqDateLtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"requestedDate.lt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billItem.id", "in":"query", "description":"Retrieves disputes for the bill item with the specified bill item ID or bill item number.", "examples":{ "getDisputeBillItemIdExample":{ "value":"0.0.0.1+-item-cycle_forward+108813", "summary":"billItem.id=0.0.0.1+-item-cycle_forward+108813" }, "getDisputeBillItemIdExample2":{ "value":"B1-3,3", "summary":"billItem.id=B1-3,3" } }, "required":false, "schema":{ "type":"string" } }, { "name":"bill.id", "in":"query", "description":"Retrieves disputes for the bill with the specified bill item ID or bill number.", "examples":{ "getDisputeBillIdExample":{ "value":"0.0.0.1+-bill+105773", "summary":"bill.id=0.0.0.1+-bill+105773" }, "getDisputeBillIdExample2":{ "value":"Bill-123", "summary":"bill.id=Bill-123" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingCycleSpecification.id", "in":"query", "description":"Retrieves disputes for the billing cycle specification with the specified ID.", "examples":{ "getDisputeBillingCycleIdExample":{ "value":"0.0.0.1+-billinfo+107765", "summary":"billingCycleSpecification.id=0.0.0.1+-billinfo+107765" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billStructure.id", "in":"query", "description":"Retrieves disputes for bill structure with the specified ID.", "examples":{ "getDisputeBillStructureIdExample":{ "value":"0.0.0.1+-bill_structure+107765", "summary":"billStructure.id=0.0.0.1+-bill_structure+107765" }, "getDisputeBillStructureIdExample2":{ "value":"BillStructure-3-test", "summary":"billStructure.id=BillStructure-3-test" } } }, { "name":"status", "in":"query", "description":"Retrieves disputes by status.", "examples":{ "getDiputeStatusExample":{ "value":"Open", "summary":"status=Open" } }, "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate", "in":"query", "description":"Retrieves disputes with a confirmationDate that is equal to the specified date and time.", "examples":{ "getDisputeConfirmDateExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"confirmationDate=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.gte", "in":"query", "description":"Retrieves disputes with a confirmationDate that is greater than or equal to the specified date and time.", "examples":{ "getDisputeConfirmDateGteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"confirmationDate.gte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.lte", "in":"query", "description":"Retrieves disputes with a confirmationDate that is less than or equal to the specified date and time.", "examples":{ "getDisputeConfirmDateLteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"confirmationDate.lte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.gt", "in":"query", "description":"Retrieves disputes with a confirmationDate that is greater than the specified date and time.", "examples":{ "getDisputeConfirmGtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"confirmationDate.gt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.lt", "in":"query", "description":"Retrieves disputes with a confirmationDate that is less than the specified date and time.", "examples":{ "getDisputeConfirmDateLtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"confirmationDate.lt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billEvent.id", "in":"query", "description":"Retrieves disputes for the specified bill event.", "examples":{ "getDisputeBillEventIdExample":{ "value":"0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+323397156054607117", "summary":"billEvent.id=0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+323397156054607117" } }, "required":false, "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the disputes associated with the brm account ID, external account ID or account number.", "examples":{ "partyAccountIdExample":{ "value":"0.0.0.1-52207", "summary":"partyAccount.id=0.0.0.1-52207" }, "partyAccountIdExample2":{ "value":"0.0.0.1+-account+140598", "summary":"partyAccount.id=0.0.0.1+-account+140598" }, "partyAccountIdExample3":{ "value":"test_account_140598", "summary":"partyAccount.id=test_account_140598" } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The disputed balances were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-get", "x-filename-id":"disputebalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Create a Disputed Balance", "description":"Creates a disputed balance.", "operationId":"createDisputeBalance", "requestBody":{ "description":"The disputed balance to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DisputeBalance_CreateOracle" } } } }, "responses":{ "201":{ "description":"The disputed balance was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-post", "x-filename-id":"disputebalance-post" } }, "/accumulatedBalance":{ "get":{ "tags":[ "Prepay Balance Management/Accumulated Balances" ], "summary":"Get Accumulated Balances", "description":"Gets accumulated balances that match the query criteria.", "operationId":"listAccumulatedBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getAccumulateFieldsExample":{ "value":"totalBalance,bucket", "summary":"fields=totalBalance,bucket" } }, "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getAccumulateOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getAccumulateLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return. Use @type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"logicalResource.value", "description":"Retrieves accumulated balances associated with the specified login ID or device ID.", "example":"710-20211115-091333-0-27507--147359168-phx-111", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "description":"The internal account ID or external account ID.", "examples":{ "getAccumlateIdExample":{ "value":"0.0.0.1+-account+102879", "summary":"id=0.0.0.1+-account+102879" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the accumulated balance associated with the account external ID or account POID.", "examples":{ "getAccumulatedAccountIdExample":{ "value":"0.0.0.1+-account+102879", "summary":"partyAccount.id=0.0.0.1+-account+102879" }, "getAccumulatedAccountIdExample2":{ "value":"test_acc_14080", "summary":"partyAccount.id=test_acc_14080" } }, "schema":{ "type":"string" } }, { "name":"product.id", "in":"query", "description":"Retrieves the accumulated balances associated with the specified service POID, login ID or alias name.", "examples":{ "getAccumulatedProductIdExample":{ "value":"0.0.0.1+-service-telco-gsm-telephony+2081030", "summary":"product.id=0.0.0.1+-service-telco-gsm-telephony+2081030" }, "getAccumulatedProductIdExample2":{ "value":"aliasGSM_1101", "summary":"product.id=aliasGSM_1101" } }, "schema":{ "type":"string" } }, { "name":"billStructure.id", "in":"query", "required":false, "description":"Specifies the bill structure's ID to filter accumulated balances. Use @type=AccumulatedBalanceOracle for the extended response. When the request filters by billStructure.id, the response includes billStructure and sets billingCycleSpecification to null.", "schema":{ "type":"string" }, "examples":{ "billStructureExternalId":{ "value":"test_bill_structure_174268", "summary":"billStructure.id=test_bill_structure_174268" } } }, { "name":"billingCycleSpecification.id", "in":"query", "required":false, "description":"Specifies the billing cycle specification's POID to filter accumulated balances. Use @type=AccumulatedBalanceOracle for the extended response.", "schema":{ "type":"string" }, "example":"0.0.0.1+-billinfo+174685" } ], "responses":{ "200":{ "description":"The accumulated balances were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "anyOf":[ { "$ref":"#/components/schemas/AccumulatedBalance" }, { "$ref":"#/components/schemas/AccumulatedBalanceOracle" } ] } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"accumulatedBalance-get", "x-filename-id":"accumulatedbalance-get" } }, "/accumulatedBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Accumulated Balances" ], "summary":"Get an Accumulated Balance by ID", "description":"Gets the specified accumulated balance.", "operationId":"retrieveAccumulatedBalance", "parameters":[ { "name":"id", "in":"path", "description":"The internal account ID or external account ID of the account to get the accumulated balance for.", "examples":{ "accumulateIdExample":{ "value":"0.0.0.1+-account+102879", "summary":"id=0.0.0.1+-account+102879" } }, "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "accumlateFieldsExample":{ "value":"bucket,name", "summary":"fields=bucket,name" } }, "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return. Use type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The accumulated balance was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "anyOf":[ { "$ref":"#/components/schemas/AccumulatedBalance" }, { "$ref":"#/components/schemas/AccumulatedBalanceOracle" } ] } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"accumulatedBalance-{id}-get", "x-filename-id":"accumulatedbalance-id-get" } }, "/topupBalance":{ "get":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Get Top-up Balances", "description":"Gets top-up balances that match the query criteria.", "operationId":"listTopupBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"isAutoTopup,paymentMethod", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":10, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "schema":{ "type":"integer" } }, { "name":"id", "in":"query", "description":"Retrieves the specified top-up POID.", "example":"0.0.0.1+-topup+285083", "schema":{ "type":"string" } }, { "name":"product.id", "in":"query", "description":"Retrieves the top-up balance associated with the specified service ID, login ID or alias name.", "examples":{ "getTopupProductIdExample":{ "value":"0.0.0.1+-service-telco-gsm+67479", "summary":"product.id=0.0.0.1+-service-telco-gsm+67479" }, "getTopupProductIdExample2":{ "value":"aliasGSM_1101", "summary":"product.id=aliasGSM_1101" } }, "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the top-up balance associated with the account external ID or account POID.", "examples":{ "getTopupPartyAccountIdExample":{ "value":"0.0.0.1+-account+10966", "summary":"partyAccount.id=0.0.0.1+-account+10966" }, "getTopupPartyAccountIdExample2":{ "value":"test_acc_14080", "summary":"partyAccount.id=test_acc_14080" } }, "schema":{ "type":"string" } }, { "name":"bucket.id", "in":"query", "description":"Retrieves the top-up balance associated with the balance group POID.", "example":"0.0.0.1+-balance_group+71659", "schema":{ "type":"string" } }, { "name":"logicalResource.value", "in":"query", "description":"Retrieves the top-up balance associated with the login ID or device ID.", "example":"964-20210827-041409-0-9169--146802944-mum-54", "schema":{ "type":"string" } }, { "name":"isAutoTopup", "in":"query", "description":"The value indicates whether the request is for an automatic top up.", "example":true, "schema":{ "type":"boolean" } }, { "name":"numberOfPeriods", "in":"query", "description":"The number of periods to execute the recharge operation. If not included, the topup occurs every period.", "example":2, "schema":{ "type":"integer" } }, { "name":"recurringPeriod", "in":"query", "description":"The periodicity for the recharge operation, such as monthly, weekly, or daily.", "example":"daily", "schema":{ "type":"string" } }, { "name":"usageType", "in":"query", "description":"The type of underlying balance type, such as data or voice.", "example":"data", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The top-up balances were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TopupBalance" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TopupBalance", "x-internal-id":"topupBalance-get", "x-filename-id":"topupbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Create a Top-up Balance", "description":"Creates a top-up balance.", "operationId":"createTopupBalance", "requestBody":{ "description":"The top-up balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"The top-up balance was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"topupBalance", "x-internal-id":"topupBalance-post", "x-filename-id":"topupbalance-post" } }, "/topupBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Get a Top-up Balance by ID", "description":"Gets the specified top-up balance.", "operationId":"retrieveTopupBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the top-up balance to get.", "example":"0.0.0.1+-topup+6442543", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,partyAccount", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The top-up balance was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TopupBalance", "x-internal-id":"topupBalance-{id}-get", "x-filename-id":"topupbalance-id-get" }, "delete":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Delete a Top-up Balance", "description":"Deletes a top-up balance.", "operationId":"deleteTopupBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the top-up balance to delete.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The specified top-up balance was deleted successfully.", "content":{ } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TopupBalance", "x-internal-id":"topupBalance-{id}-delete", "x-filename-id":"topupbalance-id-delete" }, "patch":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Update a Top-up Balance", "description":"Updates the specified top-up balance.", "operationId":"patchTopupBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the top-up balance to update.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"The details of the top-up balance to update.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance_Update" } } }, "required":true }, "responses":{ "200":{ "description":"The top-up balance was updated successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"topupBalance-{id}-patch", "x-filename-id":"topupbalance-id-patch" } }, "/transferBalance":{ "get":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Get Transfer Balances", "description":"Gets transfer balances that match the query criteria.", "operationId":"listTransferBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"channel,costOwner", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":10, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "schema":{ "type":"integer" } }, { "name":"id", "in":"query", "description":"The unique identifier within the server for the balance retrieval operation request.", "example":"0.0.0.1+-event-audit-transfer_balance+332070103776495457", "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the transfer balances made on the specified account ID or external ID.", "examples":{ "getTransferPartyAccountIdExample":{ "value":"0.0.0.1+-account+497826", "summary":"partyAccount.id=0.0.0.1+-account+497826" }, "getTransferPartyAccountIdExample2":{ "value":"test_acc_14080", "summary":"partyAccount.id=test_acc_14080" } }, "schema":{ "type":"string" } }, { "name":"product.id", "in":"query", "description":"Retrieves the transfer balances associated with the specified service POID, login ID or alias name.", "examples":{ "getTransferProductIdExample":{ "value":"0.0.0.1+-service-telco-gsm-telephony+2081030", "summary":"product.id=0.0.0.1+-service-telco-gsm-telephony+2081030" }, "getTransferProductIdExample2":{ "value":"aliasGSM_1101", "summary":"product.id=aliasGSM_1101" } }, "schema":{ "type":"string" } }, { "name":"bucket.id", "in":"query", "description":"Retrieves the transfer balances associated with the specified balance group.", "example":"0.0.0.1+-balance_group+451355+978+0", "schema":{ "type":"string" } }, { "name":"logicalResource.value", "in":"query", "description":"Retrieves the transfer balances associated with the specified login ID or device ID.", "example":"964-20210827-041409-0-9169--146802944-mum-54", "schema":{ "type":"string" } }, { "name":"receiverLogicalResource.value", "in":"query", "description":"Retrieves the transfer balances received by the specified logical resource.", "example":"729-20210525-024957-3-2326--147199296-mum-10", "schema":{ "type":"string" } }, { "name":"receiverProduct.id", "in":"query", "description":"Retrieves the transfer balances received by the specified service ID, login ID or alias name.", "examples":{ "getTransferReceiverProductIdExample":{ "value":"0.0.0.1+-service-telco-gsm-telephony+2092746", "summary":"receiverProduct.id=0.0.0.1+-service-telco-gsm-telephony+2092746" }, "getTransferReceiverProductIdExample2":{ "value":"aliasGSM_1101", "summary":"receiverProduct.id=aliasGSM_1101" } }, "schema":{ "type":"string" } }, { "name":"receiverBucket.id", "in":"query", "description":"Retrieves the transfer balances received by the specified balance group.", "example":"0.0.0.1+-balance_group+2185786+840+0", "schema":{ "type":"string" } }, { "name":"receiverPartyAccount.id", "in":"query", "description":"Retrieves the transfer balances associated with the specified receiver account ID or external ID.", "examples":{ "getTransferReceiverPartyAccountIdExample":{ "value":"0.0.0.1+-account+2090314", "summary":"receiverPartyAccount.id=0.0.0.1+-account+2090314" }, "getTransferReceiverPartyAccountIdExample2":{ "value":"test_acc_14080", "summary":"receiverPartyAccount.id=test_acc_14080" } }, "schema":{ "type":"string" } }, { "name":"costOwner", "in":"query", "description":"Retrieves the transfer balances associated with the party responsible for the transfer costs: originator or receiver.", "example":"receiver", "schema":{ "type":"string" } }, { "name":"usageType", "in":"query", "description":"Retrieves the transfer balances associated with the specified usage type, such as data, voice, monetary, or other.", "example":"monetary", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The transfer balances were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransferBalance" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TransferBalance", "x-internal-id":"transferBalance-get", "x-filename-id":"transferbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Create a Transfer Balance", "description":"Creates a transfer balance.", "operationId":"createTransferBalance", "requestBody":{ "description":"The transfer balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"The transfer balance was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"transferBalance", "x-internal-id":"transferBalance-post", "x-filename-id":"transferbalance-post" } }, "/transferBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Get a Transfer Balance by ID", "description":"Gets the specified transfer balance.", "operationId":"retrieveTransferBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the transfer balance to get.", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"requestor,requestedDate", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The transfer balance was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TransferBalance", "x-internal-id":"transferBalance-{id}-get", "x-filename-id":"transferbalance-id-get" } }, "/balanceAction":{ "get":{ "tags":[ "Prepay Balance Management/Balance Actions" ], "summary":"Get Balance Actions", "description":"Gets balance actions that match the query criteria.", "operationId":"listBalanceAction", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,usageType", "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":10, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return: TransferBalance, TopupBalance, AdjustBalance, or AdjustBalanceOracle (for an extended object).", "example":"TransferBalance", "required":true, "in":"query", "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the balance action associated with the brm account ID, external account ID or account number.", "examples":{ "partyAccountIdExample":{ "value":"0.0.0.1-52207", "summary":"partyAccount.id=0.0.0.1-52207" }, "partyAccountIdExample2":{ "value":"0.0.0.1+-account+140598", "summary":"partyAccount.id=0.0.0.1+-account+140598" }, "partyAccountIdExample3":{ "value":"test_account_140598", "summary":"partyAccount.id=test_account_140598" } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The balance actions were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/BalanceAction" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"balanceAction-get", "x-filename-id":"balanceaction-get" } }, "/balanceAction/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Balance Actions" ], "summary":"Get a Balance Action by ID", "description":"Gets the specified balance action.", "operationId":"retrieveBalanceAction", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the balance action to get.", "example":"0.0.0.1+-event-audit-transfer_balance+3213212", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,usageType", "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return: TransferBalance, TopupBalance, AdjustBalance, or AdjustBalanceOracle (for an extended object).", "example":"TransferBalance", "required":true, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The specified balance action was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/BalanceAction" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"balanceAction-{id}-get", "x-filename-id":"balanceaction-id-get" } }, "/bucket/adjustThreshold/{accountId}":{ "put":{ "tags":[ "Prepay Balance Management/Bucket Balances" ], "summary":"Update a Bucket Threshold for an Account", "description":"Updates a bucket threshold for the specified account.", "operationId":"updateAdjustThreshold", "parameters":[ { "name":"accountId", "in":"path", "description":"The ID or account number of the billing account to adjust the threshold for.", "examples":{ "adjustThresholdExample":{ "value":"0.0.0.1+-account+102879", "summary":"accountId=0.0.0.1+-account+102879" } }, "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"The thresholds to be adjusted.
To adjust thresholds, you can specify either a product ID or bucket ID. If you specify both, the thresholds for the bucket will be adjusted. If you specify neither, the default balance group for the account will be used.
You must specify the resource type and provide values for all existing thresholds. Any new thresholds included in the request will be added. Any existing thresholds that are not included in the update request will be removed. For example, if there are three thresholds set for a bucket, but you only list two in the request, the third will be removed.
To remove all thresholds, include an empty thresholds array: [ ].", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustThreshold" } } }, "required":true }, "responses":{ "200":{ "description":"The bucket threshold was updated successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bucket-adjustThreshold-{accountId}-put", "x-filename-id":"bucket-adjustthreshold-accountid-put" } }, "/brm/paymentMethods/v4/paymentMethod":{ "get":{ "operationId":"listPaymentMethod_v4", "summary":"Get Payment Methods", "description":"The operation lists payment methods or finds payment methods that match the specified criteria.", "tags":[ "Payment Method Management/v4" ], "responses":{ "200":{ "description":"The payment methods were retrieved successfully.", "headers":{ "X-Result-Count":{ "description":"Specifies the actual number of items in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"Specifies the total number of items that match the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Cash" }, { "$ref":"#/components/schemas/Check" }, { "$ref":"#/components/schemas/BankAccountDebit" }, { "$ref":"#/components/schemas/BankCard" }, { "$ref":"#/components/schemas/TokenizedCard" } ] } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "parameters":[ { "name":"fields", "description":"Specifies the properties to include in the response as a comma-separated list.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"offset", "description":"Specifies the starting index of the resources to include in the response.", "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"limit", "description":"Specifies the number of resources to include in the response.", "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"id", "description":"Specifies the payment method's ID.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"account.id", "description":"Specifies an account's ID when the account links to the payment method.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"@type", "description":"Specifies the payment method's subtype.", "required":false, "in":"query", "schema":{ "type":"string", "enum":[ "cash", "check", "bankAccountDebit", "bankCard", "tokenizedCard" ] } }, { "name":"name", "description":"Specifies the payment method's friendly name.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"status", "description":"Specifies the payment method's status.", "required":false, "in":"query", "schema":{ "type":"string", "enum":[ "active", "inactive" ] } }, { "name":"cardType", "description":"Specifies the bank card's type.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"cardNumber", "description":"Specifies the bank card's number.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"nameOnCard", "description":"Specifies the name on the bank card.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"accountNumber", "description":"Specifies the bank account's number.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"BIC", "description":"Specifies the financial institution's Business Identifier Code.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"city", "description":"Specifies the city in the payment method's address.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"street", "description":"Specifies the payment method's street address.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"stateOrProvince", "description":"Specifies the state or province in the payment method's address.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"postCode", "description":"Specifies the postal code in the payment method's address.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"country", "description":"Specifies the country in the payment method's address.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"validFor.startDateTime.gte", "description":"Specifies the inclusive minimum date for the payment method's validity start date.", "required":false, "in":"query", "schema":{ "type":"string", "format":"date-time" } }, { "name":"validFor.startDateTime.lte", "description":"Specifies the inclusive maximum date for the payment method's validity start date.", "required":false, "in":"query", "schema":{ "type":"string", "format":"date-time" } }, { "name":"sort", "description":"Specifies the fields to sort as a comma-separated list. Prefix a field with '-' for descending order.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "x-internal-id":"brm-paymentMethods-v4-paymentMethod-get", "x-filename-id":"brm-paymentmethods-v4-paymentmethod-get" }, "post":{ "operationId":"createPaymentMethod_v4", "summary":"Create a Payment Method", "description":"The operation creates a payment method.", "tags":[ "Payment Method Management/v4" ], "responses":{ "201":{ "description":"The payment method was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Cash" }, { "$ref":"#/components/schemas/Check" }, { "$ref":"#/components/schemas/BankAccountDebit" }, { "$ref":"#/components/schemas/BankCard" }, { "$ref":"#/components/schemas/TokenizedCard" } ] } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "requestBody":{ "required":true, "description":"The payment method to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Cash" }, { "$ref":"#/components/schemas/Check" }, { "$ref":"#/components/schemas/BankAccountDebit" }, { "$ref":"#/components/schemas/BankCard" }, { "$ref":"#/components/schemas/TokenizedCard" } ] } } } }, "x-internal-id":"brm-paymentMethods-v4-paymentMethod-post", "x-filename-id":"brm-paymentmethods-v4-paymentmethod-post" } }, "/brm/paymentMethods/v4/paymentMethod/{id}":{ "get":{ "operationId":"retrievePaymentMethod_v4", "summary":"Get a Payment Method by ID", "description":"The operation retrieves a payment method by its ID. You can select any of the payment method's top-level attributes.", "tags":[ "Payment Method Management/v4" ], "responses":{ "200":{ "description":"The payment method was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Cash" }, { "$ref":"#/components/schemas/Check" }, { "$ref":"#/components/schemas/BankAccountDebit" }, { "$ref":"#/components/schemas/BankCard" }, { "$ref":"#/components/schemas/TokenizedCard" } ] } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "parameters":[ { "name":"id", "description":"Specifies the payment method's ID.", "required":true, "schema":{ "type":"string" }, "in":"path" }, { "name":"fields", "description":"Specifies the properties to include in the response as a comma-separated list.", "required":false, "schema":{ "type":"string" }, "in":"query" } ], "x-internal-id":"brm-paymentMethods-v4-paymentMethod-{id}-get", "x-filename-id":"brm-paymentmethods-v4-paymentmethod-id-get" }, "patch":{ "operationId":"patchPaymentMethod_v4", "summary":"Partially Update a Payment Method by ID", "description":"The operation partially updates a payment method.", "tags":[ "Payment Method Management/v4" ], "responses":{ "200":{ "description":"The payment method was updated successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Cash" }, { "$ref":"#/components/schemas/Check" }, { "$ref":"#/components/schemas/BankAccountDebit" }, { "$ref":"#/components/schemas/BankCard" }, { "$ref":"#/components/schemas/TokenizedCard" } ] } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "parameters":[ { "name":"id", "description":"Specifies the payment method's ID.", "required":true, "schema":{ "type":"string" }, "in":"path" } ], "requestBody":{ "required":true, "description":"The payment method to update.", "content":{ "application/json;charset=utf-8":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Cash_Update" }, { "$ref":"#/components/schemas/Check_Update" }, { "$ref":"#/components/schemas/BankAccountDebit_Update" }, { "$ref":"#/components/schemas/BankCard_Update" }, { "$ref":"#/components/schemas/TokenizedCard_Update" } ] } } } }, "x-internal-id":"brm-paymentMethods-v4-paymentMethod-{id}-patch", "x-filename-id":"brm-paymentmethods-v4-paymentmethod-id-patch" }, "delete":{ "operationId":"deletePaymentMethod_v4", "summary":"Delete a Payment Method", "description":"The operation deletes a payment method.", "tags":[ "Payment Method Management/v4" ], "responses":{ "204":{ "description":"The payment method was deleted successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "parameters":[ { "name":"id", "description":"Specifies the payment method's ID.", "required":true, "schema":{ "type":"string" }, "in":"path" } ], "x-internal-id":"brm-paymentMethods-v4-paymentMethod-{id}-delete", "x-filename-id":"brm-paymentmethods-v4-paymentmethod-id-delete" } }, "/customerBillOnDemand":{ "post":{ "operationId":"createCustomerBillOnDemand", "summary":"Create a Customer Bill On Demand", "description":"Creates a customer bill on demand.", "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "requestBody":{ "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBillOnDemand_Create" } } }, "description":"The bill to create.", "required":true }, "responses":{ "201":{ "description":"The customer bill was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBillOnDemand" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system has encountered an internal server error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-post", "x-filename-id":"customerbillondemand-post" }, "get":{ "operationId":"listCustomerBillOnDemand", "summary":"Get On-Demand Customer Bills", "description":"Gets the on-demand customer bills that match the query criteria.", "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "parameters":[ { "name":"offset", "description":"The number of results to offset the response by.", "examples":{ "getCustomerBillOnDemandOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"limit", "description":"The maximum number of results to return.", "examples":{ "getCustomerBillOnDemandLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "getCustomerBillOnDemandTypeExample":{ "value":"CustomerBillOnDemand", "summary":"Use @type=CustomerBillOnDemand for a base object" }, "getCustomerBillOnDemandTypeExample2":{ "value":"CustomerBillOnDemandOracle", "summary":"Use @type=CustomerBillOnDemandOracle for an extended object" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"Retrieves the on-demand customer bill for the specified bill ID or bill number.", "examples":{ "getCustomerBillOnDemandIdExample":{ "value":"0.0.0.1+-bill+106861", "summary":"id=0.0.0.1+-bill+106861" }, "getCustomerBillOnDemandIdExample99":{ "value":"B1-123", "summary":"id=B1-123" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves the on-demand customer bills for the specified account ID or account number.", "examples":{ "getCustomerBillOnDemandAccIdExample":{ "value":"0.0.0.1+-account+107117", "summary":"billingAccount.id=0.0.0.1+-account+107117" }, "getCustomerBillOnDemandAccIdExample2":{ "value":"Account-77961", "summary":"billingAccount.id=Account-77961" } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The on-demand customer bill was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomerBillOnDemand" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-get", "x-filename-id":"customerbillondemand-get" } }, "/customerBillOnDemand/{id}":{ "get":{ "operationId":"retrieveCustomerBillOnDemand", "summary":"Get an On-Demand Customer Bill by ID", "description":"Gets the specified on-demand customer bill.", "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "parameters":[ { "name":"id", "description":"The bill number or ID of the on-demand customer bill to get.", "examples":{ "customerBillOnDemandIdExample":{ "value":"0.0.0.1+-bill+106861", "summary":"id=0.0.0.1+-bill+106861" }, "customerBillOnDemandIdExample2":{ "value":"B1-123", "summary":"id=B1-123" } }, "required":true, "in":"path", "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "customerBillOndemandTyoeExample":{ "value":"CustomerBillOnDemand", "summary":"Use @type=CustomerBillOnDemand for a base object" }, "customerBillOndemandTyoeExample2":{ "value":"CustomerBillOnDemandOracle", "summary":"Use @type=CustomerBillOnDemandOracle for an extended object." } }, "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The on-demand customer bill was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "description":"An on-demand customer bill.", "$ref":"#/components/schemas/CustomerBillOnDemand" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-{id}-get", "x-filename-id":"customerbillondemand-id-get" } }, "/customerBill":{ "get":{ "operationId":"listCustomerBill", "summary":"Get Customer Bills", "description":"Gets the customer bills that match the query criteria.", "tags":[ "Customer Bill Management/Customer Bill" ], "parameters":[ { "name":"fields", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getCustomerBillFieldsExample":{ "value":"runType,amountDue", "summary":"fields=runType,amountDue" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"offset", "description":"The number of results to offset the response by.", "examples":{ "getCustomerBillOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"limit", "description":"The maximum number of results to return.", "examples":{ "getCustomerBillLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "getCustomerBillTypeExample":{ "value":"CustomerBill", "summary":"Use @type=CustomerBill for a base object" }, "getCustomerBillTypeExample2":{ "value":"CustomerBillOracle", "summary":"Use @type=CustomerBillOracle for an extended object" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"Retrieves customer bills for the specified bill ID.", "examples":{ "getCustomerBillIdExample":{ "value":"0.0.0.1+-bill+106861", "summary":"id=0.0.0.1+-bill+106861" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves customer bills for the specified account ID or account number.", "examples":{ "getCustomerBillAccIdExample":{ "value":"0.0.0.1+-account+107117", "summary":"billingAccount.id=0.0.0.1+-account+107117" }, "getCustomerBillAccIdExample2":{ "value":"0.0.0.1+-account+107117", "summary":"billingAccount.id=Account-123" } }, "required":false, "schema":{ "type":"string" } }, { "name":"state", "in":"query", "description":"The state of the bill, such as new, partiallyPaid, settled, or inProgress.", "examples":{ "getCustomerBillStateExample":{ "value":"inProgress", "summary":"state=inProgress" } }, "required":false, "schema":{ "type":"string", "enum":[ "new", "partiallyPaid", "settled", "inProgress" ] } }, { "name":"billNo", "in":"query", "description":"Retrieves customer bills by bill number. To retrieve the bills that are in progress, enter bill in progress all lowercase.", "examples":{ "getCustomerBillNoExample":{ "value":"B1-28", "summary":"billNo=B1-28" }, "getCustomerBillNoExample2":{ "value":"bill in progress", "summary":"billNo=bill in progress" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billNo.like", "in":"query", "description":"Retrieves customer bills that match the specified bill number. Use the URL-encoded wild-card character %25 to replace one or more characters.", "examples":{ "getCustomerBillNoLikeExample":{ "value":"B1-28%25", "summary":"billNo.like=B1-28%25" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.startDateTime", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that matches the specified dateTime.", "examples":{ "getCustomerBillStartDExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.startDateTime=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.startDateTime.gte", "in":"query", "description":"Retrieves the customer bills with a billing period start date that is greater than or equal to the specified dateTime.", "examples":{ "getCustomerBillStartDGteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.startDateTime.gte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.startDateTime.lte", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is less than or equal to the specified dateTime.", "examples":{ "getCustomerBillStartDLTEExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.startDateTime.lte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.startDateTime.gt", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is greater than the specified dateTime.", "examples":{ "getCustomerBillStartDateGTExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.startDateTime.gt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.startDateTime.lt", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is less than the specified dateTime.", "examples":{ "getCustomerBillStartDateLtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.startDateTime.lt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.endDateTime", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that matches the specified dateTime.", "examples":{ "getCustomerBillEndDExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.endDateTime=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.endDateTime.gte", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is greater than or equal to the specified dateTime.", "examples":{ "getCustomerBillEndDGteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.endDateTime.gte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.endDateTime.lte", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is less than or equal to the specified dateTime.", "examples":{ "getCustomerBillEndDateLTEExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.endDateTime.lte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.endDateTime.gt", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is greater than the specified dateTime.", "examples":{ "getCustomerBillEndDateGtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.endDateTime.gt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingPeriod.endDateTime.lt", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is less than the specified dateTime.", "examples":{ "getCustomerBillEndDateLtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billingPeriod.endDateTime.lt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"remainingAmount.value", "in":"query", "description":"Retrieves the customer bills with a remaining amount that matches the specified value.", "examples":{ "getCustomerBillReAmountExample":{ "value":30, "summary":"remainingAmount.value=30" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"remainingAmount.value.gte", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is greater than or equal to the specified value.", "examples":{ "getCustomerBillReAmountGteExample":{ "value":30, "summary":"remainingAmount.value.gte=30" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"remainingAmount.value.lte", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is less than or equal to the specified value.", "examples":{ "getCustomerBillReAMountLteExample":{ "value":30, "summary":"remainingAmount.value.lte=30" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"remainingAmount.value.gt", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is greater than the specified value.", "examples":{ "getCustomerBillReAmountGtExample":{ "value":30, "summary":"remainingAmount.value.gt=30" } }, "required":false, "schema":{ "type":"string" } }, { "name":"remainingAmount.value.lt", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is less than the specified value.", "examples":{ "getCustomerBillReAmountLtExample":{ "value":30, "summary":"remainingAmount.value.lt=30" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"remainingAmount.value.like", "in":"query", "description":"Retrieves the customer bills with a wild card in the remaining amount value. Use the URL-encoded wild-card character %25 to replace one or more characters.", "examples":{ "getCustomerBillReAmountLikeExample":{ "value":"3%25", "summary":"remainingAmount.value.like=3%25" } }, "required":false, "schema":{ "type":"string" } }, { "name":"amountDue.value", "in":"query", "description":"Retrieves the customer bills with an amount due that matches the specified value.", "examples":{ "getCustomerBillAmountExample":{ "value":20, "summary":"amountDue.value=20" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"amountDue.value.gte", "in":"query", "description":"Retrieves the customer bills with an amount due that is greater than or equal to the specified value.", "examples":{ "getCustomerBillAmountDueGtExample":{ "value":20, "summary":"amountDue.value.gte=20" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"amountDue.value.lte", "in":"query", "description":"Retrieves the customer bills with an amount due that is less than or equal to the specified value.", "examples":{ "getCustomerBillAmountDueLteExample":{ "value":20, "summary":"amountDue.value.lte=20" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"amountDue.value.gt", "in":"query", "description":"Retrieves the customer bills with an amount due that is greater than the specified value.", "examples":{ "getCustomerBillAmountDueGtExample":{ "value":20, "summary":"amountDue.value.gt=20" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"amountDue.value.lt", "in":"query", "description":"Retrieves the customer bills with an amount due value that is less than the specified value.", "examples":{ "getCustomerBillAmountDueExample":{ "value":20, "summary":"amountDue.value.lt=20" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"billDate", "in":"query", "description":"Retrieves the customer bills with a billDate that matches the specified dateTime.", "examples":{ "getCustomerBillBDateExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billDate=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billDate.gte", "in":"query", "description":"Retrieves the customer bills with a billDate that is greater than or equal to the specified dateTime.", "examples":{ "getCustomerBillBDateGteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billDate.gte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billDate.lte", "in":"query", "description":"Retrieves the customer bills with a billDate that is less than or equal to the specified dateTime.", "examples":{ "getCustomerBillBDateLteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billDate.lte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billDate.gt", "in":"query", "description":"Retrieves the customer bills with a billDate that is greater than the specified dateTime.", "examples":{ "getCustomerBillBDateGtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billDate.gt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billDate.lt", "in":"query", "description":"Retrieves the customer bills with a billDate that is less than the specified dateTime.", "examples":{ "getCustomerBillBDateLtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"billDate.lt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDueDate", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that matches the specified dateTime.", "examples":{ "getCustomerBillPaymentDueDateExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"paymentDueDate=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDueDate.gte", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is greater than or equal to the specified dateTime.", "examples":{ "getCustomerBillPaymentDueDateGteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"paymentDueDate.gte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDueDate.lte", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is less than or equal to the specified dateTime.", "examples":{ "getCustomerBillPaymentDueDateLteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"paymentDueDate.lte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDueDate.gt", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is greater than the specified dateTime.", "examples":{ "getCustomerBillPaymentDueDateGTExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"paymentDueDate.gt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDueDate.lt", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is less than the specified dateTime.", "examples":{ "getCustomerBillPaymentDueDateLTExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"paymentDueDate.lt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"lastUpdate", "in":"query", "description":"Retrieves the customer bills whose lastUpdate matches the specified dateTime.", "examples":{ "getCustomerBillLastUpdateExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"lastUpdate=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"lastUpdate.gte", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is less than the specified dateTime.", "examples":{ "getCustomerBillLastUpdateGteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"lastUpdate.gte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"lastUpdate.lte", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is less than or equal to the specified dateTime.", "examples":{ "getCustomerBillLastUpdateLteExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"lastUpdate.lte=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"lastUpdate.gt", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is greater than the specified dateTime.", "examples":{ "getCustomerBillLastUpdateGtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"lastUpdate.gt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"lastUpdate.lt", "in":"query", "description":"Retrieves customer bills whose lastUpdate is less than the specified dateTime.", "examples":{ "getCustomerBillLastUpdateLtExample":{ "value":"2020-01-01T12:00:27.000Z", "summary":"lastUpdate.lt=2020-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The customer bills were retrieved successfully.", "headers":{ "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomerBill" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-get", "x-filename-id":"customerbill-get" } }, "/customerBill/{id}":{ "get":{ "operationId":"retrieveCustomerBill", "summary":"Get a Customer Bill by ID", "description":"Gets the specified customer bill.", "tags":[ "Customer Bill Management/Customer Bill" ], "parameters":[ { "name":"id", "description":"The ID or bill number of the customer bill to retrieve.", "examples":{ "customerBillIdExample":{ "value":"0.0.0.1+-bill+106861", "summary":"id=0.0.0.1+-bill+106861" }, "customerBillIdExample2":{ "value":"Bill-1234", "summary":"id=Bill-1234" } }, "required":true, "in":"path", "schema":{ "type":"string" } }, { "name":"fields", "description":"The list of comma-separated fields to return in the response.", "examples":{ "customerBillFieldsExample":{ "value":"billDate,paymentDueDate", "summary":"fields=billDate,paymentDueDate" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "customerBillTypeExample":{ "value":"CustomerBill", "summary":"Use @type=CustomerBill for a base object" }, "customerBillTypeExample2":{ "value":"CustomerBillOracle", "summary":"Use @type=CustomerBillOracle for an extended object" } }, "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The customer's bill was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "description":"A customer bill.", "$ref":"#/components/schemas/CustomerBill" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-{id}-get", "x-filename-id":"customerbill-id-get" }, "patch":{ "operationId":"patchCustomerBill", "summary":"Update a Customer Bill", "description":"Updates a customer bill. You can update the value of the bill's state property from InProgress to OnHold, or from OnHold to InProgress.", "tags":[ "Customer Bill Management/Customer Bill" ], "parameters":[ { "name":"id", "description":"The bill number or ID of the customer bill to update.", "required":true, "in":"path", "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBill_Update" } } }, "description":"The customer bill to be updated.", "required":true }, "responses":{ "200":{ "description":"The customer bill was updated successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBill" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-{id}-patch", "x-filename-id":"customerbill-id-patch" } }, "/invoice/{id}":{ "get":{ "operationId":"retrieveCustomerBillInvoice", "summary":"Get an Invoice PDF by Bill ID", "description":"Displays the invoice statement PDF for the specified bill ID.", "tags":[ "Customer Bill Management/Customer Bill Invoice" ], "parameters":[ { "name":"id", "in":"path", "required":true, "description":"The bill number or bill ID associated with the invoice PDF to retrieve.", "examples":{ "invoiceIdExample":{ "value":"0.0.0.1+-bill+106861", "summary":"id=0.0.0.1+-bill+106861" }, "invoiceIdExample2":{ "value":"B1-2", "summary":"id=B1-2" } }, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The invoice PDF for the specified bill ID was retrieved successfully.", "content":{ "application/pdf":{ "schema":{ "type":"string", "format":"binary", "description":"An PDF invoice for a bill." } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"invoice-{id}-get", "x-filename-id":"invoice-id-get" } }, "/appliedCustomerBillingRate":{ "get":{ "operationId":"listAppliedCustomerBillingRate", "summary":"Get Applied Customer Billing Rates", "description":"Gets the applied customer billing rates that match the query criteria.", "tags":[ "Customer Bill Management/Applied Customer Billing Rate" ], "parameters":[ { "name":"fields", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getAppliedFieldsExample":{ "value":"bill,billingAccount", "summary":"fields=bill,billingAccount" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"offset", "description":"The number of results to offset the response by.", "examples":{ "getAppliedOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"limit", "description":"The maximum number of results to return.", "examples":{ "getAppliedLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "getAppliedExample":{ "value":"AppliedCustomerBillingRate", "summary":"Use @type=AppliedCustomerBillingRate for a base object. Use @type=AppliedCustomerBillingRateOracle for an extended object." } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"The ID of the applied customer billing rate to get.", "examples":{ "getAppliedIdExample":{ "value":"0.0.0.1+-item-usage+1", "summary":"id=0.0.0.1+-item-usage+1" } }, "required":false, "schema":{ "type":"string" } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves the applied customer billing rates for the specified account ID or account number.", "examples":{ "getCustomerBillOnDemandAccIdExample":{ "value":"0.0.0.1+-account+107117", "summary":"billingAccount.id=0.0.0.1+-account+107117" }, "getCustomerBillOnDemandAccIdExample2":{ "value":"Account-19876", "summary":"billingAccount.id=Account-19876" } }, "required":false, "schema":{ "type":"string" } }, { "name":"bill.id", "in":"query", "description":"Retrieves the applied customer billing rates for the specified billId or billNumber.", "examples":{ "getAppliedBillIdExample":{ "value":"0.0.0.1+-bill+1", "summary":"bill.id=0.0.0.1+-bill+1" }, "getAppliedBillIdExample2":{ "value":"B1-10", "summary":"bill.id=B1-10" } }, "required":false, "schema":{ "type":"string" } }, { "name":"isBilled", "in":"query", "description":"Retrieves applied customer billing rates with the specified status.", "examples":{ "getAppliedIsBilledExample":{ "value":true, "summary":"Use isBilled=true to retrieve open and closed applied customer billing rates." }, "getAppliedIsBilledExample2":{ "value":false, "summary":"Use isBilled=false to retrieve pending applied customer billing rates." } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The applied customer billing rates were retrieved successfully.", "headers":{ "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "description":"The applied customer billing rates that matched the search criteria.", "items":{ "$ref":"#/components/schemas/AppliedCustomerBillingRate" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"appliedCustomerBillingRate-get", "x-filename-id":"appliedcustomerbillingrate-get" } }, "/appliedCustomerBillingRate/{id}":{ "get":{ "operationId":"retrieveAppliedCustomerBillingRate", "summary":"Get an Applied Customer Billing Rate by ID", "description":"Gets the specified applied customer billing rate.", "tags":[ "Customer Bill Management/Applied Customer Billing Rate" ], "parameters":[ { "name":"id", "description":"The item number or the ID of the item to get.", "examples":{ "appliedIdExample":{ "value":"0.0.0.1+-item-usage+1", "summary":"id=0.0.0.1+-item-usage+1" }, "appliedIdExample2":{ "value":"Item-9876", "summary":"id=Item-9876" } }, "required":true, "in":"path", "schema":{ "type":"string" } }, { "name":"fields", "description":"The list of comma-separated fields to return in the response.", "required":false, "examples":{ "appliedFieldsExample":{ "value":"isBilled,name", "summary":"fields=isBilled,name" } }, "in":"query", "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "examples":{ "appliedTypeExample":{ "value":"AppliedCustomerBillingRate", "summary":"Use @type=AppliedCustomerBillingRate for a base object" }, "appliedTypeExample21":{ "value":"AppliedCustomerBillingRateOracle", "summary":"Use @type=AppliedCustomerBillingRateOracle for an extended object" } }, "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The specified applied customer billing rate was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "description":"The applied customer billing rate that matched the search criteria.", "$ref":"#/components/schemas/AppliedCustomerBillingRate" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"appliedCustomerBillingRate-{id}-get", "x-filename-id":"appliedcustomerbillingrate-id-get" } }, "/usage":{ "get":{ "operationId":"listUsage", "summary":"Get Usage", "description":"The operation lists or finds Usage entities.", "tags":[ "Usage Management" ], "parameters":[ { "name":"offset", "description":"The requested index specifies the first resource to include in the response.", "example":2, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"limit", "description":"The requested number of resources to include in the response.", "example":2, "required":false, "in":"query", "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of Usage to return.", "example":"Usage", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"@baseType", "description":"The base type of Usage to return.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"@schemaLocation", "description":"The schema location of Usage to return.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "description":"The Usage identifier.", "examples":{ "billingProductFee":{ "value":"0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+363982329259164444" }, "delayedSession":{ "value":"0.0.0.1+-event-delayed-session-telco-gsm+1516903833866053787" }, "billingDebit":{ "value":"0.0.0.1+-event-billing-debit+363982329259163599" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"usageType", "description":"The type of usage.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"usageDate", "description":"The usage start date and time.", "example":"2018-01-01T08:00:00.00Z", "required":false, "in":"query", "schema":{ "type":"string", "format":"date-time" } }, { "name":"endTime", "description":"The usage end date and time.", "example":"2018-01-01T08:00:00.00Z", "required":false, "in":"query", "schema":{ "type":"string", "format":"date-time" } }, { "name":"networkId", "description":"The network session identifier.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"description", "description":"The usage description.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"billId", "description":"The bill identifier.", "example":"0.0.0.1+-bill+363982329259147952", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"billingAccount.id", "description":"The billing account identifier.", "examples":{ "accountNo":{ "value":"acct_adjustment_test_8" }, "accountId":{ "value":"0.0.0.1+-account+183200" }, "accountExternalIdentifier":{ "value":"acct_adjustment_test_8" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"appliedCustomerBillingRate.id", "description":"The applied customer billing rate identifier.", "example":"0.0.0.1+-item-misc+308426205730877776", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"service.id", "description":"The service ID or external identifier.", "examples":{ "serviceId":{ "value":"0.0.0.1+-service-ip+193103" }, "serviceExternalIdentifier":{ "value":"ServiceId_test_8" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"service.login", "description":"The service login.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"service.alias.name", "description":"The service alias name.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"billStructure.id", "description":"The bill structure ID or external identifier.", "examples":{ "billStructureId":{ "value":"0.0.0.1+-bill_structure+180832" }, "billStructureExternalIdentifier":{ "value":"BillStructure-8-test" } }, "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"billStructure.billInfoId", "description":"The bill information identifier.", "example":"0.0.0.1+-billinfo+180320", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"billStructure.billInfoName", "description":"The bill information name.", "example":"BillStructure-8", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"taxExcludedAmount", "description":"The tax-excluded amount.", "required":false, "in":"query", "schema":{ "type":"number", "format":"float" } }, { "name":"taxIncludedAmount", "description":"The tax-included amount.", "required":false, "in":"query", "schema":{ "type":"number", "format":"float" } }, { "name":"resourceId", "description":"The resource identifier.", "example":"USD", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The request was successful.", "headers":{ "X-Result-Count":{ "description":"The actual number of items returned in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"The total number of items that match the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Usage" } } } } }, "400":{ "description":"The request is invalid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The request is unauthorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource was not found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"The request method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request conflicts with the current state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The server encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"usage-get", "x-filename-id":"usage-get" } }, "/usage/{id}":{ "get":{ "operationId":"retrieveUsage", "summary":"Get Usage by ID", "description":"This operation retrieves a Usage entity. Attribute selection is enabled for all first level attributes.", "tags":[ "Usage Management" ], "parameters":[ { "name":"id", "description":"The identifier of the Usage.", "required":true, "in":"path", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The request was successful.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Usage" } } } }, "400":{ "description":"The request is invalid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The request is unauthorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource was not found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"The request method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request conflicts with the current state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The server encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"usage-{id}-get", "x-filename-id":"usage-id-get" } }, "/payment":{ "get":{ "tags":[ "Payment Management/Payment" ], "summary":"Get Payments", "description":"Gets the payments that match the specified query criteria.", "operationId":"listPayment", "parameters":[ { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "examples":{ "getPaymentFieldsExample":{ "value":"paymentDate,account", "summary":"fields=paymentDate,account" } }, "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getPaymentOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getPaymentLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return: Payment for a base object or PaymentOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"account.id", "in":"query", "description":"Retrieves the payments from the account with the specified ID or account number.", "examples":{ "getPaymentAccIdExample":{ "value":"0.0.0.1+-account+79731", "summary":"account.id=0.0.0.1+-account+79731" }, "getPaymentAccIdExample2":{ "value":"0.0.0.1-63156", "summary":"account.id=0.0.0.1-63156" } }, "required":false, "schema":{ "type":"string" } }, { "name":"bill.id", "in":"query", "description":"Retrieves the payments associated with the specified bill ID or bill number.", "examples":{ "getPaymentBillIdExample":{ "value":"0.0.0.1+-bill+257531", "summary":"bill.id=0.0.0.1+-bill+257531" }, "getPaymentBillIdExample2":{ "value":"B1-4", "summary":"bill.id=B1-4" } }, "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"Retrieves the payment with the specified payment item ID or payment item number.", "examples":{ "getPaymentIdExample":{ "value":"0.0.0.1+-item-payment+106589", "summary":"id=0.0.0.1+-item-payment+106589" }, "getPaymentIdExample2":{ "value":"P1-3", "summary":"id=P1-3" } }, "schema":{ "type":"string" } }, { "name":"paymentDate", "in":"query", "description":"Retrieves the payments with a paymentDate that matches the specified date and time.", "examples":{ "getPaymentDateExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"paymentDate=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.gte", "in":"query", "description":"Retrieves the payments with a paymentDate that is greater than or equal to the specified date and time.", "examples":{ "getPaymnetDateGteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"paymentDate.gte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.lte", "in":"query", "description":"Retrieves the payments with a paymentDate that is less than or equal to the specified date and time.", "examples":{ "getPaymnetDateLteExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"paymentDate.lte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.gt", "in":"query", "description":"Retrieves the payments with a paymentDate that is greater than the specified date and time.", "examples":{ "getPaymnetDateGtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"paymentDate.gt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.lt", "in":"query", "description":"Retrieves the payments with a paymentDate that is less than the specified date and time.", "examples":{ "getPaymnetDateLtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"paymentDate.lt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"totalAmount.value", "in":"query", "description":"Retrieves the payments with a totalAmount that is equal to the specified amount.", "examples":{ "getPaymnetAmountExample":{ "value":40, "summary":"totalAmount.value=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gte", "in":"query", "description":"Retrieves the payments with a totalAmount that is greater than or equal to the specified amount.", "examples":{ "getPaymnetAmountGteExample":{ "value":40, "summary":"totalAmount.value.gte=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lte", "in":"query", "description":"Retrieves the payments with a totalAmount that is less than or equal to the specified amount.", "examples":{ "getPaymnetAmountLteExample":{ "value":40, "summary":"totalAmount.value.lte=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gt", "in":"query", "description":"Retrieves the payments with a totalAmount that is greater than the specified amount.", "examples":{ "getPaymentAmountGtExample":{ "value":40, "summary":"totalAmount.value.gt=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lt", "in":"query", "description":"Retrieves the payments with a totalAmount that is less than the specified amount.", "examples":{ "getPaymnetAmountLtExample":{ "value":40, "summary":"totalAmount.value.lt=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"status", "in":"query", "description":"Retrieves the payments with the specified status. The only valid value is Unallocated.", "examples":{ "getPaymentStatusExample":{ "value":"Unallocated", "summary":"status=Unallocated" } }, "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The payments were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Payment" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"payment-get", "x-filename-id":"payment-get" }, "post":{ "tags":[ "Payment Management/Payment" ], "summary":"Create a Payment", "description":"Creates a payment.", "operationId":"createPayment", "requestBody":{ "description":"The payment to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment_Create" } } }, "required":true }, "responses":{ "201":{ "description":"The payment was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"payment", "x-internal-id":"payment-post", "x-filename-id":"payment-post" } }, "/payment/{id}":{ "get":{ "tags":[ "Payment Management/Payment" ], "summary":"Get a Payment by ID", "description":"Gets the specified payment.", "operationId":"retrievePayment", "parameters":[ { "name":"id", "in":"path", "description":"The payment item ID or payment item number to get.", "examples":{ "paymentIdExample":{ "value":"0.0.0.1+-item-payment+106589", "summary":"id=0.0.0.1+-item-payment+106589" }, "paymentIdExample2":{ "value":"P1-3", "summary":"id=P1-3" } }, "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "examples":{ "paymentFieldsExample":{ "value":"name,paymentItem", "summary":"fields=name,paymentItem" } }, "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return. Use @type=Payment for a base object, or @type=PaymentOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The payment was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"payment-{id}-get", "x-filename-id":"payment-id-get" } }, "/paymentAllocation":{ "post":{ "tags":[ "Payment Management/Payment" ], "summary":"Create a Payment Allocation for a Bill", "description":"Allocates a payment to the specified bill.", "operationId":"createPaymentAllocation", "responses":{ "201":{ "description":"The payment allocation was created successfully." }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "requestBody":{ "description":"The payment to allocate.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PaymentAllocationRequestRefOracle" } } } }, "x-internal-id":"paymentAllocation-post", "x-filename-id":"paymentallocation-post" } }, "/refund":{ "get":{ "tags":[ "Payment Management/Refund" ], "summary":"Get Refunds", "description":"Gets the refunds that match the specified query criteria.", "operationId":"listRefund", "parameters":[ { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "examples":{ "getRefundFieldsExample":{ "value":"refundDate,account", "summary":"fields=refundDate,account" } }, "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getRefundOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getRefundLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return. Use @type=Refund for a base object, or @type=RefundOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"account.id", "in":"query", "description":"Retrieves the refunds from the account with the specified account ID or account number.", "examples":{ "getRefundAccIdExample":{ "value":"0.0.0.1+-account+79731", "summary":"account.id=0.0.0.1+-account+79731" } }, "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"Retrieves the refund associated with the specified item refund ID or item refund number.", "examples":{ "getRefundIdExample":{ "value":"0.0.0.1+-item-refund+106589", "summary":"id=0.0.0.1+-item-refund+106589" }, "getRefundIdExample2":{ "value":"R1", "summary":"id=R1" } }, "schema":{ "type":"string" } }, { "name":"refundDate", "in":"query", "description":"Retrieves the refunds with a refundDate that is equal to the specified dateTime.", "examples":{ "getRefundDateExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"refundDate=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.gte", "in":"query", "description":"Retrieves the refunds with a refundDate that is greater than or equal to the specified dateTime.", "examples":{ "getRefundDateGTEExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"refundDate.gte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.lte", "in":"query", "description":"Retrieves the refunds with a refundDate that is less than or equal to the specified dateTime.", "examples":{ "getRefundDateLTEExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"refundDate.lte=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.gt", "in":"query", "description":"Retrieves the refunds with a refundDate that is greater than the specified dateTime.", "examples":{ "getRefundDateGtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"refundDate.gt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.lt", "in":"query", "description":"Retrieves the refunds with a refundDate that is less than the specified dateTime.", "examples":{ "getRefundDateLtExample":{ "value":"2025-01-01T12:00:27.000Z", "summary":"refundDate.lt=2025-01-01T04:00:27-08:00" } }, "required":false, "schema":{ "type":"string" } }, { "name":"totalAmount.value", "in":"query", "description":"Retrieves the refunds with a totalAmount that is equal to the specified amount.", "examples":{ "getRefundAmountExample":{ "value":40, "summary":"totalAmount.value=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gte", "in":"query", "description":"Retrieves the refunds with a totalAmount that is greater than or equal to the specified amount.", "examples":{ "getRefundAmountGteExample":{ "value":40, "summary":"totalAmount.value.gte=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lte", "in":"query", "description":"Retrieves the refunds with a totalAmount is less than or equal to the specified amount.", "examples":{ "getRefundAmountLTEExample":{ "value":40, "summary":"totalAmount.value.lte=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gt", "in":"query", "description":"Retrieves the refunds with a totalAmount that is greater than the specified amount.", "examples":{ "getRefundAmountGtExample":{ "value":40, "summary":"totalAmount.value.gt=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lt", "in":"query", "description":"Retrieves the refunds with a totalAmount that is less than the specified amount.", "examples":{ "getRefundAmountLtExample":{ "value":40, "summary":"totalAmount.value.lt=40" } }, "required":false, "schema":{ "type":"number", "format":"float" } } ], "responses":{ "200":{ "description":"The refunds were retrieved successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Refund" } } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"refund-get", "x-filename-id":"refund-get" }, "post":{ "tags":[ "Payment Management/Refund" ], "summary":"Create a Refund", "description":"Creates a refund.", "operationId":"createRefund", "requestBody":{ "description":"The refund to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/RefundCreate" } } }, "required":true }, "responses":{ "201":{ "description":"The refund was created successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Refund" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"refund", "x-internal-id":"refund-post", "x-filename-id":"refund-post" } }, "/refund/{id}":{ "get":{ "tags":[ "Payment Management/Refund" ], "summary":"Get a Refund by ID", "description":"Gets the specified refund.", "operationId":"retrieveRefund", "parameters":[ { "name":"id", "in":"path", "description":"The refund's ID or item number.", "examples":{ "refundIdExample":{ "value":"0.0.0.1+-item-refund+106589", "summary":"id=0.0.0.1+-item-refund+106589" }, "refundIdExample2":{ "value":"R1", "summary":"id=R1" } }, "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "examples":{ "refundFieldsExample":{ "value":"name,payment", "summary":"fields=name,payment" } }, "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return. Use @type=Refund for a base object, or @type=RefundOracle for an extended object.", "examples":{ "refundTypeExample":{ "value":"Refund", "summary":"@type=Refund" }, "refundTypeExample2":{ "value":"RefundOracle", "summary":"@type=RefundOracle" } }, "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The refund was retrieved successfully.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Refund" } } } }, "400":{ "description":"The request isn't valid.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client doesn't have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request wasn't authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The requested resource couldn't be found.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system encountered an internal error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"refund-{id}-get", "x-filename-id":"refund-id-get" } } }, "components":{ "schemas":{ "Account":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.", "properties":{ "creditLimit":{ "nullable":true, "$ref":"#/components/schemas/Money" }, "description":{ "type":"string", "nullable":true, "description":"The account's detailed description." }, "lastUpdate":{ "type":"string", "nullable":true, "format":"date-time", "description":"The date and time when the system last updated the account." }, "name":{ "type":"string", "nullable":true, "description":"The account's name." }, "state":{ "type":"string", "nullable":true, "description":"Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountType":{ "type":"string", "nullable":true, "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "relatedParty":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef", "description":"The account's related parties, for example, the customer to whom the account belongs." } }, "taxExemption":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/TaxExemptionCertificate", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/Contact", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountBalance":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/AccountBalance", "description":"The account's balances, for example, regular postpaid, deposit, and write-off balances." } }, "accountRelationship":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/AccountRelationship", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } } } } ] }, "AccountBalance":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents balances linked to an account.", "properties":{ "id":{ "type":"string", "description":"The balance's ID within the list of balances." }, "amount":{ "nullable":true, "$ref":"#/components/schemas/Money" }, "balanceType":{ "type":"string", "nullable":true, "description":"The balance's type, such as a deposit, disputed, loyalty, or receivable balance." }, "validFor":{ "nullable":true, "$ref":"#/components/schemas/TimePeriod" } } } ] }, "AccountBalanceOracle":{ "allOf":[ { "$ref":"#/components/schemas/AccountBalance" }, { "type":"object", "description":"Balances linked to the account", "properties":{ "grantedBal":{ "nullable":true, "$ref":"#/components/schemas/Money", "description":"The granted balance" }, "nextBal":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The next balance." }, "delayedBal":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The account balance's unit." } } } ] }, "AccountBalance_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents balances linked to an account.", "properties":{ "id":{ "type":"string", "description":"The balance's ID within the list of balances." }, "amount":{ "$ref":"#/components/schemas/Money" }, "balanceType":{ "type":"string", "description":"The balance's type, such as a deposit, disputed, loyalty, or receivable balance." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } }, "required":[ "amount", "balanceType", "validFor" ] } ] }, "AccountBalance_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents balances linked to an account.", "properties":{ "id":{ "type":"string", "description":"The balance's ID within the list of balances." }, "amount":{ "$ref":"#/components/schemas/Money" }, "balanceType":{ "type":"string", "description":"The balance's type, such as a deposit, disputed, loyalty, or receivable balance." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ] }, "AccountRef":{ "type":"object", "description":"Refers to an account. An account may be a party account or a financial account.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "AccountRef_FVO":{ "type":"object", "description":"Refers to an account. An account may be a party account or a financial account.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "AccountRef_MVO":{ "type":"object", "description":"Refers to an account. An account may be a party account or a financial account.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "AccountRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "relationshipType":{ "type":"string", "nullable":true, "description":"The relationship type." }, "account":{ "nullable":true, "$ref":"#/components/schemas/AccountRef" } } } ] }, "AccountRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "relationshipType":{ "type":"string", "description":"The relationship type." }, "account":{ "$ref":"#/components/schemas/AccountRef_FVO" } }, "required":[ "relationshipType" ] } ] }, "AccountRelationshipOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/AccountRelationship_FVO" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "billStructure":{ "type":"object", "description":"The child account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The child account's bill structure ID." }, "name":{ "type":"string", "description":"The bill structure name of child account." } }, "required":[ "id" ] }, "relationshipType":{ "type":"string", "enum":[ "AR", "Parent", "Subordinate", "Child" ], "description":"The relationship type." }, "account":{ "type":"object", "description":"Refers to an account. An account may be a party account or a financial account.", "properties":{ "id":{ "type":"string", "description":"The account's ID." }, "billStructure":{ "type":"object", "description":"The account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The parent account's bill structure ID." }, "name":{ "type":"string", "description":"The parent account's bill structure name." } }, "required":[ "id" ] } } } }, "required":[ "account" ] } ] }, "AccountRelationshipOracle":{ "allOf":[ { "$ref":"#/components/schemas/AccountRelationship" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "billStructure":{ "type":"object", "nullable":true, "description":"The child account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The child account's bill structure ID." }, "name":{ "type":"string", "nullable":true, "description":"The bill structure name of child account." } } }, "relationshipType":{ "type":"string", "nullable":true, "enum":[ "AR", "Parent", "Subordinate", "Child" ], "description":"The relationship type." }, "account":{ "type":"object", "nullable":true, "description":"Refers to an account. An account may be a party account or a financial account.", "properties":{ "id":{ "type":"string", "description":"The account's ID." }, "billStructure":{ "type":"object", "nullable":true, "description":"The account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The parent account's bill structure ID." }, "name":{ "type":"string", "nullable":true, "description":"The parent account's bill structure name." } } } } } } } ] }, "AccountRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "relationshipType":{ "type":"string", "description":"The relationship type." }, "account":{ "$ref":"#/components/schemas/AccountRef_MVO" } } } ] }, "AccountRelationshipOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/AccountRelationship_MVO" }, { "type":"object", "description":"Represents a significant connection between accounts. For example, an aggregating account for a list of shop branches, each with its own billing account.", "properties":{ "billStructure":{ "type":"object", "description":"The child account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The child account's bill structure ID." } } }, "relationshipType":{ "type":"string", "enum":[ "Parent", "AR", "Subordinate", "Child" ], "description":"The relationship type." }, "account":{ "type":"object", "description":"Refers to an account. An account may be a party account or a financial account.", "properties":{ "id":{ "type":"string", "description":"The account's ID." }, "billStructure":{ "type":"object", "description":"The account's bill structure.", "properties":{ "id":{ "type":"string", "description":"The parent account's bill structure ID." }, "name":{ "type":"string", "description":"The parent account's bill structure name." } } } } } } } ] }, "Account_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.", "properties":{ "creditLimit":{ "$ref":"#/components/schemas/Money" }, "description":{ "type":"string", "description":"The account's detailed description." }, "name":{ "type":"string", "description":"The account's name." }, "state":{ "type":"string", "description":"Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountType":{ "type":"string", "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO", "description":"The account's related parties, for example, the customer to whom the account belongs." } }, "taxExemption":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificate_FVO", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "items":{ "$ref":"#/components/schemas/Contact_FVO", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRelationship_FVO", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } } }, "required":[ "name" ] } ] }, "Account_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Defines a generic account structure shared by PartyAccount, FinancialAccount, and other account types supported by the API.", "properties":{ "creditLimit":{ "$ref":"#/components/schemas/Money" }, "description":{ "type":"string", "description":"The account's detailed description." }, "name":{ "type":"string", "description":"The account's name." }, "state":{ "type":"string", "description":"Contains the lifecycle state such as: Active, Closed, Suspended and so on." }, "accountType":{ "type":"string", "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO", "description":"The account's related parties, for example, the customer to whom the account belongs." } }, "taxExemption":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificate_MVO", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "items":{ "$ref":"#/components/schemas/Contact_MVO", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRelationship_MVO", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } } } } ] }, "Addressable":{ "type":"object", "description":"Defines a base schema for addressable entities.", "properties":{ "href":{ "type":"string", "nullable":true, "description":"The hyperlink reference." }, "id":{ "type":"string", "description":"The ID." } } }, "Addressable_FVO":{ "type":"object", "description":"Defines a base schema for addressable entities.", "properties":{ "id":{ "type":"string", "description":"The ID." } } }, "Attachment":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents an attachment that complements an element's description, such as a product description, through videos or pictures.", "properties":{ "name":{ "type":"string", "nullable":true, "description":"The attachment's name." }, "description":{ "type":"string", "nullable":true, "description":"The attachment's description.", "example":"Photograph of the Product" }, "url":{ "type":"string", "nullable":true, "description":"The URL of the attachment content.", "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "content":{ "type":"string", "nullable":true, "format":"base64", "description":"The attachment's Base64-encoded content when embedded." }, "size":{ "nullable":true, "$ref":"#/components/schemas/Quantity" }, "validFor":{ "nullable":true, "$ref":"#/components/schemas/TimePeriod" }, "attachmentType":{ "type":"string", "nullable":true, "description":"The business characterization of the attachment's purpose, for example logo instructionManual contractCopy." }, "mimeType":{ "type":"string", "nullable":true, "description":"The technical characterization of the attachment content format using IETF MIME types." } } } ] }, "AttachmentRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.", "properties":{ "description":{ "type":"string", "nullable":true, "description":"The attachment's description." }, "url":{ "description":"The link to the attachment media or content.", "type":"string", "nullable":true } } } ] }, "AttachmentRefOrValue":{ "type":"object", "description":"The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/Attachment" }, { "$ref":"#/components/schemas/AttachmentRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment", "AttachmentRef":"#/components/schemas/AttachmentRef" } } }, "AttachmentRefOrValue_FVO":{ "type":"object", "description":"The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/Attachment_FVO" }, { "$ref":"#/components/schemas/AttachmentRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment_FVO", "AttachmentRef":"#/components/schemas/AttachmentRef_FVO" } } }, "AttachmentRefOrValue_MVO":{ "type":"object", "description":"The Attachment entity, not the AttachmentRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/Attachment_MVO" }, { "$ref":"#/components/schemas/AttachmentRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Attachment":"#/components/schemas/Attachment_MVO", "AttachmentRef":"#/components/schemas/AttachmentRef_MVO" } } }, "AttachmentRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.", "properties":{ "description":{ "type":"string", "description":"The attachment's description." }, "url":{ "description":"The link to the attachment media or content.", "type":"string" } } } ] }, "AttachmentRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Represents an attachment reference. An attachment complements an element's description, such as a product description, through videos or pictures.", "properties":{ "description":{ "type":"string", "description":"The attachment's description." }, "url":{ "description":"The link to the attachment media or content.", "type":"string" } } } ] }, "Attachment_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Represents an attachment that complements an element's description, such as a product description, through videos or pictures.", "properties":{ "name":{ "type":"string", "description":"The attachment's name." }, "description":{ "type":"string", "description":"The attachment's description.", "example":"Photograph of the Product" }, "url":{ "type":"string", "description":"The URL of the attachment content.", "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "content":{ "type":"string", "format":"base64", "description":"The attachment's Base64-encoded content when embedded." }, "size":{ "$ref":"#/components/schemas/Quantity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachmentType":{ "type":"string", "description":"The business characterization of the attachment's purpose, for example logo instructionManual contractCopy." }, "mimeType":{ "type":"string", "description":"The technical characterization of the attachment content format using IETF MIME types." } }, "required":[ "attachmentType", "mimeType" ] } ] }, "Attachment_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Represents an attachment that complements an element's description, such as a product description, through videos or pictures.", "properties":{ "name":{ "type":"string", "description":"The attachment's name." }, "description":{ "type":"string", "description":"The attachment's description.", "example":"Photograph of the Product" }, "url":{ "type":"string", "description":"The URL of the attachment content.", "example":"http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f" }, "content":{ "type":"string", "format":"base64", "description":"The attachment's Base64-encoded content when embedded." }, "size":{ "$ref":"#/components/schemas/Quantity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachmentType":{ "type":"string", "description":"The business characterization of the attachment's purpose, for example logo instructionManual contractCopy." }, "mimeType":{ "type":"string", "description":"The technical characterization of the attachment content format using IETF MIME types." } } } ] }, "BaseEvent":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a base Represents an event with common attributes.", "properties":{ "event":{ "type":"object" }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." } } } ] }, "BaseEvent_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Represents a base Represents an event with common attributes.", "properties":{ "event":{ "type":"object" }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." } } } ] }, "BaseEvent_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Represents a base Represents an event with common attributes.", "properties":{ "event":{ "type":"object" }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." } } } ] }, "BillFormat":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a detailed description of how a bill is presented.", "properties":{ "name":{ "type":"string", "nullable":true, "description":"The bill format's short descriptive name." }, "description":{ "type":"string", "nullable":true, "description":"The bill format's explanatory text." } } } ] }, "BillFormatAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillFormatAttributeValueChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillFormatAttributeValueChangeEventPayload" } } } ] }, "BillFormatAttributeValueChangeEventPayload":{ "type":"object", "description":"Represents the BillFormatAttributeValueChangeEventPayload generic structure.", "properties":{ "billFormat":{ "$ref":"#/components/schemas/BillFormat" } } }, "BillFormatCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillFormatCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillFormatCreateEventPayload" } } } ] }, "BillFormatCreateEventPayload":{ "type":"object", "description":"Represents the BillFormatCreateEventPayload generic structure.", "properties":{ "billFormat":{ "$ref":"#/components/schemas/BillFormat" } } }, "BillFormatDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillFormatDeleteEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillFormatDeleteEventPayload" } } } ] }, "BillFormatDeleteEventPayload":{ "type":"object", "description":"Represents the BillFormatDeleteEventPayload generic structure.", "properties":{ "billFormat":{ "$ref":"#/components/schemas/BillFormat" } } }, "BillFormatRef":{ "type":"object", "description":"Refers to a bill format. A bill format describes how a bill is presented.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillFormatRefOrValue":{ "type":"object", "description":"The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillFormat" }, { "$ref":"#/components/schemas/BillFormatRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat", "BillFormatRef":"#/components/schemas/BillFormatRef" } } }, "BillFormatRefOrValue_FVO":{ "type":"object", "description":"The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillFormat_FVO" }, { "$ref":"#/components/schemas/BillFormatRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat_FVO", "BillFormatRef":"#/components/schemas/BillFormatRef_FVO" } } }, "BillFormatRefOrValue_MVO":{ "type":"object", "description":"The BillFormat entity, not the BillFormatRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillFormat_MVO" }, { "$ref":"#/components/schemas/BillFormatRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillFormat":"#/components/schemas/BillFormat_MVO", "BillFormatRef":"#/components/schemas/BillFormatRef_MVO" } } }, "BillFormatRef_FVO":{ "type":"object", "description":"Refers to a bill format. A bill format describes how a bill is presented.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "BillFormatRef_MVO":{ "type":"object", "description":"Refers to a bill format. A bill format describes how a bill is presented.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillFormatStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillFormatStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillFormatStateChangeEventPayload" } } } ] }, "BillFormatStateChangeEventPayload":{ "type":"object", "description":"Represents the BillFormatStateChangeEventPayload generic structure.", "properties":{ "billFormat":{ "$ref":"#/components/schemas/BillFormat" } } }, "BillFormat_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Represents a detailed description of how a bill is presented.", "properties":{ "name":{ "type":"string", "description":"The bill format's short descriptive name." }, "description":{ "type":"string", "description":"The bill format's explanatory text." } }, "required":[ "name" ] } ] }, "BillFormat_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Represents a detailed description of how a bill is presented.", "properties":{ "name":{ "type":"string", "description":"The bill format's short descriptive name." }, "description":{ "type":"string", "description":"The bill format's explanatory text." } } } ] }, "BillPresentationMedia":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "properties":{ "name":{ "type":"string", "nullable":true, "description":"The bill presentation media's short descriptive name." }, "description":{ "type":"string", "nullable":true, "description":"The bill presentation media's explanatory text." } } } ] }, "BillPresentationMediaAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillPresentationMediaAttributeValueChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillPresentationMediaAttributeValueChangeEventPayload" } } } ] }, "BillPresentationMediaAttributeValueChangeEventPayload":{ "type":"object", "description":"Represents the BillPresentationMediaAttributeValueChangeEventPayload generic structure.", "properties":{ "billPresentationMedia":{ "$ref":"#/components/schemas/BillPresentationMedia" } } }, "BillPresentationMediaCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillPresentationMediaCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillPresentationMediaCreateEventPayload" } } } ] }, "BillPresentationMediaCreateEventPayload":{ "type":"object", "description":"Represents the BillPresentationMediaCreateEventPayload generic structure.", "properties":{ "billPresentationMedia":{ "$ref":"#/components/schemas/BillPresentationMedia" } } }, "BillPresentationMediaDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillPresentationMediaDeleteEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillPresentationMediaDeleteEventPayload" } } } ] }, "BillPresentationMediaDeleteEventPayload":{ "type":"object", "description":"Represents the BillPresentationMediaDeleteEventPayload generic structure.", "properties":{ "billPresentationMedia":{ "$ref":"#/components/schemas/BillPresentationMedia" } } }, "BillPresentationMediaRef":{ "type":"object", "description":"Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillPresentationMediaRefOrValue":{ "type":"object", "description":"The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillPresentationMedia" }, { "$ref":"#/components/schemas/BillPresentationMediaRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef" } } }, "BillPresentationMediaRefOrValue_FVO":{ "type":"object", "description":"The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillPresentationMedia_FVO" }, { "$ref":"#/components/schemas/BillPresentationMediaRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia_FVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_FVO" } } }, "BillPresentationMediaRefOrValue_MVO":{ "type":"object", "description":"The BillPresentationMedia entity, not the BillPresentationMediaRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillPresentationMedia_MVO" }, { "$ref":"#/components/schemas/BillPresentationMediaRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillPresentationMedia":"#/components/schemas/BillPresentationMedia_MVO", "BillPresentationMediaRef":"#/components/schemas/BillPresentationMediaRef_MVO" } } }, "BillPresentationMediaRef_FVO":{ "type":"object", "description":"Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "BillPresentationMediaRef_MVO":{ "type":"object", "description":"Refers to bill presentation media. Bill presentation media represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillPresentationMediaStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillPresentationMediaStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillPresentationMediaStateChangeEventPayload" } } } ] }, "BillPresentationMediaStateChangeEventPayload":{ "type":"object", "description":"Represents the BillPresentationMediaStateChangeEventPayload generic structure.", "properties":{ "billPresentationMedia":{ "$ref":"#/components/schemas/BillPresentationMedia" } } }, "BillPresentationMedia_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "properties":{ "name":{ "type":"string", "description":"The bill presentation media's short descriptive name." }, "description":{ "type":"string", "description":"The bill presentation media's explanatory text." } }, "required":[ "name" ] } ] }, "BillPresentationMedia_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Represents a means of communicating a bill that the associated bill format supports. For example post mail email web page.", "properties":{ "name":{ "type":"string", "description":"The bill presentation media's short descriptive name." }, "description":{ "type":"string", "description":"The bill presentation media's explanatory text." } } } ] }, "BillStructure":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents the bill structure for party accounts, including billing and settlement accounts.", "properties":{ "presentationMedia":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/BillPresentationMediaRefOrValue" } }, "format":{ "nullable":true, "$ref":"#/components/schemas/BillFormatRefOrValue" }, "cycleSpecification":{ "nullable":true, "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValue" } } } ] }, "BillStructure_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents the bill structure for party accounts, including billing and settlement accounts.", "properties":{ "presentationMedia":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMediaRefOrValue_FVO" } }, "format":{ "$ref":"#/components/schemas/BillFormatRefOrValue_FVO" }, "cycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecification_FVO" } } } ] }, "BillStructureOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents an extended bill structure for Oracle implementation.", "properties":{ "presentationMedia":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMediaRefOrValue_FVO" } }, "format":{ "$ref":"#/components/schemas/BillFormatRefOrValue_FVO" }, "cycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValueOracle_FVO" }, "id":{ "type":"string", "description":"The bill unit ID." }, "businessProfileId":{ "type":"string", "description":"The business profile ID." }, "actgType":{ "type":"string", "enum":[ "open_items", "balance_forward" ], "description":"The accounting type. Accepted values open_items balance_forward." }, "billingSegment":{ "type":"string", "description":"The bill structure's billing segment." }, "acctSuppressed":{ "type":"boolean", "description":"Specifies whether the account is suppressed. Accepted values true false." }, "name":{ "type":"string", "description":"The bill unit's name." }, "balanceGroup":{ "type":"array", "items":{ "type":"object", "properties":{ "limit":{ "type":"array", "items":{ "properties":{ "creditLimit":{ "type":"number", "format":"double", "description":"The balance group's credit limit." }, "unit":{ "type":"string", "description":"The credit limit's unit." }, "creditFloor":{ "type":"number", "format":"double", "description":"The credit floor." }, "dynamicCreditFloor":{ "type":"boolean", "description":"Specifies whether the credit floor is dynamic." }, "overrideCreditLimit":{ "type":"number", "format":"double", "description":"The overridden credit limit." }, "creditThreshold":{ "type":"number", "format":"double", "description":"The credit threshold." }, "thresholds":{ "type":"array", "items":{ "type":"object", "properties":{ "threshold":{ "type":"number", "format":"double", "description":"The threshold's value." }, "amount":{ "type":"number", "format":"double", "description":"The threshold's amount." } } } } }, "required":[ "creditLimit", "unit" ] } }, "id":{ "type":"string", "description":"The balance group's ID." }, "name":{ "type":"string", "description":"The balance group's name." }, "isDefault":{ "type":"boolean", "description":"Boolean value for default balance group." }, "tempLimit":{ "type":"array", "items":{ "properties":{ "creditLimit":{ "type":"number", "format":"double", "description":"The credit limit." }, "unit":{ "type":"string", "description":"The credit limit's unit." }, "validFrom":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date." }, "validFromDuration":{ "type":"object", "properties":{ "unit":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date's unit." }, "offset":{ "type":"integer", "format":"double", "description":"The start date's offset." } } }, "validTo":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date." }, "validToDuration":{ "type":"object", "properties":{ "unit":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date's unit." }, "offset":{ "type":"integer", "format":"double", "description":"The end date's offset." } } }, "recId":{ "type":"string", "description":"The record ID." } }, "required":[ "creditLimit", "unit" ] } }, "rules":{ "type":"array", "items":{ "properties":{ "unit":{ "type":"string", "description":"The consumption rule.'s unit." }, "consumptionRule":{ "type":"string", "enum":[ "EST", "LST", "EET", "LET", "ESTLET", "ESTEET", "LSTEET", "LSTLET", "EETEST", "EETLST", "LETEST", "LETLST" ], "description":"The consumption rule." } }, "required":[ "consumptionRule", "unit" ] } }, "rolledUpCreditLimit":{ "type":"number", "format":"double", "description":"The rolled-up credit limit." } } } } }, "required":[ "name" ] } ] }, "BillStructureOracle":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an extended bill structure for Oracle implementation.", "properties":{ "presentationMedia":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/BillPresentationMediaRefOrValue" } }, "format":{ "type":"object", "nullable":true, "allOf":[ { "$ref":"#/components/schemas/BillFormatRefOrValue" } ] }, "cycleSpecification":{ "type":"object", "nullable":true, "allOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValueOracle" } ] }, "id":{ "type":"string", "description":"The bill unit ID." }, "businessProfileId":{ "type":"string", "description":"The business profile ID." }, "actgType":{ "type":"string", "nullable":true, "enum":[ "open_items", "balance_forward" ], "description":"The accounting type. Accepted values open_items balance_forward." }, "payType":{ "type":"string", "nullable":true, "enum":[ "invoice", "credit_card", "direct_debit", "subordinate" ], "description":"The payment type. Accepted values invoice credit_card direct_debit subordinate." }, "billingSegment":{ "type":"string", "nullable":true, "description":"The bill structure's billing segment." }, "acctSuppressed":{ "type":"boolean", "nullable":true, "description":"Specifies whether the account is suppressed. Accepted values true false." }, "name":{ "type":"string", "nullable":true, "description":"The bill unit's name." }, "balanceGroup":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "limit":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "creditLimit":{ "type":"number", "nullable":true, "format":"double", "description":"The balance group's credit limit." }, "unit":{ "type":"string", "nullable":true, "description":"The credit limit's unit." }, "creditFloor":{ "type":"number", "nullable":true, "format":"double", "description":"The credit floor." }, "dynamicCreditFloor":{ "type":"boolean", "nullable":true, "description":"Specifies whether the credit floor is dynamic." }, "overrideCreditLimit":{ "type":"number", "nullable":true, "format":"double", "description":"The overridden credit limit." }, "creditThreshold":{ "type":"number", "nullable":true, "format":"double", "description":"The credit threshold" }, "fixedThreshold":{ "type":"string", "nullable":true, "description":"The fixed credit threshold" }, "thresholds":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "threshold":{ "type":"number", "nullable":true, "format":"double", "description":"The threshold's value." }, "amount":{ "type":"number", "nullable":true, "format":"double", "description":"The threshold's amount." } } } } } } }, "rules":{ "type":"array", "nullable":true, "items":{ "properties":{ "unit":{ "type":"string", "nullable":true, "description":"The consumption rule.'s unit." }, "consumptionRule":{ "type":"string", "nullable":true, "enum":[ "EST", "LST", "EET", "LET", "ESTLET", "ESTEET", "LSTEET", "LSTLET", "EETEST", "EETLST", "LETEST", "LETLST" ], "description":"The consumption rule." } } } }, "id":{ "type":"string", "description":"The balance group's ID." }, "name":{ "type":"string", "nullable":true, "description":"The balance group's name." }, "isDefault":{ "type":"boolean", "nullable":true, "description":"Boolean value for default balance group." }, "tempLimit":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "creditLimit":{ "type":"number", "nullable":true, "format":"double", "description":"The credit limit." }, "unit":{ "type":"string", "nullable":true, "description":"The credit limit's unit." }, "validFrom":{ "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date." }, "validFromDuration":{ "type":"object", "nullable":true, "properties":{ "unit":{ "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date's unit." }, "offset":{ "type":"integer", "nullable":true, "format":"double", "description":"The start date's offset." } } }, "validTo":{ "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date." }, "validToDuration":{ "type":"object", "nullable":true, "properties":{ "unit":{ "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date's unit." }, "offset":{ "type":"integer", "nullable":true, "format":"double", "description":"The end date's offset." } } }, "recId":{ "type":"string", "description":"The record ID." } } } }, "services":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "id":{ "type":"string", "description":"The balance group's associated service ID." } } } }, "rolledUpCreditLimit":{ "type":"number", "nullable":true, "format":"double", "description":"description: The rolled-up credit limit." }, "balances":{ "type":"array", "nullable":true, "items":{ "nullable":true, "type":"object", "properties":{ "amount":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The current balance amount" }, "grantedBal":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The granted balance amount" }, "totalAmount":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The total balance amount" }, "outstandingAmount":{ "$ref":"#/components/schemas/Money", "nullable":true, "description":"The outstanding balance amount" } } } } } } } } } ] }, "ServiceBillStructureOracle":{ "type":"array", "nullable":true, "description":"Represents an array of bill structures.", "items":{ "nullable":true, "$ref":"#/components/schemas/BillStructureOracle" } }, "ServiceBillStructureOracle_FVO":{ "type":"array", "description":"Represents an array of bill structures.", "items":{ "$ref":"#/components/schemas/BillStructureOracle_FVO" } }, "BillStructure_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents the bill structure for party accounts, including billing and settlement accounts.", "properties":{ "cycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValue_MVO" }, "presentationMedia":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMediaRefOrValue_MVO" } }, "format":{ "$ref":"#/components/schemas/BillFormatRefOrValue_MVO" } } } ] }, "BillStructureOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an extended bill structure for Oracle implementation.", "properties":{ "cycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValueOracle_MVO" }, "presentationMedia":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMediaRefOrValue_MVO" } }, "format":{ "$ref":"#/components/schemas/BillFormatRefOrValue_MVO" }, "id":{ "type":"string", "description":"The bill unit ID." }, "businessProfileId":{ "type":"string", "description":"The business profile ID." }, "actgType":{ "type":"string", "enum":[ "open_items", "balance_forward" ], "description":"The accounting type. Accepted values open_items balance_forward." }, "billingSegment":{ "type":"string", "description":"The bill structure's billing segment." }, "acctSuppressed":{ "type":"boolean", "description":"Specifies whether the account is suppressed. Accepted values true false." }, "name":{ "type":"string", "description":"The bill unit's name." }, "balanceGroup":{ "type":"array", "items":{ "type":"object", "properties":{ "limit":{ "type":"array", "items":{ "properties":{ "creditLimit":{ "type":"number", "format":"double", "description":"The balance group's credit limit." }, "unit":{ "type":"string", "description":"The credit limit's unit." }, "creditFloor":{ "type":"number", "format":"double", "description":"The credit floor." }, "dynamicCreditFloor":{ "type":"boolean", "description":"Specifies whether the credit floor is dynamic." }, "overrideCreditLimit":{ "type":"number", "format":"double", "description":"The overridden credit limit." }, "creditThreshold":{ "type":"number", "format":"double", "description":"The credit threshold." }, "thresholds":{ "type":"array", "items":{ "type":"object", "properties":{ "threshold":{ "type":"number", "format":"double", "description":"The threshold's value." }, "amount":{ "type":"number", "format":"double", "description":"The threshold's amount." } } } } }, "required":[ "creditLimit", "unit" ] } }, "rules":{ "type":"array", "items":{ "properties":{ "unit":{ "type":"string", "description":"The consumption rule.'s unit." }, "consumptionRule":{ "type":"string", "enum":[ "EST", "LST", "EET", "LET", "ESTLET", "ESTEET", "LSTEET", "LSTLET", "EETEST", "EETLST", "LETEST", "LETLST" ], "description":"The consumption rule." } }, "required":[ "consumptionRule", "unit" ] } }, "id":{ "type":"string", "description":"The balance group's ID." }, "name":{ "type":"string", "description":"The balance group's name." }, "isDefault":{ "type":"boolean", "description":"Boolean value for default balance group." }, "tempLimit":{ "type":"array", "items":{ "properties":{ "creditLimit":{ "type":"number", "format":"double", "description":"The credit limit." }, "unit":{ "type":"string", "description":"The credit limit's unit." }, "validFrom":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date." }, "validFromDuration":{ "type":"object", "properties":{ "unit":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The start date's unit." }, "offset":{ "type":"integer", "format":"double", "description":"The start date's offset." } } }, "validTo":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date." }, "validToDuration":{ "type":"object", "properties":{ "unit":{ "type":"string", "format":"date-time", "example":"1985-04-12T23:20:50.52Z", "description":"The end date's unit." }, "offset":{ "type":"integer", "format":"double", "description":"The end date's offset." } } }, "recId":{ "type":"string", "description":"The record ID." } }, "required":[ "creditLimit", "unit" ] } }, "rolledUpCreditLimit":{ "type":"number", "format":"double", "description":"The rolled-up credit limit." } } } } } } ] }, "ServiceBillStructureOracle_MVO":{ "type":"array", "description":"Represents an array of bill structures.", "items":{ "$ref":"#/components/schemas/BillStructureOracle_MVO" } }, "BillingAccount":{ "allOf":[ { "$ref":"#/components/schemas/PartyAccount" }, { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.", "properties":{ "ratingType":{ "type":"string", "nullable":true, "description":"The account's payment option, such as prepaid postpaid." } } } ] }, "BillingAccountAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingAccountAttributeValueChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingAccountAttributeValueChangeEventPayload" } } } ] }, "BillingAccountAttributeValueChangeEventPayload":{ "type":"object", "description":"Represents the BillingAccountAttributeValueChangeEventPayload generic structure.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccount" } } }, "BillingAccountCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingAccountCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingAccountCreateEventPayload" } } } ] }, "BillingAccountCreateEventPayload":{ "type":"object", "description":"Represents the BillingAccountCreateEventPayload generic structure.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccount" } } }, "BillingAccountDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingAccountDeleteEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingAccountDeleteEventPayload" } } } ] }, "BillingAccountDeleteEventPayload":{ "type":"object", "description":"Represents the BillingAccountDeleteEventPayload generic structure.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccount" } } }, "BillingAccountStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingAccountStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingAccountStateChangeEventPayload" } } } ] }, "BillingAccountStateChangeEventPayload":{ "type":"object", "description":"Represents the BillingAccountStateChangeEventPayload generic structure.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccount" } } }, "BillingAccount_FVO":{ "allOf":[ { "$ref":"#/components/schemas/PartyAccount_FVO" }, { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.", "required":[ "name", "relatedParty" ] } ] }, "BillingAccountOracle":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.", "properties":{ "href":{ "type":"string", "nullable":true, "description":"The hyperlink reference." }, "id":{ "type":"string", "description":"The ID." }, "accountNum":{ "type":"string", "nullable":true, "description":"The account number." }, "description":{ "type":"string", "nullable":true, "description":"The account's detailed description." }, "name":{ "type":"string", "nullable":true, "description":"The account's name." }, "state":{ "type":"string", "nullable":true, "enum":[ "active", "inactive", "closed" ], "description":"The account's lifecycle state. Examples active inactive closed." }, "accountType":{ "type":"string", "nullable":true, "enum":[ "unknown", "consumer", "business" ], "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "brmAccountType":{ "type":"string", "nullable":true, "enum":[ "standard", "brand" ], "description":"The BRM account type. Accepted values standard brand." }, "glSegment":{ "type":"string", "nullable":true, "description":"The GL segment value." }, "currency":{ "type":"string", "nullable":true, "description":"The currency's ISO 4217 three-letter code." }, "currencySecondary":{ "type":"string", "nullable":true, "description":"The secondary currency's ISO 4217 three-letter code." }, "customerSegmentList":{ "type":"string", "nullable":true, "description":"The customer segment list." }, "locale":{ "type":"string", "nullable":true, "description":"The locale. Default value en_US." }, "vatCertificate":{ "type":"string", "nullable":true, "description":"The resource's or account's VAT certificate." }, "attribute":{ "type":"integer", "nullable":true, "description":"The attribute." }, "billStructure":{ "type":"object", "nullable":true, "allOf":[ { "$ref":"#/components/schemas/BillStructureOracle" } ] }, "serviceBillStructure":{ "$ref":"#/components/schemas/ServiceBillStructureOracle" }, "relatedParty":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef", "description":"The account's related parties, for example, the customer to whom the account belongs." } }, "taxExemption":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/TaxExemptionCertificateOracle", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/ContactOracle", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountRelationship":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/AccountRelationshipOracle", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } }, "accountBalance":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/AccountBalanceOracle", "description":"The account's balances, for example, regular postpaid, deposit, and write-off balances." } } } } ] }, "BillingAccountOracle_FVO":{ "allOf":[ { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.", "properties":{ "id":{ "type":"string", "description":"The ID." }, "accountNum":{ "type":"string", "description":"The account number." }, "description":{ "type":"string", "description":"The account's detailed description." }, "name":{ "type":"string", "description":"The account's name." }, "state":{ "type":"string", "enum":[ "active", "inactive", "closed" ], "description":"The account's lifecycle state. Examples active inactive closed." }, "accountType":{ "type":"string", "enum":[ "consumer", "business" ], "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "brmAccountType":{ "type":"string", "enum":[ "standard", "brand" ], "description":"The BRM account type. Accepted values standard brand." }, "glSegment":{ "type":"string", "description":"The GL segment value." }, "currency":{ "type":"string", "description":"The currency's ISO 4217 three-letter code." }, "currencySecondary":{ "type":"string", "description":"The secondary currency's ISO 4217 three-letter code." }, "customerSegmentList":{ "type":"string", "description":"The customer segment list." }, "locale":{ "type":"string", "description":"The locale. Default value en_US." }, "vatCertificate":{ "type":"string", "description":"The resource's or account's VAT certificate." }, "billStructure":{ "$ref":"#/components/schemas/BillStructureOracle_FVO" }, "serviceBillStructure":{ "$ref":"#/components/schemas/ServiceBillStructureOracle_FVO" }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO", "description":"The account's related parties, for example, the customer to whom the account belongs." } }, "taxExemption":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificateOracle_FVO", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactOracle_FVO", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRelationshipOracle_FVO", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } } }, "required":[ "name", "relatedParty" ] } ] }, "BillingAccount_MVO":{ "allOf":[ { "$ref":"#/components/schemas/PartyAccount_MVO" }, { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount." } ] }, "BillingAccountOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a party account used for billing purposes. It includes a bill structure that defines frequency presentation media format. It specializes PartyAccount.", "properties":{ "accountNum":{ "type":"string", "description":"The account number." }, "description":{ "type":"string", "description":"The account's detailed description." }, "name":{ "type":"string", "description":"The account's name." }, "state":{ "type":"string", "enum":[ "active", "inactive", "closed" ], "description":"The account's lifecycle state. Examples active inactive closed." }, "accountType":{ "type":"string", "enum":[ "consumer", "business" ], "description":"The account's category. Examples individual joint. For flexibility, the API uses a string, but implementations can use an enumeration with a limited list of valid values." }, "glSegment":{ "type":"string", "description":"The GL segment value." }, "currency":{ "type":"string", "description":"The currency's ISO 4217 three-letter code." }, "currencySecondary":{ "type":"string", "description":"The secondary currency's ISO 4217 three-letter code." }, "customerSegmentList":{ "type":"string", "description":"The customer segment list." }, "locale":{ "type":"string", "description":"The locale. Default value en_US." }, "vatCertificate":{ "type":"string", "description":"The resource's or account's VAT certificate." }, "billStructure":{ "$ref":"#/components/schemas/BillStructureOracle_MVO" }, "serviceBillStructure":{ "$ref":"#/components/schemas/ServiceBillStructureOracle_MVO" }, "taxExemption":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificateOracle_MVO", "description":"The account's tax exemptions that the system can apply when calculating charges." } }, "contact":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactOracle_MVO", "description":"The account's contacts, for example, the accountant who authorizes payments." } }, "accountRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRelationshipOracle_MVO", "description":"The account's relationships, for example, billing accounts that contribute to a financial account." } } } } ] }, "BillingCycleSpecification":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "nullable":true, "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "nullable":true, "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "nullable":true, "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "nullable":true, "description":"The billing cycle frequency, for example monthly." }, "paymentDueDateOffset":{ "type":"integer", "nullable":true, "description":"The payment due date offset, expressed in days from the start of the billing period." } } } ] }, "BillingCycleSpecificationOracle":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "nullable":true, "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "nullable":true, "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "nullable":true, "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "nullable":true, "enum":[ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ], "description":"The billing cycle frequency, for example monthly." }, "paymentDueDateOffset":{ "type":"integer", "nullable":true, "description":"The payment due date offset, expressed in days from the start of the billing period." } } } ] }, "BillingCycleSpecificationAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingCycleSpecificationAttributeValueChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingCycleSpecificationAttributeValueChangeEventPayload" } } } ] }, "BillingCycleSpecificationAttributeValueChangeEventPayload":{ "type":"object", "description":"Represents the BillingCycleSpecificationAttributeValueChangeEventPayload generic structure.", "properties":{ "billingCycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } }, "BillingCycleSpecificationCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingCycleSpecificationCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingCycleSpecificationCreateEventPayload" } } } ] }, "BillingCycleSpecificationCreateEventPayload":{ "type":"object", "description":"Represents the BillingCycleSpecificationCreateEventPayload generic structure.", "properties":{ "billingCycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } }, "BillingCycleSpecificationDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingCycleSpecificationDeleteEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingCycleSpecificationDeleteEventPayload" } } } ] }, "BillingCycleSpecificationDeleteEventPayload":{ "type":"object", "description":"Represents the BillingCycleSpecificationDeleteEventPayload generic structure.", "properties":{ "billingCycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } }, "BillingCycleSpecificationRef":{ "type":"object", "description":"Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillingCycleSpecificationRefOrValue":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } } }, "BillingCycleSpecificationRefOrValueOracle":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef" } } }, "BillingCycleSpecificationRefOrValue_FVO":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification_FVO" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification_FVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_FVO" } } }, "BillingCycleSpecificationRefOrValueOracle_FVO":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle_FVO" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification_FVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_FVO" } } }, "BillingCycleSpecificationRefOrValue_MVO":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification_MVO" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecification_MVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_MVO" } } }, "BillingCycleSpecificationRefOrValueOracle_MVO":{ "type":"object", "description":"The BillingCycleSpecification entity, not the BillingCycleSpecificationRefOrValue class, uses the polymorphic @type, @schemaLocation, and @referredType attributes.", "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle_MVO" }, { "$ref":"#/components/schemas/BillingCycleSpecificationRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingCycleSpecification":"#/components/schemas/BillingCycleSpecificationOracle_MVO", "BillingCycleSpecificationRef":"#/components/schemas/BillingCycleSpecificationRef_MVO" } } }, "BillingCycleSpecificationRef_FVO":{ "type":"object", "description":"Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "BillingCycleSpecificationRef_MVO":{ "type":"object", "description":"Refers to a billing cycle specification. Describes when to initiate a billing cycle and its substeps.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "BillingCycleSpecificationStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the BillingCycleSpecificationStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/BillingCycleSpecificationStateChangeEventPayload" } } } ] }, "BillingCycleSpecificationStateChangeEventPayload":{ "type":"object", "description":"Represents the BillingCycleSpecificationStateChangeEventPayload generic structure.", "properties":{ "billingCycleSpecification":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } }, "BillingCycleSpecification_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "description":"The billing cycle frequency, for example monthly." }, "paymentDueDateOffset":{ "type":"integer", "description":"The payment due date offset, expressed in days from the start of the billing period." } }, "required":[ "name" ] } ] }, "BillingCycleSpecificationOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "enum":[ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ], "description":"The billing cycle frequency, for example monthly." }, "paymentDueDateOffset":{ "type":"integer", "description":"The payment due date offset, expressed in days from the start of the billing period." } }, "required":[ "name" ] } ] }, "BillingCycleSpecification_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "description":"The billing cycle frequency, for example monthly." }, "paymentDueDateOffset":{ "type":"integer", "description":"The payment due date offset, expressed in days from the start of the billing period." } } } ] }, "BillingCycleSpecificationOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Describes when to initiate a billing cycle and its substeps.", "properties":{ "name":{ "type":"string", "description":"The billing cycle specification's short descriptive name." }, "billingDateShift":{ "type":"integer", "description":"The billing or settlement date offset, expressed in days from the start of the billing or settlement period." }, "description":{ "type":"string", "description":"The billing cycle specification's explanatory text." }, "frequency":{ "type":"string", "description":"The billing cycle frequency, for example monthly.", "enum":[ "monthly", "bi-monthly", "quarterly", "semiyearly", "yearly" ] }, "paymentDueDateOffset":{ "type":"integer", "description":"The payment due date offset, expressed in days from the start of the billing period." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ] }, "Characteristic":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes a given characteristic of an object or entity through a name/value pair.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "name":{ "type":"string", "description":"The characteristic's name." }, "valueType":{ "type":"string", "description":"The characteristic value's data type." }, "characteristicRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicRelationship" } } } } ] }, "CharacteristicRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"The related characteristic.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "relationshipType":{ "type":"string", "description":"The relationship type." } } } ] }, "CharacteristicRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"The related characteristic.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "relationshipType":{ "type":"string", "description":"The relationship type." } }, "required":[ "id", "relationshipType" ] } ] }, "CharacteristicRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"The related characteristic.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "relationshipType":{ "type":"string", "description":"The relationship type." } }, "required":[ "id", "relationshipType" ] } ] }, "Characteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes a given characteristic of an object or entity through a name/value pair.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "name":{ "type":"string", "description":"The characteristic's name." }, "valueType":{ "type":"string", "description":"The characteristic value's data type." }, "characteristicRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicRelationship_FVO" } } }, "required":[ "name" ] } ] }, "Characteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes a given characteristic of an object or entity through a name/value pair.", "properties":{ "id":{ "type":"string", "description":"The characteristic's ID." }, "name":{ "type":"string", "description":"The characteristic's name." }, "valueType":{ "type":"string", "description":"The characteristic value's data type." }, "characteristicRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicRelationship_MVO" } } }, "required":[ "name" ] } ] }, "Contact":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an individual or organization that serves as an account contact through a contact medium.", "properties":{ "contactName":{ "type":"string", "nullable":true, "description":"The contact's display name." }, "contactType":{ "type":"string", "nullable":true, "description":"The contact type, for example primary secondary." }, "contactMedium":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/ContactMedium", "description":"The contact's contact media, for example mobile phone number email address." } } } } ] }, "ContactMedium":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "id":{ "type":"string", "description":"The contact medium's ID." } } } ] }, "ContactMedium_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "id":{ "type":"string", "description":"The contact medium's ID." } } } ] }, "ContactMediumOracle_FVO":{ "allOf":[ { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "mediumType":{ "type":"string", "enum":[ "PostalAddress", "Phone", "Email", "Fax" ], "description":"The contact medium type." }, "company":{ "type":"string", "description":"The associated company name." }, "geoCode":{ "type":"string", "description":"The geographic address contact medium code." }, "phoneType":{ "type":"string", "enum":[ "email", "home", "work", "pager", "portable", "pop", "support" ], "description":"The phone type classification, for example home work fax." } } } ], "required":[ "mediumType" ] }, "ContactMediumOracle":{ "allOf":[ { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "mediumType":{ "type":"string", "nullable":true, "enum":[ "PostalAddress", "Phone", "Email", "Fax" ], "description":"The contact medium type." }, "company":{ "type":"string", "nullable":true, "description":"The associated company name." }, "geoCode":{ "type":"string", "nullable":true, "description":"The address geographic code." }, "phoneType":{ "type":"string", "nullable":true, "enum":[ "home", "work", "pager", "portable", "pop", "support" ], "description":"The phone type classification, for example home work fax." } } } ] }, "ContactMedium_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "id":{ "type":"string", "description":"The contact medium's ID." } } } ] }, "ContactMediumOracle_MVO":{ "allOf":[ { "type":"object", "description":"Indicates the contact medium that can contact the party.", "properties":{ "mediumType":{ "type":"string", "enum":[ "PostalAddress", "Phone", "Email", "Fax" ], "description":"The contact medium type." }, "company":{ "type":"string", "description":"The associated company name." }, "geoCode":{ "type":"string", "description":"The address geographic code." }, "phoneType":{ "type":"string", "enum":[ "home", "work", "pager", "portable", "pop", "support" ], "description":"The phone type classification, for example home work fax." } } } ] }, "Contact_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents an individual or organization that serves as an account contact through a contact medium.", "properties":{ "id":{ "type":"string", "description":"The contact's ID within the contact list." }, "contactName":{ "type":"string", "description":"The contact's display name." }, "contactType":{ "type":"string", "description":"The contact type, for example primary secondary." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_FVO", "description":"The contact's contact media, for example mobile phone number email address." } } }, "required":[ "contactType" ] } ] }, "ContactOracle_FVO":{ "allOf":[ { "type":"object", "description":"Represents an individual or organization that serves as an account contact through a contact medium.", "properties":{ "salutation":{ "type":"string", "description":"The contact's salutation." }, "contactName":{ "type":"string", "description":"The contact's name." }, "contactType":{ "type":"string", "description":"The contact type." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMediumOracle_FVO" } } } } ] }, "ContactOracle":{ "allOf":[ { "type":"object", "description":"Represents account contacts accessed through contact media.\n", "properties":{ "salutation":{ "type":"string", "nullable":true, "description":"The contact's salutation." }, "contactName":{ "type":"string", "nullable":true, "description":"The contact's name." }, "contactType":{ "type":"string", "nullable":true, "description":"The contact type." }, "contactMedium":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/ContactMediumOracle" } } } } ] }, "Contact_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an individual or organization that serves as an account contact through a contact medium.", "properties":{ "id":{ "type":"string", "description":"The contact's ID within the contact list." }, "contactName":{ "type":"string", "description":"The contact's display name." }, "contactType":{ "type":"string", "description":"The contact type, for example primary secondary." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_MVO", "description":"The contact's contact media, for example mobile phone number email address." } } } } ] }, "ContactOracle_MVO":{ "allOf":[ { "type":"object", "description":"Represents an individual or organization that serves as an account contact through a contact medium.", "properties":{ "salutation":{ "type":"string", "description":"The contact's salutation." }, "contactName":{ "type":"string", "description":"The contact's name." }, "contactType":{ "type":"string", "description":"The contact type." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMediumOracle_MVO" } } } } ] }, "EmailContactMedium":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium" }, { "type":"object", "description":"Describes an email address that can contact a party.", "properties":{ "emailAddress":{ "type":"string", "nullable":true, "description":"The full email address in standard format." } } } ] }, "EmailContactMedium_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_FVO" }, { "type":"object", "description":"Describes an email address that can contact a party.", "properties":{ "emailAddress":{ "type":"string", "description":"The full email address in standard format." } } } ] }, "EmailContactMedium_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_MVO" }, { "type":"object", "description":"Describes an email address that can contact a party.", "properties":{ "emailAddress":{ "type":"string", "description":"The full email address in standard format." } } } ] }, "Entity":{ "type":"object", "description":"Represents a base entity schema for TM Forum Open APIs.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/Addressable" } ] }, "EntityRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/Addressable" }, { "type":"object", "description":"Represents an entity reference schema for EntityRef classes.", "properties":{ "id":{ "type":"string", "description":"The identifier of the referred entity." }, "href":{ "type":"string", "nullable":true, "description":"The URI of the referred entity." }, "name":{ "type":"string", "nullable":true, "description":"The referred entity's name." }, "@referredType":{ "type":"string", "nullable":true, "description":"The actual type of the target instance when needed for disambiguation." } }, "required":[ "id" ] } ] }, "EntityRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/Addressable_FVO" }, { "type":"object", "description":"Represents an entity reference schema for EntityRef classes.", "properties":{ "id":{ "type":"string", "description":"The identifier of the referred entity." }, "href":{ "type":"string", "description":"The URI of the referred entity." }, "name":{ "type":"string", "description":"The referred entity's name." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } }, "required":[ "id" ] } ] }, "Entity_FVO":{ "type":"object", "description":"Represents a base entity schema for TM Forum Open APIs.", "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/Addressable_FVO" } ] }, "Entity_MVO":{ "type":"object", "description":"Represents a base entity schema for TM Forum Open APIs.", "allOf":[ { "$ref":"#/components/schemas/Extensible" } ] }, "Event":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an event with common attributes.", "properties":{ "href":{ "type":"string", "description":"The hyperlink reference." }, "id":{ "type":"string", "description":"The ID." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOccurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "source":{ "$ref":"#/components/schemas/EntityRef" }, "reportingSystem":{ "$ref":"#/components/schemas/EntityRef" }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "analyticCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" } }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "event":{ "description":"The event linked to the resource object.", "type":"object" } } } ] }, "Event_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an event with common attributes.", "properties":{ "href":{ "type":"string", "description":"The hyperlink reference." }, "id":{ "type":"string", "description":"The ID." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOccurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "source":{ "$ref":"#/components/schemas/EntityRef_FVO" }, "reportingSystem":{ "$ref":"#/components/schemas/EntityRef_FVO" }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO" } }, "analyticCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_FVO" } }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "event":{ "description":"The event linked to the resource object.", "type":"object" } }, "required":[ "eventId", "eventTime", "eventType", "event" ] } ] }, "Event_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents an event with common attributes.", "properties":{ "href":{ "type":"string", "description":"The hyperlink reference." }, "id":{ "type":"string", "description":"The ID." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's explanation." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOccurred":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "source":{ "$ref":"#/components/schemas/EntityRef" }, "reportingSystem":{ "$ref":"#/components/schemas/EntityRef" }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO" } }, "analyticCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_MVO" } }, "eventId":{ "type":"string", "description":"The notification's ID." }, "eventTime":{ "type":"string", "format":"date-time", "description":"The event's occurrence time." }, "eventType":{ "type":"string", "description":"The notification type." }, "event":{ "description":"The event linked to the resource object.", "type":"object" } }, "required":[ "eventId", "eventTime", "eventType", "event" ] } ] }, "Extensible":{ "type":"object", "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.", "properties":{ "@type":{ "type":"string", "nullable":true, "description":"The subclass Extensible name." }, "@baseType":{ "type":"string", "nullable":true, "description":"The superclass." }, "@schemaLocation":{ "type":"string", "nullable":true, "description":"The URI of a JSON Schema file that defines additional attributes and relationships." } }, "required":[ "@type" ] }, "Extensible_FVO":{ "type":"object", "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.", "properties":{ "@type":{ "type":"string", "description":"The subclass Extensible name." }, "@baseType":{ "type":"string", "description":"The superclass." }, "@schemaLocation":{ "type":"string", "description":"The URI of a JSON Schema file that defines additional attributes and relationships." } }, "required":[ "@type" ] }, "FaxContactMedium":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium" }, { "type":"object", "description":"Describes a fax that can contact a party.", "properties":{ "faxNumber":{ "type":"string", "description":"The contact's fax number." } } } ] }, "FaxContactMedium_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_FVO" }, { "type":"object", "description":"Describes a fax that can contact a party.", "properties":{ "faxNumber":{ "type":"string", "description":"The contact's fax number." } } } ] }, "FaxContactMedium_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_MVO" }, { "type":"object", "description":"Describes a fax that can contact a party.", "properties":{ "faxNumber":{ "type":"string", "description":"The contact's fax number." } } } ] }, "GeographicAddressContactMedium":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "city":{ "type":"string", "nullable":true, "description":"The city." }, "country":{ "type":"string", "nullable":true, "description":"The country." }, "postCode":{ "type":"string", "nullable":true, "description":"The postal code." }, "stateOrProvince":{ "type":"string", "nullable":true, "description":"The state or province." }, "street1":{ "type":"string", "nullable":true, "description":"The street." }, "street2":{ "type":"string", "nullable":true, "description":"The additional street address information." }, "canonCompany":{ "type":"string", "nullable":true, "description":"The canonical company." }, "canonCountry":{ "type":"string", "nullable":true, "description":"The canonical country." }, "geographicAddress":{ "nullable":true, "$ref":"#/components/schemas/GeographicAddressRef" } } } ] }, "GeographicAddressContactMedium_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_FVO" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "city":{ "type":"string", "description":"The city." }, "country":{ "type":"string", "description":"The country." }, "postCode":{ "type":"string", "description":"The postal code." }, "stateOrProvince":{ "type":"string", "description":"The state or province." }, "street1":{ "type":"string", "description":"The street." }, "street2":{ "type":"string", "description":"The additional street address information." }, "canonCompany":{ "type":"string", "description":"The canonical company." }, "canonCountry":{ "type":"string", "description":"The canonical country." }, "geographicAddress":{ "$ref":"#/components/schemas/GeographicAddressRef_FVO" } } } ] }, "GeographicAddressContactMediumOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/GeographicAddressContactMedium_FVO" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "company":{ "type":"string", "description":"The company." }, "geoCode":{ "type":"string", "description":"The geographic code." } } } ], "required":[ "street1", "city", "company", "geoCode", "stateOrProvince", "postCode", "country" ] }, "GeographicAddressContactMediumOracle":{ "allOf":[ { "$ref":"#/components/schemas/GeographicAddressContactMedium" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "company":{ "type":"string", "nullable":true, "description":"The company." }, "geoCode":{ "type":"string", "nullable":true, "description":"The geographic code." } } } ] }, "GeographicAddressContactMedium_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_MVO" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "city":{ "type":"string", "description":"The city." }, "country":{ "type":"string", "description":"The country." }, "postCode":{ "type":"string", "description":"The postal code." }, "stateOrProvince":{ "type":"string", "description":"The state or province." }, "street1":{ "type":"string", "description":"The street." }, "street2":{ "type":"string", "description":"The additional street address information." }, "canonCompany":{ "type":"string", "description":"The canonical company." }, "canonCountry":{ "type":"string", "description":"The canonical country." }, "geographicAddress":{ "$ref":"#/components/schemas/GeographicAddressRef_MVO" } } } ] }, "GeographicAddressContactMediumOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/GeographicAddressContactMedium_MVO" }, { "type":"object", "description":"Describes a geographic address that can contact a party.", "properties":{ "company":{ "type":"string", "description":"The company." }, "geoCode":{ "type":"string", "description":"The geographic code." } } } ] }, "GeographicAddressRef":{ "type":"object", "description":"Refers to a geographic address.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "GeographicAddressRef_FVO":{ "type":"object", "description":"Refers to a geographic address.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "GeographicAddressRef_MVO":{ "type":"object", "description":"Refers to a geographic address.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "Money":{ "type":"object", "description":"Represents a monetary amount.", "properties":{ "unit":{ "type":"string", "nullable":true, "description":"The currency's ISO 4217 three-letter code." }, "value":{ "type":"number", "nullable":true, "format":"double", "description":"A signed floating-point number whose sign depends on the API context." } } }, "PartyAccount":{ "allOf":[ { "$ref":"#/components/schemas/Account" }, { "type":"object", "description":"Represents an account used for billing or settlement purposes for a party. Specializes Account.", "properties":{ "billStructure":{ "type":"object", "nullable":true, "allOf":[ { "$ref":"#/components/schemas/BillStructure" } ] } } } ] }, "PartyAccountAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the PartyAccountAttributeValueChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/PartyAccountAttributeValueChangeEventPayload" } } } ] }, "PartyAccountAttributeValueChangeEventPayload":{ "type":"object", "description":"Represents the PartyAccountAttributeValueChangeEventPayload generic structure.", "properties":{ "partyAccount":{ "$ref":"#/components/schemas/PartyAccount" } } }, "PartyAccountCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the PartyAccountCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/PartyAccountCreateEventPayload" } } } ] }, "PartyAccountCreateEventPayload":{ "type":"object", "description":"Represents the PartyAccountCreateEventPayload generic structure.", "properties":{ "partyAccount":{ "$ref":"#/components/schemas/PartyAccount" } } }, "PartyAccountDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the PartyAccountDeleteEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/PartyAccountDeleteEventPayload" } } } ] }, "PartyAccountDeleteEventPayload":{ "type":"object", "description":"Represents the PartyAccountDeleteEventPayload generic structure.", "properties":{ "partyAccount":{ "$ref":"#/components/schemas/PartyAccount" } } }, "PartyAccountStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Represents the PartyAccountStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/PartyAccountStateChangeEventPayload" } } } ] }, "PartyAccountStateChangeEventPayload":{ "type":"object", "description":"Represents the PartyAccountStateChangeEventPayload generic structure.", "properties":{ "partyAccount":{ "$ref":"#/components/schemas/PartyAccount" } } }, "PartyAccount_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Account_FVO" }, { "type":"object", "description":"Represents an account used for billing or settlement purposes for a party. Specializes Account.", "properties":{ "billStructure":{ "$ref":"#/components/schemas/BillStructure_FVO" } }, "required":[ "name", "relatedParty" ] } ] }, "PartyAccount_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Account_MVO" }, { "type":"object", "description":"Represents an account used for billing or settlement purposes for a party. Specializes Account.", "properties":{ "billStructure":{ "$ref":"#/components/schemas/BillStructure_MVO" } } } ] }, "PartyRef":{ "type":"object", "description":"Refers to a party.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "PartyRefOrPartyRoleRef":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef" }, { "$ref":"#/components/schemas/PartyRoleRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } } }, "PartyRefOrPartyRoleRef_FVO":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef_FVO" }, { "$ref":"#/components/schemas/PartyRoleRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef_FVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_FVO" } } }, "PartyRefOrPartyRoleRefOracle":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef" }, { "$ref":"#/components/schemas/PartyRoleRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef" } } }, "PartyRefOrPartyRoleRef_MVO":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef_MVO" }, { "$ref":"#/components/schemas/PartyRoleRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef_MVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_MVO" } } }, "PartyRef_FVO":{ "type":"object", "description":"Refers to a party.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "PartyRef_MVO":{ "type":"object", "description":"Refers to a party.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "PartyRoleRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Refers to a party role. A party role represents the part that a party plays in a context.", "properties":{ "partyId":{ "type":"string", "description":"The engaged party's ID." }, "partyName":{ "type":"string", "nullable":true, "description":"The engaged party's name." } } } ] }, "PartyRoleRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"Refers to a party role. A party role represents the part that a party plays in a context.", "properties":{ "partyId":{ "type":"string", "description":"The engaged party's ID." }, "partyName":{ "type":"string", "description":"The engaged party's name." } } } ] }, "PartyRoleRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Refers to a party role. A party role represents the part that a party plays in a context.", "properties":{ "partyId":{ "type":"string", "description":"The engaged party's ID." }, "partyName":{ "type":"string", "description":"The engaged party's name." } } } ] }, "PaymentMethodRef":{ "type":"object", "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "PaymentMethodRef_FVO":{ "type":"object", "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "PaymentMethodRef_MVO":{ "type":"object", "description":"PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ] }, "PaymentPlan":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Defines a plan that spreads a party payments.", "properties":{ "id":{ "type":"string", "description":"The payment plan's ID within the plan list." }, "numberOfPayments":{ "type":"integer", "description":"The number of payments that spread the total payment." }, "paymentFrequency":{ "type":"string", "description":"The payment frequency, for example monthly bimonthly." }, "priority":{ "type":"integer", "description":"The payment plan's priority." }, "status":{ "type":"string", "description":"The payment plan's status. Examples effective ineffective." }, "totalAmount":{ "$ref":"#/components/schemas/Money" }, "planType":{ "type":"string", "description":"The payment plan's type." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "paymentMethod":{ "$ref":"#/components/schemas/PaymentMethodRef" } } } ] }, "PaymentPlan_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Defines a plan that spreads a party payments.", "properties":{ "id":{ "type":"string", "description":"The payment plan's ID within the plan list." }, "numberOfPayments":{ "type":"integer", "description":"The number of payments that spread the total payment." }, "paymentFrequency":{ "type":"string", "description":"The payment frequency, for example monthly bimonthly." }, "priority":{ "type":"integer", "description":"The payment plan's priority." }, "status":{ "type":"string", "description":"The payment plan's status. Examples effective ineffective." }, "totalAmount":{ "$ref":"#/components/schemas/Money" }, "planType":{ "type":"string", "description":"The payment plan's type." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "paymentMethod":{ "$ref":"#/components/schemas/PaymentMethodRef_FVO" } } } ] }, "PaymentPlan_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Defines a plan that spreads a party payments.", "properties":{ "id":{ "type":"string", "description":"The payment plan's ID within the plan list." }, "numberOfPayments":{ "type":"integer", "description":"The number of payments that spread the total payment." }, "paymentFrequency":{ "type":"string", "description":"The payment frequency, for example monthly bimonthly." }, "priority":{ "type":"integer", "description":"The payment plan's priority." }, "status":{ "type":"string", "description":"The payment plan's status. Examples effective ineffective." }, "totalAmount":{ "$ref":"#/components/schemas/Money" }, "planType":{ "type":"string", "description":"The payment plan's type." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "paymentMethod":{ "$ref":"#/components/schemas/PaymentMethodRef_MVO" } } } ] }, "PhoneContactMedium":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneNumber":{ "type":"string", "nullable":true, "description":"The contact's phone number." } } } ] }, "PhoneContactMedium_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_FVO" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneNumber":{ "type":"string", "description":"The contact's phone number." } } } ] }, "PhoneContactMediumOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/PhoneContactMedium_FVO" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneType":{ "type":"string", "description":"The phone number type." } } } ], "required":[ "phoneNumber" ] }, "PhoneContactMedium_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ContactMedium_MVO" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneNumber":{ "type":"string", "description":"The contact's phone number." } } } ] }, "PhoneContactMediumOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/PhoneContactMedium_MVO" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneType":{ "type":"string", "description":"The phone number type." } } } ] }, "PhoneContactMediumOracle":{ "allOf":[ { "$ref":"#/components/schemas/PhoneContactMedium" }, { "type":"object", "description":"Describes a phone number that can contact a party.", "properties":{ "phoneType":{ "type":"string", "nullable":true, "description":"The phone number type." } } } ] }, "Quantity":{ "type":"object", "description":"Represents an amount in a specified unit.", "properties":{ "amount":{ "type":"number", "nullable":true, "format":"double", "default":1, "description":"The numeric value in the specified unit." }, "units":{ "type":"string", "nullable":true, "description":"The unit." } } }, "RelatedPartyRefOrPartyRoleRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a related party or party role linked to a specific entity.", "properties":{ "role":{ "description":"The related party or party role role for the linked entity. Examples initiator customer salesAgent user.", "type":"string", "nullable":true }, "partyOrPartyRole":{ "nullable":true, "$ref":"#/components/schemas/PartyRefOrPartyRoleRef" } } } ] }, "RelatedPartyRefOrPartyRoleRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Refers to a related party or party role linked to a specific entity.", "properties":{ "role":{ "description":"The related party or party role role for the linked entity. Examples initiator customer salesAgent user.", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyRefOrPartyRoleRef_FVO" } }, "required":[ "role" ] } ] }, "RelatedPartyRefOrPartyRoleRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a related party or party role linked to a specific entity.", "properties":{ "role":{ "description":"The related party or party role role for the linked entity. Examples initiator customer salesAgent user.", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyRefOrPartyRoleRef_MVO" } } } ] }, "TaxDefinition":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax.", "properties":{ "id":{ "type":"string", "description":"The tax's ID." }, "name":{ "type":"string", "nullable":true, "description":"The tax's name." }, "validFor":{ "nullable":true, "$ref":"#/components/schemas/TimePeriod" }, "jurisdictionName":{ "type":"string", "nullable":true, "description":"The name of the jurisdiction that levies the tax.", "example":"USA" }, "jurisdictionLevel":{ "type":"string", "nullable":true, "description":"The level of the jurisdiction that levies the tax.", "example":"Country" }, "taxType":{ "type":"string", "nullable":true, "description":"The tax type.", "example":"VAT" }, "percent":{ "type":"integer", "nullable":true, "description":"The tax percentage." }, "issuingJurisdiction":{ "type":"string", "nullable":true, "description":"The tax issuing jurisdiction." }, "certificateNumber":{ "type":"string", "nullable":true, "description":"The certificate number." }, "reason":{ "type":"string", "nullable":true, "description":"The tax reason." } } } ] }, "TaxDefinition_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax." } ] }, "TaxDefinitionOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax.", "properties":{ "percent":{ "type":"number", "format":"double", "description":"The tax percentage." }, "Type":{ "type":"string", "enum":[ "federal", "state", "country", "city", "secondary country", "secondary city", "territory", "secondary state", "district", "secondary federal", "country district", "city district", "other" ], "description":"The tax issuing jurisdiction." } } } ], "required":[ "Type", "percent" ] }, "TaxDefinitionOracle":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax.", "properties":{ "percent":{ "type":"number", "nullable":true, "format":"double", "description":"The tax percentage." }, "Type":{ "type":"string", "nullable":true, "enum":[ "federal", "state", "country", "city", "secondary country", "secondary city", "territory", "secondary state", "district", "secondary federal", "country district", "city district", "other" ], "description":"The tax issuing jurisdiction." } } } ] }, "TaxDefinition_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax." } ] }, "TaxDefinitionOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Refers to a tax definition. A tax jurisdiction levies the tax.", "properties":{ "percent":{ "type":"number", "format":"double", "description":"The tax percentage." }, "Type":{ "type":"string", "enum":[ "federal", "state", "country", "city", "secondary country", "secondary city", "territory", "secondary state", "district", "secondary federal", "country district", "city district", "other" ], "description":"The tax issuing jurisdiction." } } } ] }, "TaxExemptionCertificate":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "properties":{ "id":{ "type":"string", "description":"The tax exemption's ID within the exemption list." }, "taxDefinition":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/TaxDefinition", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } }, "validFor":{ "nullable":true, "$ref":"#/components/schemas/TimePeriod" }, "certificateNumber":{ "type":"string", "nullable":true, "description":"The ID of the document that proves a tax exemption for the taxing jurisdiction." }, "issuingJurisdiction":{ "type":"string", "nullable":true, "description":"The name of the jurisdiction that issued the exemption.", "example":"USA" }, "reason":{ "type":"string", "nullable":true, "description":"The reason for the tax exemption." }, "attachment":{ "nullable":true, "$ref":"#/components/schemas/AttachmentRefOrValue" } } } ] }, "TaxExemptionCertificate_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "properties":{ "id":{ "type":"string", "description":"The tax exemption's ID within the exemption list." }, "taxDefinition":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxDefinition_FVO", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "certificateNumber":{ "type":"string", "description":"The ID of the document that proves a tax exemption for the taxing jurisdiction." }, "issuingJurisdiction":{ "type":"string", "description":"The name of the jurisdiction that issued the exemption.", "example":"USA" }, "reason":{ "type":"string", "description":"The reason for the tax exemption." } } } ] }, "TaxExemptionCertificateOracle_FVO":{ "allOf":[ { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "properties":{ "id":{ "type":"string", "description":"The tax exemption's ID within the exemption list." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "certificateNumber":{ "type":"string", "description":"The ID of the document that proves a tax exemption for the taxing jurisdiction." }, "issuingJurisdiction":{ "type":"string", "description":"The name of the jurisdiction that issued the exemption.", "example":"USA" }, "reason":{ "type":"string", "description":"The reason for the tax exemption." }, "taxDefinition":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxDefinitionOracle_FVO", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } } } } ] }, "TaxExemptionCertificateOracle":{ "allOf":[ { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "allOf":[ { "$ref":"#/components/schemas/Entity" } ], "properties":{ "id":{ "type":"string", "description":"The tax exemption's ID within the exemption list." }, "validFor":{ "nullable":true, "$ref":"#/components/schemas/TimePeriod" }, "certificateNumber":{ "type":"string", "nullable":true, "description":"The ID of the document that proves a tax exemption for the taxing jurisdiction." }, "issuingJurisdiction":{ "type":"string", "nullable":true, "description":"The name of the jurisdiction that issued the exemption.", "example":"USA" }, "reason":{ "type":"string", "nullable":true, "description":"The reason for the tax exemption." }, "taxDefinition":{ "type":"array", "nullable":true, "items":{ "nullable":true, "$ref":"#/components/schemas/TaxDefinitionOracle", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } } } } ] }, "TaxExemptionCertificate_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "properties":{ "id":{ "type":"string", "description":"The tax exemption's ID within the exemption list." }, "taxDefinition":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxDefinition_MVO", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "certificateNumber":{ "type":"string", "description":"The ID of the document that proves a tax exemption for the taxing jurisdiction." }, "issuingJurisdiction":{ "type":"string", "description":"The name of the jurisdiction that issued the exemption.", "example":"USA" }, "reason":{ "type":"string", "description":"The reason for the tax exemption." } } } ] }, "TaxExemptionCertificateOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/TaxExemptionCertificate_MVO" }, { "type":"object", "description":"Represents a tax exemption certificate granted by a tax jurisdiction. Defines the exempt portion of each tax.", "properties":{ "taxDefinition":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxDefinitionOracle_MVO", "description":"A list of taxes that are covered by the exemption, e.g. City Tax, State Tax. The definition would include the exemption (e.g. for a rate exemption 0% would be a full exemption, 5% could be a partial exemption if the actual rate was 10%)." } } } } ] }, "TimePeriod":{ "type":"object", "description":"Represents a time period with a start date, an end date, or both.", "properties":{ "startDateTime":{ "description":"The start of the time period in IETF RFC 3339 format.", "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z" }, "endDateTime":{ "description":"The end of the time period in IETF RFC 3339 format.", "type":"string", "nullable":true, "format":"date-time", "example":"1985-04-12T23:20:50.52Z" } } }, "Error":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "required":[ "code", "reason" ], "properties":{ "code":{ "type":"string", "description":"The application-specific error detail defined by the API or a common list." }, "reason":{ "type":"string", "description":"Explains the error to a client user." }, "message":{ "type":"string", "description":"Provides error details and corrective actions for a client user." }, "status":{ "type":"string", "description":"The HTTP error code extension." }, "referenceError":{ "type":"string", "description":"The URI of documentation that describes the error." } } } ], "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code." }, "Hub_FVO":{ "type":"object", "description":"Specifies the communication endpoint address that the service instance uses to deliver notifications.", "required":[ "callback" ], "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "properties":{ "callback":{ "type":"string", "description":"The callback being registered." }, "query":{ "type":"string", "description":"The additional data to pass." } } } ] }, "Hub":{ "type":"object", "description":"Specifies the communication endpoint address that the service instance uses to deliver notifications.", "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "properties":{ "id":{ "type":"string", "description":"The listener's ID." }, "callback":{ "type":"string", "description":"The callback being registered." }, "query":{ "type":"string", "description":"The additional data to pass." } }, "required":[ "callback" ] } ] }, "JsonPatch":{ "type":"object", "description":"A JSON Patch document as defined by RFC 6902.", "required":[ "op", "path" ], "properties":{ "op":{ "type":"string", "description":"The operation to perform.", "enum":[ "add", "remove", "replace", "move", "copy", "test" ] }, "path":{ "type":"string", "description":"A JSON Pointer." }, "value":{ "description":"The value to use in the operation." }, "from":{ "type":"string", "description":"A string that contains a JSON Pointer value." } } }, "JsonPatchOperations":{ "description":"A JSON Patch operations document as defined by RFC 6902.", "type":"array", "items":{ "$ref":"#/components/schemas/JsonPatch" } }, "AgreementItemRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An agreement item that has been run previously.", "properties":{ "agreementName":{ "type":"string", "description":"The related entity's name." }, "agreementHref":{ "type":"string", "description":"The related entity's reference link." }, "@referredType":{ "type":"string", "description":"The target instance's type when needed for disambiguation." }, "agreementId":{ "type":"string", "description":"The related entity's unique ID." }, "agreementItemId":{ "type":"string", "description":"An agreement item's ID." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementItemRef":"#/components/schemas/AgreementItemRef" } } }, "AgreementItemRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"An agreement item that has been previously run.", "properties":{ "agreementName":{ "type":"string", "description":"The related entity's name." }, "agreementHref":{ "type":"string", "description":"The related entity's reference link." }, "@referredType":{ "type":"string", "description":"The target instance's type when needed for disambiguation." }, "agreementId":{ "type":"string", "description":"The related entity's ID." }, "agreementItemId":{ "type":"string", "description":"The item ID for the agreement." } }, "required":[ "agreementId", "agreementItemId" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementItemRef":"#/components/schemas/AgreementItemRef_FVO" } } }, "AgreementItemRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"It's a Agreement item that has been executed previously.", "properties":{ "agreementName":{ "type":"string", "description":"The related entity's name." }, "agreementHref":{ "type":"string", "description":"The related entity's reference link." }, "@referredType":{ "type":"string", "description":"The target instance's type when needed for disambiguation." }, "agreementId":{ "type":"string", "description":"The related entity's ID." }, "agreementItemId":{ "type":"string", "description":"The item ID for the agreement." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementItemRef":"#/components/schemas/AgreementItemRef_MVO" } } }, "AgreementRef":{ "type":"object", "description":"Refers to the agreement. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service-level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementRef":"#/components/schemas/AgreementRef" } } }, "AgreementRef_FVO":{ "type":"object", "description":"Refers to the agreement. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service-level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementRef":"#/components/schemas/AgreementRef_FVO" } } }, "AgreementRef_MVO":{ "type":"object", "description":"Refers to the agreement. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service-level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "AgreementRef":"#/components/schemas/AgreementRef_MVO" } } }, "BillingAccountRef":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Refers to the billing account. The billing account describes the bill structure.", "properties":{ "ratingType":{ "type":"string", "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingAccountRef":"#/components/schemas/BillingAccountRef" } } }, "BillingAccountRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"Refers to the billing account. The billing account describes the bill structure.", "properties":{ "ratingType":{ "type":"string", "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingAccountRef":"#/components/schemas/BillingAccountRef_FVO" } } }, "BillingAccountRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Refers to the billing account. The billing account describes the bill structure.", "properties":{ "ratingType":{ "type":"string", "description":"Indicates if the account follows a specific payment option such as prepaid or postpaid." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "BillingAccountRef":"#/components/schemas/BillingAccountRef_MVO" } } }, "CPUDatesExtension_FVO":{ "type":"object", "description":"Contains the CPU extension dates' common properties.", "properties":{ "amount":{ "type":"integer", "description":"Indicates the amount of time of a given unit." }, "unit":{ "type":"string", "description":"Indicates the unit of time for the CPU extension date. Can be \"seconds\", \"minutes\", \"hours\", \"days\", \"months\", \"acct_cycles\", \"first_usage\" and \"absolute\".", "enum":[ "seconds", "minutes", "hours", "days", "months", "acct_cycles", "first_usage", "absolute" ] } }, "required":[ "amount", "unit" ] }, "CPUDatesExtension_MVO":{ "type":"object", "description":"Contains common properties for all CPU extension date.", "properties":{ "amount":{ "type":"integer", "description":"Indicates the amount of time of a given unit." }, "unit":{ "type":"string", "description":"Indicates the unit of time for the CPU extension date: seconds, minutes, hours, days, months, acct_cycles, first_usage, or absolute.", "enum":[ "seconds", "minutes", "hours", "days", "months", "acct_cycles", "first_usage", "absolute" ] } }, "required":[ "amount", "unit" ] }, "CycleStartRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"CycleStart reference. A CycleStart contains details regarding cycle start date for purchased product." } ] }, "UsageStartRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"UsageStart reference. A UsageStart contains details regarding usage start date for purchased product." } ] }, "PurchaseStartRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"PurchaseStart reference. A PurchaseStart contains details regarding purchase start date for purchased product." } ] }, "CycleEndRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"CycleEnd reference. A CycleEnd contains details regarding cycle end date for purchased product." } ] }, "UsageEndRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"UsageEnd reference. A UsageEnd contains details regarding usage end date for purchased product." } ] }, "PurchaseEndRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product." } ] }, "GracePeriodRef":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"GracePeriod reference. A GracePeriod contains details regarding grace period date for purchased product." } ] }, "CycleStartRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"CycleStart reference. Provides details about the cycle start date for a purchased product." } ] }, "UsageStartRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"UsageStart reference. Provides details about the usage start date for a purchased product." } ] }, "PurchaseStartRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"PurchaseStart reference. Provides details about the purchase start date for a purchased product." } ] }, "CycleEndRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"CycleEnd reference. Provides details about the cycle end date for a purchased product" } ] }, "UsageEndRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"UsageEnd reference. Provides details about the usage end date for a purchased product." } ] }, "PurchaseEndRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"PurchaseEnd reference. Provides details about the purchase end date for a purchased product." } ] }, "GracePeriodRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_FVO" }, { "type":"object", "description":"GracePeriod reference. Provides details about the grace period date for a purchased product." } ] }, "CycleStartRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"CycleStart reference. Provides details about the cycle start date for a purchased product." } ] }, "UsageStartRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"UsageStart reference. Provides details about the usage start date for a purchased product." } ] }, "PurchaseStartRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"PurchaseStart reference. Provides details about the purchase start date for a purchased product." } ] }, "CycleEndRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"CycleEnd reference. Provides details about the cycle end date for a purchased product." } ] }, "UsageEndRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"UsageEnd reference. Provides details about the usage end date for a purchased product." } ] }, "PurchaseEndRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/CPUDatesExtension_MVO" }, { "type":"object", "description":"PurchaseEnd reference. A PurchaseEnd contains details regarding purchase end date for purchased product." } ] }, "BooleanArrayCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A characteristic which value is an array of Boolean(s).", "properties":{ "value":{ "type":"array", "items":{ "type":"boolean" } } } } ] }, "BooleanArrayCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic which value is an array of Boolean(s).", "properties":{ "value":{ "type":"array", "items":{ "type":"boolean" } } }, "required":[ "value" ] } ] }, "BooleanArrayCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic which value is an array of Boolean(s).", "properties":{ "value":{ "type":"array", "items":{ "type":"boolean" } } }, "required":[ "value" ] } ] }, "BooleanCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A characteristic which value is a Boolean.", "properties":{ "value":{ "type":"boolean", "description":"Value of the characteristic" } } } ] }, "BooleanCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic which value is a Boolean.", "properties":{ "value":{ "type":"boolean", "description":"Value of the characteristic" } }, "required":[ "value" ] } ] }, "BooleanCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic which value is a Boolean.", "properties":{ "value":{ "type":"boolean", "description":"Value of the characteristic" } }, "required":[ "value" ] } ] }, "BusinessPartner":{ "type":"object", "description":"Identifies the party role as a business partner.", "allOf":[ { "$ref":"#/components/schemas/PartyRole" } ] }, "BusinessPartner_FVO":{ "type":"object", "description":"Identifies the party role as a business partner.", "allOf":[ { "$ref":"#/components/schemas/PartyRole_FVO" } ] }, "BusinessPartner_MVO":{ "type":"object", "description":"Identifies the party role as a business partner.", "allOf":[ { "$ref":"#/components/schemas/PartyRole_MVO" } ] }, "CalendarPeriod":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "day":{ "type":"string", "description":"Specifies the days the calendar status applies to (for example: monday, mon-to-fri, weekdays, weekend, or all week)." }, "timeZone":{ "type":"string", "description":"Specifies the time zone applicable to the calendar information (for example: Paris or GMT+1)." }, "hourPeriod":{ "type":"array", "items":{ "$ref":"#/components/schemas/HourPeriod" } }, "status":{ "type":"string", "description":"Indicates the availability of the calendar period (for example: available or booked)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CalendarPeriod":"#/components/schemas/CalendarPeriod" } } }, "CalendarPeriod_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "properties":{ "day":{ "type":"string", "description":"Specifies the days the calendar status applies to (for example: monday, mon-to-fri, weekdays, weekend, or all week)." }, "timeZone":{ "type":"string", "description":"Specifies the time zone applicable to the calendar information (for example: Paris or GMT+1)." }, "hourPeriod":{ "type":"array", "items":{ "$ref":"#/components/schemas/HourPeriod_FVO" } }, "status":{ "type":"string", "description":"Indicates the availability of the calendar period (for example: available or booked)." } }, "required":[ "status" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CalendarPeriod":"#/components/schemas/CalendarPeriod_FVO" } } }, "CalendarPeriod_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "day":{ "type":"string", "description":"Specifies the days the calendar status applies to (for example: monday, mon-to-fri, weekdays, weekend, or all week)." }, "timeZone":{ "type":"string", "description":"Specifies the time zone applicable to the calendar information (for example: Paris or GMT+1)." }, "hourPeriod":{ "type":"array", "items":{ "$ref":"#/components/schemas/HourPeriod_MVO" } }, "status":{ "type":"string", "description":"Indicates the availability of the calendar period (for example: available or booked)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CalendarPeriod":"#/components/schemas/CalendarPeriod_MVO" } } }, "Consumer":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole" } ] }, "Consumer_FVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole_FVO" } ] }, "Consumer_MVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole_MVO" } ] }, "CreditProfile":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Provides the party’s credit profile (including credit scoring). By default, only the current credit profile is retrieved. When returned as a list, it represents the party’s credit profile history, with the first entry as the current profile.", "properties":{ "creditProfileDate":{ "type":"string", "format":"date-time", "description":"The date the profile was established." }, "creditRiskRating":{ "type":"integer", "description":"An integer used to rate risk." }, "creditScore":{ "type":"integer", "description":"A measure of a person’s or organization’s creditworthiness, calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CreditProfile":"#/components/schemas/CreditProfile" } } }, "CreditProfile_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Provides the party’s credit profile (including credit scoring). By default, only the current credit profile is retrieved. When returned as a list, it represents the party’s credit profile history, with the first entry as the current profile.", "properties":{ "creditProfileDate":{ "type":"string", "format":"date-time", "description":"The date the profile was established" }, "creditRiskRating":{ "type":"integer", "description":"An integer used to rate risk." }, "creditScore":{ "type":"integer", "description":"A measure of a person’s or organization’s creditworthiness, calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CreditProfile":"#/components/schemas/CreditProfile_FVO" } } }, "CreditProfile_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Provides the party’s credit profile (including credit scoring). By default, only the current credit profile is retrieved. When returned as a list, it represents the party’s credit profile history, with the first entry as the current profile.", "properties":{ "creditProfileDate":{ "type":"string", "format":"date-time", "description":"The date the profile was established." }, "creditRiskRating":{ "type":"integer", "description":"An integer used to rate risk." }, "creditScore":{ "type":"integer", "description":"A measure of a person’s or organization’s creditworthiness, calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "CreditProfile":"#/components/schemas/CreditProfile_MVO" } } }, "Disability":{ "type":"object", "description":"Lack or inadequate strength or ability.", "properties":{ "disabilityCode":{ "type":"string", "description":"The disability code." }, "disabilityName":{ "type":"string", "description":"The disability name." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } }, "Duration":{ "type":"object", "description":"A time interval expressed in a given unit of time.", "properties":{ "amount":{ "type":"integer", "description":"The time interval amount (for example: seconds, minutes, or hours)." }, "units":{ "type":"string", "description":"The unit of time (for example: seconds, minutes, or hours)." } } }, "EntityRelationship":{ "type":"object", "description":"Defines a unidirectional relationship from this entity to a target entity instance.", "properties":{ "href":{ "type":"string", "description":"The URL to the entity." }, "name":{ "type":"string", "description":"The name of the entity." }, "role":{ "type":"string", "description":"The association role for this entity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "associationSpec":{ "$ref":"#/components/schemas/EntityRef" }, "@baseType":{ "type":"string", "description":"When subclassing, defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"Provides a URI to a JSON schema file that defines additional attributes and relationships." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: migration, substitution, dependency, or exclusivity)." }, "id":{ "type":"string", "description":"The ID of the entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "@type":{ "type":"string", "description":"The class type of the target instance." } } }, "EntityRelationship_FVO":{ "type":"object", "description":"Defines a unidirectional relationship from this entity to a target entity instance.", "properties":{ "href":{ "type":"string", "description":"The URL to the entity." }, "name":{ "type":"string", "description":"The name of the entity." }, "role":{ "type":"string", "description":"The association role for this entity." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "associationSpec":{ "$ref":"#/components/schemas/EntityRef_FVO" }, "@baseType":{ "type":"string", "description":"When subclassing, defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"Provides a URI to a JSON Schema file that defines additional attributes and relationships." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: migration, substitution, dependency, or exclusivity)." }, "id":{ "type":"string", "description":"The ID of the entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "@type":{ "type":"string", "description":"The class type of the target instance." } }, "required":[ "relationshipType", "id", "@referredType", "@type" ] }, "EntityRelationship_MVO":{ "type":"object", "description":"Defines a unidirectional relationship from this entity to a target entity instance.", "properties":{ "href":{ "type":"string", "description":"The URL to the entity." }, "name":{ "type":"string", "description":"The name of the entity." }, "role":{ "type":"string", "description":"The association role for this entity." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "associationSpec":{ "$ref":"#/components/schemas/EntityRef" }, "@baseType":{ "type":"string", "description":"When subclassing, defines the super-class." }, "@schemaLocation":{ "type":"string", "description":"Provides a URI to a JSON schema file that defines additional attributes and relationships." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: migration, substitution, dependency, or exclusivity)." }, "id":{ "type":"string", "description":"The ID of the entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "@type":{ "type":"string", "description":"The class type of the target instance." } } }, "Expression":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents the ontology-encoded form of the intent.", "properties":{ "expressionLanguage":{ "$ref":"#/components/schemas/ExpressionLanguageEnum" }, "iri":{ "type":"string", "description":"Internationalized Resource Identifier (IRI) of the intent expression." }, "expressionValue":{ "type":"string", "description":"Contains the ontology-encoded form of the Intent (for example: RDF-XML, Turtle, or JSON-LD)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Expression":"#/components/schemas/Expression" } } }, "ExpressionLanguageEnum":{ "enum":[ "Turtle", "JSON-LD", "RDF-XML", "Other" ], "type":"string", "description":"Lists possible values for the serialized expression language of an Intent or Intent report." }, "Expression_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents the ontology-encoded form of the Intent.", "properties":{ "expressionLanguage":{ "$ref":"#/components/schemas/ExpressionLanguageEnum" }, "iri":{ "type":"string", "description":"Internationalized Resource Identifier (IRI) of the Intent expression." }, "expressionValue":{ "type":"string", "description":"Contains the ontology-encoded form of the Intent (for example: RDF-XML, Turtle, or JSON-LD)." } }, "required":[ "@type", "expressionValue" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Expression":"#/components/schemas/Expression_FVO" } } }, "Expression_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents the ontology-encoded form of the Intent.", "properties":{ "expressionLanguage":{ "$ref":"#/components/schemas/ExpressionLanguageEnum" }, "iri":{ "type":"string", "description":"Internationalized Resource Identifier (IRI) of the Intent expression." }, "expressionValue":{ "type":"string", "description":"Contains the ontology-encoded form of the Intent (for example: RDF-XML, Turtle, or JSON-LD)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Expression":"#/components/schemas/Expression_MVO" } } }, "ExternalIdentifier":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Identifies an entity owned by or originating in an external system (for example: ProductOrder from a commerce platform). The structure identifies the external system, the entity type (for example: class name), and the entity’s unique ID. You can provide multiple external IDs for a single entity; list them in reverse order of provenance (most recent first).", "properties":{ "owner":{ "type":"string", "description":"The name of the external system that owns the entity.", "example":"MagentoCommerce" }, "externalIdentifierType":{ "type":"string", "description":"The identification type, typically the entity type within the external system.", "example":"ProductOrder" }, "id":{ "type":"string", "description":"The identifier of the entity within the external system." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ExternalIdentifier":"#/components/schemas/ExternalIdentifier" } } }, "ExternalIdentifier_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Identifies an entity owned by or originating in an external system (for example: ProductOrder from a commerce platform). The structure identifies the external system, the entity type (for example: class name), and the entity’s unique ID. You can provide multiple external IDs for a single entity; list them in reverse order of provenance (most recent first).", "properties":{ "owner":{ "type":"string", "description":"The name of the external system that owns the entity.", "example":"MagentoCommerce" }, "externalIdentifierType":{ "type":"string", "description":"The identification type, typically the entity type within the external system.", "example":"ProductOrder" }, "id":{ "type":"string", "description":"The identifier of the entity within the external system." } }, "required":[ "id" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ExternalIdentifier":"#/components/schemas/ExternalIdentifier_FVO" } } }, "ExternalIdentifier_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Identifies an entity owned by or originating in an external system (for example: ProductOrder from a commerce platform). The structure identifies the external system, the entity type (for example: class name), and the entity’s unique ID. You can provide multiple external IDs for a single entity; list them in reverse order of provenance (most recent first).", "properties":{ "owner":{ "type":"string", "description":"The name of the external system that owns the entity.", "example":"MagentoCommerce" }, "externalIdentifierType":{ "type":"string", "description":"The identification type, typically the entity type within the external system.", "example":"ProductOrder" }, "id":{ "type":"string", "description":"The identifier of the entity within the external system." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ExternalIdentifier":"#/components/schemas/ExternalIdentifier_MVO" } } }, "GeographicAddress":{ "allOf":[ { "$ref":"#/components/schemas/Place" }, { "type":"object", "description":"Provides a structured textual description of how to locate a property in an urban area (country properties are often defined differently). Note: Address corresponds to SID UrbanPropertyAddress.", "properties":{ "city":{ "type":"string", "description":"The city for the address." }, "country":{ "type":"string", "description":"The country for the address." }, "locality":{ "type":"string", "description":"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature [ANZLIC-STREET], or a suburb—a bounded locality within a city, town, or shire principally of urban character [ANZLICSTREET]." }, "postcode":{ "type":"string", "description":"A descriptor for a postal delivery area, used to speed and simplify mail delivery (also known as ZIP code)." }, "stateOrProvince":{ "type":"string", "description":"The state or province of the address." }, "streetName":{ "type":"string", "description":"Specifies the street name or type." }, "streetNr":{ "type":"string", "description":"Identifies the property number on a public street. You may combine it with streetNrLast for ranged addresses." }, "streetNrLast":{ "type":"string", "description":"Specifies the last number in a range of street numbers allocated to a property." }, "streetNrLastSuffix":{ "type":"string", "description":"Specifies the last street number suffix for a ranged address." }, "streetNrSuffix":{ "type":"string", "description":"Specifies the first street number suffix." }, "streetSuffix":{ "type":"string", "description":"Specifies a directional or other modifier." }, "streetType":{ "type":"string", "description":"Specifies the street type (for example: alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, or wharf). " }, "countryCode":{ "type":"array", "items":{ "$ref":"#/components/schemas/StandardIdentifier" }, "description":"Provides country codes—short alphabetic or numeric geocodes used in data processing and communications (for example: ISO 3166-1 alpha-2 and E.164 country calling codes)." }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier" } }, "geographicLocation":{ "$ref":"#/components/schemas/GeographicLocationRefOrValue" }, "geographicSubAddress":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSubAddress" } }, "geographicAddressType":{ "type":"string", "description":"Classifies the address (for example: residential or industrial)." } } } ] }, "GeographicAddress_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_FVO" }, { "type":"object", "description":"Provides a structured textual description of how to locate a property in an urban area (country properties are often defined differently). Note: Address corresponds to SID UrbanPropertyAddress.", "properties":{ "city":{ "type":"string", "description":"The city of the address." }, "country":{ "type":"string", "description":"The country of the address." }, "locality":{ "type":"string", "description":"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature [ANZLIC-STREET], or a suburb—a bounded locality within a city, town, or shire principally of urban character [ANZLICSTREET]." }, "postcode":{ "type":"string", "description":"A descriptor for a postal delivery area, used to speed and simplify mail delivery (also known as ZIP code)." }, "stateOrProvince":{ "type":"string", "description":"The state or province of the address." }, "streetName":{ "type":"string", "description":"Specifies the street name or type." }, "streetNr":{ "type":"string", "description":"Identifies the property number on a public street. You may combine it with streetNrLast for ranged addresses." }, "streetNrLast":{ "type":"string", "description":"Specifies the last number in a range of street numbers allocated to a property." }, "streetNrLastSuffix":{ "type":"string", "description":"Specifies the last street number suffix for a ranged address." }, "streetNrSuffix":{ "type":"string", "description":"Specifies the first street number suffix." }, "streetSuffix":{ "type":"string", "description":"Specifies a directional or other modifier." }, "streetType":{ "type":"string", "description":"Specifies the street type (for example: alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, or wharf)." }, "countryCode":{ "type":"array", "items":{ "$ref":"#/components/schemas/StandardIdentifier_FVO" }, "description":"Provides country codes - short alphabetic or numeric geocodes used in data processing and communications (for example: ISO 3166-1 alpha-2 and E.164 country calling codes)." }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_FVO" } }, "geographicLocation":{ "$ref":"#/components/schemas/GeographicLocationRefOrValue_FVO" }, "geographicSubAddress":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSubAddress_FVO" } }, "geographicAddressType":{ "type":"string", "description":"Classifies the address (for example: residential or industrial)." } } } ] }, "GeographicAddress_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_MVO" }, { "type":"object", "description":"Provides a structured textual description of how to locate a property in an urban area (country properties are often defined differently). Note: Address corresponds to SID UrbanPropertyAddress.", "properties":{ "city":{ "type":"string", "description":"The city of the address." }, "country":{ "type":"string", "description":"The country of the address." }, "locality":{ "type":"string", "description":"An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature [ANZLIC-STREET], or a suburb—a bounded locality within a city, town, or shire principally of urban character [ANZLICSTREET]." }, "postcode":{ "type":"string", "description":"A descriptor for a postal delivery area, used to speed and simplify mail delivery (also known as ZIP code)." }, "stateOrProvince":{ "type":"string", "description":"The state or province of the address." }, "streetName":{ "type":"string", "description":"Specifies the street name or type." }, "streetNr":{ "type":"string", "description":"Identifies the property number on a public street. You may combine it with streetNrLast for ranged addresses." }, "streetNrLast":{ "type":"string", "description":"Specifies the last number in a range of street numbers allocated to a property." }, "streetNrLastSuffix":{ "type":"string", "description":"Specifies the last street number suffix for a ranged address." }, "streetNrSuffix":{ "type":"string", "description":"Specifies the first street number suffix." }, "streetSuffix":{ "type":"string", "description":"Specifies a directional or other modifier." }, "streetType":{ "type":"string", "description":"Specifies the street type (for example: alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, or wharf). " }, "countryCode":{ "type":"array", "items":{ "$ref":"#/components/schemas/StandardIdentifier_MVO" }, "description":"Provides country codes - short alphabetic or numeric geocodes used in data processing and communications (for example: ISO 3166-1 alpha-2 and E.164 country calling codes)." }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_MVO" } }, "geographicLocation":{ "$ref":"#/components/schemas/GeographicLocationRefOrValue_MVO" }, "geographicSubAddress":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSubAddress_MVO" } }, "geographicAddressType":{ "type":"string", "description":"Classifies the address (for example: residential or industrial)." } } } ] }, "GeographicLocation":{ "allOf":[ { "$ref":"#/components/schemas/Place" }, { "type":"object", "description":"Provides a pure-virtual superclass for GeoJSON-aligned geometries - Point (addresses and locations), MultiPoint, LineString (streets, highways, and boundaries), MultiLineString, and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which geometry the geometry attribute uses.", "properties":{ "id":{ "type":"string", "description":"The geographic location's ID." }, "href":{ "type":"string", "description":"A URI used to access the geographic location resource." }, "@type":{ "type":"string", "enum":[ "GeoJsonPoint", "GeoJsonMultiPoint", "GeoJsonLineString", "GeoJsonMultiLineString", "GeoJsonPolygon" ], "description":"The name of the GeoJSON structure used in the geometry attribute." }, "bbox":{ "type":"array", "description":"Provides a bounding box that contains the geometry; the axis order follows that of the geometry.", "items":{ "type":"number", "description":"The axis numbers." } } } } ] }, "GeographicLocationRef":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocationRef":"#/components/schemas/GeographicLocationRef" } } }, "GeographicLocationRefOrValue":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the GeographicLocation entity, not to the GeographicLocationRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation" }, { "$ref":"#/components/schemas/GeographicLocationRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation", "GeographicLocationRef":"#/components/schemas/GeographicLocationRef" } } }, "GeographicLocationRefOrValue_FVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the GeographicLocation entity, not to the GeographicLocationRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation_FVO" }, { "$ref":"#/components/schemas/GeographicLocationRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation_FVO", "GeographicLocationRef":"#/components/schemas/GeographicLocationRef_FVO" } } }, "GeographicLocationRefOrValue_MVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the GeographicLocation entity, not to the GeographicLocationRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation_MVO" }, { "$ref":"#/components/schemas/GeographicLocationRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation_MVO", "GeographicLocationRef":"#/components/schemas/GeographicLocationRef_MVO" } } }, "GeographicLocationRef_FVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocationRef":"#/components/schemas/GeographicLocationRef_FVO" } } }, "GeographicLocationRef_MVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocationRef":"#/components/schemas/GeographicLocationRef_MVO" } } }, "GeographicLocation_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_FVO" }, { "type":"object", "description":"A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute.", "properties":{ "id":{ "type":"string", "description":"The geographic location's ID." }, "href":{ "type":"string", "description":"A URI used to access the geographic location resource." }, "@type":{ "type":"string", "enum":[ "GeoJsonPoint", "GeoJsonMultiPoint", "GeoJsonLineString", "GeoJsonMultiLineString", "GeoJsonPolygon" ], "description":"The name of the GeoJSON structure used in the geometry attribute." }, "bbox":{ "type":"array", "description":"Provides a bounding box that contains the geometry; the axis order follows that of the geometry.", "items":{ "type":"number", "description":"The axis numbers." } } }, "required":[ "@type" ] } ] }, "GeographicLocation_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_MVO" }, { "type":"object", "description":"A GeographicLocation is a pure-virtual super-class to the GeoJSON-aligned geometries of Point (addresses and locations), MultiPoint, LineString (streets, highways and boundaries), MultiLineString and Polygon (countries, provinces, tracts of land). Use the @type attribute to specify which of these is being specified by the geometry attribute.", "properties":{ "id":{ "type":"string", "description":"The geographic location's ID." }, "href":{ "type":"string", "description":"A URI used to access the geographic location resource." }, "@type":{ "type":"string", "enum":[ "GeoJsonPoint", "GeoJsonMultiPoint", "GeoJsonLineString", "GeoJsonMultiLineString", "GeoJsonPolygon" ], "description":"The name of the GeoJSON structure used in the geometry attribute." }, "bbox":{ "type":"array", "description":"Provides a bounding box that contains the geometry; the axis order follows that of the geometry.", "items":{ "type":"number", "description":"The axis numbers." } } } } ] }, "GeographicSite":{ "allOf":[ { "$ref":"#/components/schemas/Place" }, { "type":"object", "properties":{ "code":{ "type":"string", "description":"A code used by some addressing schemes (for example: ANSI T1.253-1999)." }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time the Geographic Site was created." }, "description":{ "type":"string", "description":"Provides additional information about the site." }, "status":{ "type":"string", "description":"Specifies the GeographicSite status (for example: planned, underConstruction, cancelled, active, inactive, or former)." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole" } }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier" } }, "calendar":{ "type":"array", "items":{ "$ref":"#/components/schemas/CalendarPeriod" } }, "place":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlaceRefOrValue" } }, "siteRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSiteRelationship" } } } } ] }, "GeographicSiteRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "href":{ "type":"string", "description":"Reference to the related geographic site." }, "role":{ "type":"string", "description":"Specifies the related site's role in the relationship." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "id":{ "type":"string", "description":"The ID of the related site entity within the server." }, "relationshipType":{ "type":"string", "description":"The relationship type." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSiteRelationship":"#/components/schemas/GeographicSiteRelationship" } } }, "GeographicSiteRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "properties":{ "href":{ "type":"string", "description":"Reference to the related geographic site." }, "role":{ "type":"string", "description":"Specifies the related site's role in the relationship." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "id":{ "type":"string", "description":"The ID of the related site entity within the server." }, "relationshipType":{ "type":"string", "description":"The relationship type." } }, "required":[ "id", "relationshipType" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSiteRelationship":"#/components/schemas/GeographicSiteRelationship_FVO" } } }, "GeographicSiteRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "href":{ "type":"string", "description":"Reference to the related geographic site." }, "role":{ "type":"string", "description":"Specifies the related site's role in the relationship." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "id":{ "type":"string", "description":"The ID of the related site entity within the server." }, "relationshipType":{ "type":"string", "description":"The relationship type." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSiteRelationship":"#/components/schemas/GeographicSiteRelationship_MVO" } } }, "GeographicSite_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_FVO" }, { "type":"object", "properties":{ "code":{ "type":"string", "description":"A code used by some addressing schemes (for example: ANSI T1.253-1999)." }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time the GeographicSite was created." }, "description":{ "type":"string", "description":"Provides additional information about the site." }, "status":{ "type":"string", "description":"Specifies the GeographicSite status (for example: planned, underConstruction, cancelled, active, inactive, or former)." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_FVO" } }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_FVO" } }, "calendar":{ "type":"array", "items":{ "$ref":"#/components/schemas/CalendarPeriod_FVO" } }, "place":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlaceRefOrValue_FVO" } }, "siteRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSiteRelationship_FVO" } } } } ] }, "GeographicSite_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Place_MVO" }, { "type":"object", "properties":{ "code":{ "type":"string", "description":"A code used by some addressing schemes (for example: ANSI T1.253-1999)." }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time the GeographicSite was created." }, "description":{ "type":"string", "description":"Provides additional information about the site." }, "status":{ "type":"string", "description":"Specifies the GeographicSite status (for example: planned, underConstruction, cancelled, active, inactive, or former)." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_MVO" } }, "externalIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_MVO" } }, "calendar":{ "type":"array", "items":{ "$ref":"#/components/schemas/CalendarPeriod_MVO" } }, "place":{ "type":"array", "items":{ "$ref":"#/components/schemas/PlaceRefOrValue_MVO" } }, "siteRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/GeographicSiteRelationship_MVO" } } } } ] }, "GeographicSubAddress":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Represents a GeographicSubAddress. Use it for addressing within a property in an urban area (country properties may be defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", "properties":{ "buildingName":{ "type":"string", "description":"Specifies the building’s well-known name." }, "href":{ "type":"string", "description":"Provides the link to the sub-address." }, "id":{ "type":"string", "description":"The sub-address' ID." }, "levelNumber":{ "type":"string", "description":"Use when a level type repeats (for example: BASEMENT 1 or BASEMENT 2)." }, "levelType":{ "type":"string", "description":"Describes the level type within a building." }, "name":{ "type":"string", "description":"The sub-address name for meaningful identification." }, "privateStreetName":{ "type":"string", "description":"Private streets within a property (for example: a university) may have internal names not recorded by the land title office." }, "privateStreetNumber":{ "type":"string", "description":"The number assigned to a private internal street." }, "subUnit":{ "type":"array", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "items":{ "$ref":"#/components/schemas/GeographicSubAddressUnit" } }, "subAddressType":{ "type":"string", "description":"Specifies the sub-address type (for example: subunit or private street)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddress":"#/components/schemas/GeographicSubAddress" } } }, "GeographicSubAddressUnit":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "properties":{ "subUnitNumber":{ "type":"string", "description":"Identifies the subunit, often a simple number or a range." }, "subUnitType":{ "type":"string", "description":"Specifies the subunit type (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF, or RACK)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddressUnit":"#/components/schemas/GeographicSubAddressUnit" } } }, "GeographicSubAddressUnit_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "properties":{ "subUnitNumber":{ "type":"string", "description":"Identifies the subunit, often a simple number or a range." }, "subUnitType":{ "type":"string", "description":"Specifies the subunit type (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF, or RACK)." } }, "required":[ "subUnitNumber", "subUnitType" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddressUnit":"#/components/schemas/GeographicSubAddressUnit_FVO" } } }, "GeographicSubAddressUnit_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "properties":{ "subUnitNumber":{ "type":"string", "description":"Identifies the subunit, often a simple number or a range." }, "subUnitType":{ "type":"string", "description":"Specifies the subunit type (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF, or RACK)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddressUnit":"#/components/schemas/GeographicSubAddressUnit_MVO" } } }, "GeographicSubAddress_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Represents a GeographicSubAddress. Use it for addressing within a property in an urban area (country properties may be defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", "properties":{ "buildingName":{ "type":"string", "description":"Specifies the building’s well-known name." }, "href":{ "type":"string", "description":"Provides the link to the sub-address." }, "id":{ "type":"string", "description":"The sub-address' ID." }, "levelNumber":{ "type":"string", "description":"Use when a level type repeats (for example: BASEMENT 1 or BASEMENT 2)." }, "levelType":{ "type":"string", "description":"Describes the level type within a building." }, "name":{ "type":"string", "description":"The sub-address name for meaningful identification." }, "privateStreetName":{ "type":"string", "description":"Private streets within a property (for example: a university) may have internal names not recorded by the land title office." }, "privateStreetNumber":{ "type":"string", "description":"The number assigned to a private internal street." }, "subUnit":{ "type":"array", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "items":{ "$ref":"#/components/schemas/GeographicSubAddressUnit_FVO" } }, "subAddressType":{ "type":"string", "description":"Specifies the sub-address type (for example: subunit or private street)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddress":"#/components/schemas/GeographicSubAddress_FVO" } } }, "GeographicSubAddress_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Represents a GeographicSubAddress. Use it for addressing within a property in an urban area (country properties may be defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.", "properties":{ "buildingName":{ "type":"string", "description":"Specifies the building’s well-known name." }, "href":{ "type":"string", "description":"Provides the link to the sub-address." }, "id":{ "type":"string", "description":"The sub-address' ID." }, "levelNumber":{ "type":"string", "description":"Use when a level type repeats (for example: BASEMENT 1 or BASEMENT 2)." }, "levelType":{ "type":"string", "description":"Describes the level type within a building." }, "name":{ "type":"string", "description":"The sub-address name for meaningful identification." }, "privateStreetName":{ "type":"string", "description":"Private streets within a property (for example: a university) may have internal names not recorded by the land title office." }, "privateStreetNumber":{ "type":"string", "description":"The number assigned to a private internal street." }, "subUnit":{ "type":"array", "description":"Represents a subunit within a sub-address (for example: BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, or WHARF).", "items":{ "$ref":"#/components/schemas/GeographicSubAddressUnit_MVO" } }, "subAddressType":{ "type":"string", "description":"Specifies the sub-address type (for example: subunit or private street)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicSubAddress":"#/components/schemas/GeographicSubAddress_MVO" } } }, "HourPeriod":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "endHour":{ "type":"string", "description":"The time when the status ends." }, "startHour":{ "type":"string", "description":"The time when the status starts." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "HourPeriod":"#/components/schemas/HourPeriod" } } }, "HourPeriod_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "properties":{ "endHour":{ "type":"string", "description":"The time when the status ends." }, "startHour":{ "type":"string", "description":"The time when the status starts." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "HourPeriod":"#/components/schemas/HourPeriod_FVO" } } }, "HourPeriod_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "properties":{ "endHour":{ "type":"string", "description":"The time when the status ends." }, "startHour":{ "type":"string", "description":"The time when the status starts." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "HourPeriod":"#/components/schemas/HourPeriod_MVO" } } }, "Individual":{ "allOf":[ { "$ref":"#/components/schemas/Party" }, { "type":"object", "description":"Represents a single human being. The individual can be a customer, an employee, or any other person about whom the organization stores information.", "properties":{ "gender":{ "type":"string", "description":"The individual's gender." }, "placeOfBirth":{ "type":"string", "description":"Reference to the individual's place of birth." }, "countryOfBirth":{ "type":"string", "description":"The individual's country of birth." }, "nationality":{ "type":"string", "description":"The individual's nationality." }, "maritalStatus":{ "type":"string", "description":"The individual's marital status (for example: married, divorced, or widowed)." }, "birthDate":{ "type":"string", "format":"date-time", "description":"The individual's birth date." }, "deathDate":{ "type":"string", "format":"date-time", "description":"The individual's date of death." }, "title":{ "type":"string", "description":"The individual's title (for example: Prof., Dr, or Sir)." }, "aristocraticTitle":{ "type":"string", "description":"An aristocratic title (for example: Baron, Graf, or Earl)." }, "generation":{ "type":"string", "description":"A generation suffix (for example: Sr, Jr, or III)." }, "preferredGivenName":{ "type":"string", "description":"Contains the name by which the individual prefers to be addressed. This may be a nickname rather than a given name." }, "familyNamePrefix":{ "type":"string", "description":"The family name prefix." }, "legalName":{ "type":"string", "description":"The legal or birth name (used for official purposes)." }, "middleName":{ "type":"string", "description":"The middle name or initial." }, "name":{ "type":"string", "description":"The flattened full name (first, middle, and last). Use this name in reference data types such as PartyRef and RelatedParty that refer to Individual." }, "formattedName":{ "type":"string", "description":"A fully formatted name as a single string with components in proper order and punctuation. Useful for specific contexts (for example: Chinese, Japanese, or Korean)." }, "location":{ "type":"string", "description":"The individual's temporary current location (use only if the individual has approved sharing)." }, "status":{ "$ref":"#/components/schemas/IndividualStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameIndividual" }, "description":"List of other names by which the individual is known." }, "individualIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/IndividualIdentification" }, "description":"List of official identifiers issued to the individual (for example: passport, driver’s license, or social security number)." }, "disability":{ "type":"array", "items":{ "$ref":"#/components/schemas/Disability" }, "description":"List of the individual's disabilities." }, "languageAbility":{ "type":"array", "items":{ "$ref":"#/components/schemas/LanguageAbility" }, "description":"List of languages known by the individual." }, "skill":{ "type":"array", "items":{ "$ref":"#/components/schemas/Skill" }, "description":"List of the individual's skills." }, "familyName":{ "type":"string", "description":"The inherited (non-chosen) family name; also known as the last name in the Western context." }, "givenName":{ "type":"string", "description":"The individual's first name." } } } ] }, "IndividualIdentification":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Records information used as proof of an individual's identity (for example: passport, national identity card, driver’s license, social security number, or birth certificate).", "properties":{ "identificationId":{ "type":"string", "description":"The identification ID." }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the ID (for example: social security or town hall)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type (for example: passport, national identity card, driver’s license, social security number, or birth certificate)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IndividualIdentification":"#/components/schemas/IndividualIdentification" } } }, "IndividualIdentification_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Records information used as proof of an individual's identity (for example: passport, national identity card, driver’s license, social security number, or birth certificate).", "properties":{ "identificationId":{ "type":"string", "description":"Identifier" }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the ID (for example: social security or town hall)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type (for example: passport, national identity card, driver’s license, social security number, or birth certificate)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue_FVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IndividualIdentification":"#/components/schemas/IndividualIdentification_FVO" } } }, "IndividualIdentification_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Records information used as proof of an individual's identity (for example: passport, national identity card, driver’s license, social security number, or birth certificate).", "properties":{ "identificationId":{ "type":"string", "description":"Identifier" }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the identifier (for example: social security or town hall)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type (for example: passport, national identity card, driver’s license, social security number, or birth certificate)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IndividualIdentification":"#/components/schemas/IndividualIdentification_MVO" } } }, "IndividualStateType":{ "enum":[ "initialized", "validated", "deceased" ], "type":"string", "description":"The individual's lifecycle state." }, "Individual_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Party_FVO" }, { "type":"object", "description":"Represents a single human being. The individual can be a customer, an employee, or any other person about whom the organization stores information.", "properties":{ "gender":{ "type":"string", "description":"The person's gender." }, "placeOfBirth":{ "type":"string", "description":"Reference to the individual's place of birth." }, "countryOfBirth":{ "type":"string", "description":"The individual's country of birth." }, "nationality":{ "type":"string", "description":"The individual's nationality." }, "maritalStatus":{ "type":"string", "description":"The individual's marital status (for example: married, divorced, or widowed)." }, "birthDate":{ "type":"string", "format":"date-time", "description":"The individual's birth date." }, "deathDate":{ "type":"string", "format":"date-time", "description":"The individual's date of death." }, "title":{ "type":"string", "description":"The individual's title (for example: Prof., Dr, or Sir)." }, "aristocraticTitle":{ "type":"string", "description":"An aristocratic title (for example: Baron, Graf, or Earl)." }, "generation":{ "type":"string", "description":"A generation suffix (for example: Sr, Jr, or III)." }, "preferredGivenName":{ "type":"string", "description":"Contains the name by which the individual prefers to be addressed. This may be a nickname rather than a given name." }, "familyNamePrefix":{ "type":"string", "description":"The family name prefix." }, "legalName":{ "type":"string", "description":"The legal or birth name (used for official purposes)." }, "middleName":{ "type":"string", "description":"The middle name or initial." }, "name":{ "type":"string", "description":"The flattened full name (first, middle, and last). Use this name in reference data types such as PartyRef and RelatedParty that refer to Individual." }, "formattedName":{ "type":"string", "description":"A fully formatted name as a single string with components in proper order and punctuation. Useful for specific contexts (for example: Chinese, Japanese, or Korean)." }, "location":{ "type":"string", "description":"The individual's temporary current location (use only if the individual has approved sharing)." }, "status":{ "$ref":"#/components/schemas/IndividualStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameIndividual" }, "description":"List of other names by which the individual is known." }, "individualIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/IndividualIdentification_FVO" }, "description":"List of official identifiers issued to the individual (for example: passport, driver’s license, or social security number)." }, "disability":{ "type":"array", "items":{ "$ref":"#/components/schemas/Disability" }, "description":"List of the individual's disabilities." }, "languageAbility":{ "type":"array", "items":{ "$ref":"#/components/schemas/LanguageAbility" }, "description":"List of languages known by the individual." }, "skill":{ "type":"array", "items":{ "$ref":"#/components/schemas/Skill" }, "description":"List of the individual's skills." }, "familyName":{ "type":"string", "description":"The inherited (non-chosen) family name; also known as the last name in the Western context." }, "givenName":{ "type":"string", "description":"The individual's first name." } } } ] }, "Individual_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Party_MVO" }, { "type":"object", "description":"Represents a single human being. The individual can be a customer, an employee, or any other person about whom the organization stores information.", "properties":{ "gender":{ "type":"string", "description":"The person's gender." }, "placeOfBirth":{ "type":"string", "description":"Reference to the place where the individual was born." }, "countryOfBirth":{ "type":"string", "description":"The individual's country of birth." }, "nationality":{ "type":"string", "description":"The individual's nationality." }, "maritalStatus":{ "type":"string", "description":"The individual's marital status (for example: married, divorced, or widowed)." }, "birthDate":{ "type":"string", "format":"date-time", "description":"The individual's birth date." }, "deathDate":{ "type":"string", "format":"date-time", "description":"The individual's date of death." }, "title":{ "type":"string", "description":"The individual's title (for example: Prof., Dr, or Sir)." }, "aristocraticTitle":{ "type":"string", "description":"An aristocratic title (for example: Baron, Graf, or Earl)." }, "generation":{ "type":"string", "description":"A generation suffix (for example: Sr, Jr, or III)." }, "preferredGivenName":{ "type":"string", "description":"Contains the name by which the individual prefers to be addressed. This may be a nickname rather than a given name." }, "familyNamePrefix":{ "type":"string", "description":"The family name prefix." }, "legalName":{ "type":"string", "description":"The legal or birth name (used for official purposes)." }, "middleName":{ "type":"string", "description":"The middle name or initial." }, "name":{ "type":"string", "description":"The flattened full name (first, middle, and last). Use this name in reference data types such as PartyRef and RelatedParty that refer to Individual." }, "formattedName":{ "type":"string", "description":"A fully formatted name as a single string with components in proper order and punctuation. Useful for specific contexts (for example: Chinese, Japanese, or Korean)." }, "location":{ "type":"string", "description":"The individual's temporary current location (use only if the individual has approved sharing)." }, "status":{ "$ref":"#/components/schemas/IndividualStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameIndividual" }, "description":"List of other names by which the individual is known." }, "individualIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/IndividualIdentification_MVO" }, "description":"List of official identifiers issued to the individual (for example: passport, driver’s license, or social security number)." }, "disability":{ "type":"array", "items":{ "$ref":"#/components/schemas/Disability" }, "description":"List of the individual's disabilities." }, "languageAbility":{ "type":"array", "items":{ "$ref":"#/components/schemas/LanguageAbility" }, "description":"List of languages known by the individual." }, "skill":{ "type":"array", "items":{ "$ref":"#/components/schemas/Skill" }, "description":"List of the individual's skills." }, "familyName":{ "type":"string", "description":"The inherited (non-chosen) family name; also known as the last name in the Western context." }, "givenName":{ "type":"string", "description":"The first name of the individual." } } } ] }, "IntegerArrayCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A list of characteristic with an Integer data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"integer" } } } } ] }, "IntegerArrayCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A list of characteristic with an Integer data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"integer" } } }, "required":[ "value" ] } ] }, "IntegerArrayCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A list of characteristic with an Integer data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"integer" } } }, "required":[ "value" ] } ] }, "IntegerCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A list of characteristic with an Integer data type.", "properties":{ "value":{ "type":"integer", "description":"The value of the characteristic." } } } ] }, "IntegerCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic with an Integer data type.", "properties":{ "value":{ "type":"integer", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "IntegerCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic with an Integer data type.", "properties":{ "value":{ "type":"integer", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "Intent":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"An Intent instance formally describes all expectations, including requirements, goals, and constraints, provided to a technical system.", "properties":{ "description":{ "type":"string", "description":"The description of the intent." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "isBundle":{ "type":"boolean", "description":"Indicates whether the intent represents a single intent (false) or a bundle of intents (true)." }, "priority":{ "type":"string", "description":"Allows the intent owner to prioritize intents in an intent management system." }, "statusChangeDate":{ "type":"string", "format":"date-time", "description":"The date and time when the entity’s status changed to the current value." }, "context":{ "type":"string", "description":"Provides context for the intent." }, "version":{ "type":"string", "description":"Identifies the specific version of the intent instance." }, "intentSpecification":{ "$ref":"#/components/schemas/EntityRef" }, "intentRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntityRelationship" }, "description":"Lists intents related to this intent." }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef" } }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue" }, "description":"References attachments that complement the intent’s description (for example: videos and images)." }, "name":{ "type":"string", "description":"The intent name." }, "expression":{ "$ref":"#/components/schemas/Expression" }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was created." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was last updated." }, "lifecycleStatus":{ "type":"string", "description":"Indicates the current lifecycle status of this intent." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Intent":"#/components/schemas/Intent" } } }, "IntentRef":{ "type":"object", "description":"Intent reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef" } } }, "IntentRefOrValue":{ "type":"object", "description":"Intent reference (if the Intent already exists) or value (if creating the Intent or presenting its details).", "oneOf":[ { "$ref":"#/components/schemas/IntentRef" }, { "$ref":"#/components/schemas/Intent" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef", "Intent":"#/components/schemas/Intent" } } }, "IntentRefOrValue_FVO":{ "type":"object", "description":"Intent reference (if the Intent already exists) or value (if creating the Intent or presenting its details).", "oneOf":[ { "$ref":"#/components/schemas/IntentRef_FVO" }, { "$ref":"#/components/schemas/Intent_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef_FVO", "Intent":"#/components/schemas/Intent_FVO" } } }, "IntentRefOrValue_MVO":{ "type":"object", "description":"Intent reference (if the Intent already exists) or value (if creating the Intent or presenting its details).", "oneOf":[ { "$ref":"#/components/schemas/IntentRef_MVO" }, { "$ref":"#/components/schemas/Intent_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef_MVO", "Intent":"#/components/schemas/Intent_MVO" } } }, "IntentRef_FVO":{ "type":"object", "description":"Intent reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef_FVO" } } }, "IntentRef_MVO":{ "type":"object", "description":"Intent reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "IntentRef":"#/components/schemas/IntentRef_MVO" } } }, "Intent_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"An Intent instance formally describes all expectations, including requirements, goals, and constraints, provided to a technical system.", "properties":{ "description":{ "type":"string", "description":"Describes the intent." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "isBundle":{ "type":"boolean", "description":"Indicates whether the intent represents a single intent (false) or a bundle of intents (true)." }, "priority":{ "type":"string", "description":"Allows the intent owner to prioritize intents in an intent management system." }, "statusChangeDate":{ "type":"string", "format":"date-time", "description":"The date and time when the entity’s status changed to the current value." }, "context":{ "type":"string", "description":"Provides context for the intent." }, "version":{ "type":"string", "description":"Identifies the specific version of the intent instance." }, "intentSpecification":{ "$ref":"#/components/schemas/EntityRef_FVO" }, "intentRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntityRelationship_FVO" }, "description":"Lists intents related to this intent." }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_FVO" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_FVO" } }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue_FVO" }, "description":"References attachments that complement the intent’s description (for example: videos and images)." }, "name":{ "type":"string", "description":"The intent name." }, "expression":{ "$ref":"#/components/schemas/Expression_FVO" }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was created." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was last updated." }, "lifecycleStatus":{ "type":"string", "description":"Indicates the current lifecycle status of this intent." } }, "required":[ "name", "creationDate", "lastUpdate", "lifecycleStatus" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Intent":"#/components/schemas/Intent_FVO" } } }, "Intent_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"An Intent instance formally describes all expectations, including requirements, goals, and constraints, provided to a technical system.", "properties":{ "description":{ "type":"string", "description":"The description of the intent." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "isBundle":{ "type":"boolean", "description":"Indicates whether the intent represents a single intent (false) or a bundle of intents (true)." }, "priority":{ "type":"string", "description":"Allows the intent owner to prioritize intents in an intent management system." }, "statusChangeDate":{ "type":"string", "format":"date-time", "description":"The date and time when the entity’s status changed to the current value." }, "context":{ "type":"string", "description":"A string used to give a context to the intent." }, "version":{ "type":"string", "description":"Identifies the specific version of the intent instance." }, "intentSpecification":{ "$ref":"#/components/schemas/EntityRef" }, "intentRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntityRelationship_MVO" }, "description":"A list of intents related to this intent." }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_MVO" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyRefOrPartyRoleRef_MVO" } }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue_MVO" }, "description":"References attachments that complement the intent’s description (for example: videos and images)." }, "name":{ "type":"string", "description":"The name of the intent." }, "expression":{ "$ref":"#/components/schemas/Expression_MVO" }, "creationDate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was created." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"The date and time this REST resource was last updated." }, "lifecycleStatus":{ "type":"string", "description":"Indicates the current lifecycle status of this intent." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Intent":"#/components/schemas/Intent_MVO" } } }, "ItemActionType":{ "enum":[ "add", "modify", "delete", "noChange" ], "type":"string", "description":"Specifies the action to perform on the entity managed by the item." }, "LanguageAbility":{ "type":"object", "description":"Describes an individual's ability to understand or converse in a language.", "properties":{ "languageCode":{ "type":"string", "description":"The language code (RFC 5646)." }, "languageName":{ "type":"string", "description":"The language name." }, "isFavouriteLanguage":{ "type":"boolean", "description":"If true, marks this as the individual's favorite language." }, "writingProficiency":{ "type":"string", "description":"The individual's writing proficiency in this language." }, "readingProficiency":{ "type":"string", "description":"The individual's reading proficiency in this language." }, "speakingProficiency":{ "type":"string", "description":"The individual's speaking proficiency in this language." }, "listeningProficiency":{ "type":"string", "description":"The individual's listening proficiency in this language." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } }, "NumberArrayCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A list of characteristics with a Number data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"number" } } } } ] }, "NumberArrayCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A list of characteristics with a Number data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"number" } } }, "required":[ "value" ] } ] }, "NumberArrayCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A list of characteristics with a Number data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"number" } } }, "required":[ "value" ] } ] }, "NumberCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A characteristic with a Number data type.", "properties":{ "value":{ "type":"number", "description":"The value of the characteristic." } } } ] }, "NumberCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic with a Number data type.", "properties":{ "value":{ "type":"number", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "NumberCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic with a Number data type.", "properties":{ "value":{ "type":"number", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "ObjectArrayCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A list of characteristics with an Object data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"object" } } } } ] }, "ObjectArrayCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A list of characteristics with an Object data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"object" } } }, "required":[ "value" ] } ] }, "ObjectArrayCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A list of characteristics with an Object data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"object" } } }, "required":[ "value" ] } ] }, "ObjectCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A characteristic with an Object data type.", "properties":{ "value":{ "type":"object", "description":"The value of the characteristic." } } } ] }, "ObjectCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic with an Object data type.", "properties":{ "value":{ "type":"object", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "ObjectCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic with an Object data type.", "properties":{ "value":{ "type":"object", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "Organization":{ "allOf":[ { "$ref":"#/components/schemas/Party" }, { "type":"object", "description":"Represents a group of people united by shared interests or purpose (for example: a business, department, or enterprise). Because many businesses are complex, both organizations and organization units use the same data structure.", "properties":{ "isLegalEntity":{ "type":"boolean", "description":"If true, indicates the organization is a legal entity recognized by a national registry." }, "isHeadOffice":{ "type":"boolean", "description":"If true, indicates the organization is the head office." }, "organizationType":{ "type":"string", "description":"The organization type (for example: company or department)." }, "existsDuring":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"Organization name (department name for example)" }, "nameType":{ "type":"string", "description":"The organization name (for example: department name)." }, "status":{ "$ref":"#/components/schemas/OrganizationStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameOrganization" }, "description":"Lists additional names by which the organization is known." }, "organizationIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationIdentification" }, "description":"Lists official identifiers assigned to the organization (for example: company number in the registry of companies)." }, "organizationChildRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationChildRelationship" }, "description":"Lists organizations contained within this organization (for example: if this organization is the Legal Department, child organizations might include Claims, Courts, or Contracts)." }, "organizationParentRelationship":{ "$ref":"#/components/schemas/OrganizationParentRelationship" }, "tradingName":{ "type":"string", "description":"The name under which the organization (unit) trades." } } } ] }, "OrganizationChildRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"References child organizations within an organizational structure.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationChildRelationship":"#/components/schemas/OrganizationChildRelationship" } } }, "OrganizationChildRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"References child organizations within an organizational structure.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef_FVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationChildRelationship":"#/components/schemas/OrganizationChildRelationship_FVO" } } }, "OrganizationChildRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"References child organizations within an organizational structure.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationChildRelationship":"#/components/schemas/OrganizationChildRelationship_MVO" } } }, "OrganizationIdentification":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Records information used as proof of an organization's identity.", "properties":{ "identificationId":{ "type":"string", "description":"The identification ID." }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the ID (for example: chamber of commerce)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type used to identify the company nationally or internationally." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationIdentification":"#/components/schemas/OrganizationIdentification" } } }, "OrganizationIdentification_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Records information used as proof of an organization's identity.", "properties":{ "identificationId":{ "type":"string", "description":"The identification ID." }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the ID (for example: chamber of commerce)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type used to identify the company nationally or internationally." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue_FVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationIdentification":"#/components/schemas/OrganizationIdentification_FVO" } } }, "OrganizationIdentification_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Records information used as proof of an organization's identity.", "properties":{ "identificationId":{ "type":"string", "description":"The identification ID." }, "issuingAuthority":{ "type":"string", "description":"The authority that issued the ID (for example: chamber of commerce)." }, "issuingDate":{ "type":"string", "format":"date-time", "description":"The date the ID was issued." }, "identificationType":{ "type":"string", "description":"The identification type used to identify the company nationally or internationally." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "attachment":{ "$ref":"#/components/schemas/AttachmentRefOrValue_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationIdentification":"#/components/schemas/OrganizationIdentification_MVO" } } }, "OrganizationParentRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Parent references of an organization in a structure of organizations.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationParentRelationship":"#/components/schemas/OrganizationParentRelationship" } } }, "OrganizationParentRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Parent references of an organization in a structure of organizations.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef_FVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationParentRelationship":"#/components/schemas/OrganizationParentRelationship_FVO" } } }, "OrganizationParentRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Parent references of an organization in a structure of organizations.", "properties":{ "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: juridical, hierarchical, geographical, or functional)." }, "organization":{ "$ref":"#/components/schemas/OrganizationRef_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationParentRelationship":"#/components/schemas/OrganizationParentRelationship_MVO" } } }, "OrganizationRef":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationRef":"#/components/schemas/OrganizationRef" } } }, "OrganizationRef_FVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationRef":"#/components/schemas/OrganizationRef_FVO" } } }, "OrganizationRef_MVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OrganizationRef":"#/components/schemas/OrganizationRef_MVO" } } }, "OrganizationStateType":{ "enum":[ "initialized", "validated", "closed" ], "type":"string", "description":"The valid values for the lifecycle state of the organization." }, "Organization_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Party_FVO" }, { "type":"object", "description":"Represents a group of people united by shared interests or purpose (for example: a business, department, or enterprise). Because many businesses are complex, both organizations and organization units use the same data structure.", "properties":{ "isLegalEntity":{ "type":"boolean", "description":"If true, indicates the organization is a legal entity recognized by a national registry." }, "isHeadOffice":{ "type":"boolean", "description":"If true, indicates the organization is the head office." }, "organizationType":{ "type":"string", "description":"The organization type (for example: company or department)." }, "existsDuring":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"The organization name (for example: department name)." }, "nameType":{ "type":"string", "description":"The name type (for example: Co, Inc, or Ltd)." }, "status":{ "$ref":"#/components/schemas/OrganizationStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameOrganization_FVO" }, "description":"Lists additional names by which the organization is known." }, "organizationIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationIdentification_FVO" }, "description":"Lists official identifiers assigned to the organization (for example: company number in the registry of companies)." }, "organizationChildRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationChildRelationship_FVO" }, "description":"Lists organizations contained within this organization (for example: if this organization is the Legal Department, child organizations might include Claims, Courts, or Contracts)." }, "organizationParentRelationship":{ "$ref":"#/components/schemas/OrganizationParentRelationship_FVO" }, "tradingName":{ "type":"string", "description":"The name under which the organization trades." } } } ] }, "Organization_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Party_MVO" }, { "type":"object", "description":"Represents a group of people united by shared interests or purpose (for example: a business, department, or enterprise). Because many businesses are complex, both organizations and organization units use the same data structure.", "properties":{ "isLegalEntity":{ "type":"boolean", "description":"If true, indicates the organization is a legal entity recognized by a national registry." }, "isHeadOffice":{ "type":"boolean", "description":"If true, indicates the organization is the head office." }, "organizationType":{ "type":"string", "description":"The organization type (for example: company or department)." }, "existsDuring":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"The organization name (for example: department name)." }, "nameType":{ "type":"string", "description":"The name type (for example: Co, Inc, or Ltd)." }, "status":{ "$ref":"#/components/schemas/OrganizationStateType" }, "otherName":{ "type":"array", "items":{ "$ref":"#/components/schemas/OtherNameOrganization_MVO" }, "description":"Lists additional names by which the organization is known." }, "organizationIdentification":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationIdentification_MVO" }, "description":"Lists official identifiers assigned to the organization (for example: company number in the registry of companies)." }, "organizationChildRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/OrganizationChildRelationship_MVO" }, "description":"Lists organizations contained within this organization (for example: if this organization is the Legal Department, child organizations might include Claims, Courts, or Contracts)." }, "organizationParentRelationship":{ "$ref":"#/components/schemas/OrganizationParentRelationship_MVO" }, "tradingName":{ "type":"string", "description":"The name under which the organization (unit) trades." } } } ] }, "OtherNameIndividual":{ "type":"object", "description":"List of other names by which the individual is known.", "properties":{ "title":{ "type":"string", "description":"Use for titles (aristocratic, social, etc.) such as Pr, Dr, Sir." }, "aristocraticTitle":{ "type":"string", "description":"An aristocratic title (for example: Baron, Graf, Earl, etc.)." }, "generation":{ "type":"string", "description":"The name hierarchal prefix. for example: Sr, Jr, etc." }, "givenName":{ "type":"string", "description":"The first name." }, "preferredGivenName":{ "type":"string", "description":"Contains the name by which the person prefers to be addressed. This may be a nickname rather than a given name." }, "familyNamePrefix":{ "type":"string", "description":"Family name prefix" }, "familyName":{ "type":"string", "description":"The inherited (non-chosen) family name; also known as the last name in the Western context." }, "legalName":{ "type":"string", "description":"The legal or birth name (used for official purposes)." }, "middleName":{ "type":"string", "description":"The middle name or initial." }, "fullName":{ "type":"string", "description":"The flattened full name (first, middle, and last names)." }, "formattedName":{ "type":"string", "description":"A fully formatted name as a single string with components in proper order and punctuation. Useful for specific contexts (for example: Chinese, Japanese, or Korean)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } }, "OtherNameOrganization":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Tracks other names, such as a former name of an organization.", "properties":{ "tradingName":{ "type":"string", "description":"The name under which the organization trades." }, "nameType":{ "type":"string", "description":"The name type (for example: Co., Inc., Ltd., Pty Ltd., Plc, or GmbH)." }, "name":{ "type":"string", "description":"The organization name (for example: department name)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OtherNameOrganization":"#/components/schemas/OtherNameOrganization" } } }, "OtherNameOrganization_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Tracks other names, such as a former name of an organization.", "properties":{ "tradingName":{ "type":"string", "description":"The name under which the organization trades." }, "nameType":{ "type":"string", "description":"The name type (for example: Co., Inc., Ltd., Pty Ltd., Plc, or GmbH)." }, "name":{ "type":"string", "description":"The organization name (for example: department name)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OtherNameOrganization":"#/components/schemas/OtherNameOrganization_FVO" } } }, "OtherNameOrganization_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Tracks other names, such as a former name of an organization.", "properties":{ "tradingName":{ "type":"string", "description":"The name under which the organization trades." }, "nameType":{ "type":"string", "description":"The name type (for example: Co., Inc., Ltd., Pty Ltd., Plc, or GmbH)." }, "name":{ "type":"string", "description":"The organization name (for example: department name)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "OtherNameOrganization":"#/components/schemas/OtherNameOrganization_MVO" } } }, "Party":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Defines a generic, abstract Party structure that captures commonalities between Individual and Organization.", "properties":{ "externalReference":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier" }, "description":"Lists identifiers of the party in external systems (for example: when party information is imported from a commerce system)." }, "partyCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"Lists additional characteristics that a party can have." }, "taxExemptionCertificate":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificate" }, "description":"Lists tax exemptions granted to the party (for example: a war veteran might have a partial state tax exemption and a full federal tax exemption)." }, "creditRating":{ "type":"array", "items":{ "$ref":"#/components/schemas/PartyCreditProfile" }, "description":"Lists credit profiles and scores for the party, typically received from an external credit broker." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole" }, "description":"Lists parties and/or party roles related to this party." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium" }, "description":"Lists means of contacting the party (for example: mobile phone or email address)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Party":"#/components/schemas/Party", "Organization":"#/components/schemas/Organization", "Individual":"#/components/schemas/Individual" } } }, "PartyCreditProfile":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Evaluates a party’s creditworthiness based on a credit rating provided by a credit agency.", "properties":{ "creditAgencyName":{ "type":"string", "description":"The name of the credit agency providing the score." }, "creditAgencyType":{ "type":"string", "description":"The type of the credit agency providing the score." }, "ratingReference":{ "type":"string", "description":"The reference corresponding to the credit rating." }, "ratingScore":{ "type":"integer", "format":"int32", "description":"A measure of a party's creditworthiness calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyCreditProfile":"#/components/schemas/PartyCreditProfile" } } }, "PartyCreditProfile_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Evaluates a party’s creditworthiness based on a credit rating provided by a credit agency.", "properties":{ "creditAgencyName":{ "type":"string", "description":"The name of the credit agency providing the score." }, "creditAgencyType":{ "type":"string", "description":"The type of credit agency providing the score." }, "ratingReference":{ "type":"string", "description":"The reference corresponding to the credit rating." }, "ratingScore":{ "type":"integer", "format":"int32", "description":"A measure of a party's creditworthiness calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyCreditProfile":"#/components/schemas/PartyCreditProfile_FVO" } } }, "PartyCreditProfile_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Evaluates a party’s creditworthiness based on a credit rating provided by a credit agency.", "properties":{ "creditAgencyName":{ "type":"string", "description":"The name of the credit agency providing the score." }, "creditAgencyType":{ "type":"string", "description":"The type of the credit agency providing the score." }, "ratingReference":{ "type":"string", "description":"Reference corresponding to the credit rating" }, "ratingScore":{ "type":"integer", "format":"int32", "description":"A measure of a party's creditworthiness calculated from factors such as income and credit history." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyCreditProfile":"#/components/schemas/PartyCreditProfile_MVO" } } }, "PartyOrPartyRole":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef" }, { "$ref":"#/components/schemas/PartyRoleRef" }, { "$ref":"#/components/schemas/Individual" }, { "$ref":"#/components/schemas/Organization" }, { "$ref":"#/components/schemas/PartyRole" }, { "$ref":"#/components/schemas/Supplier" }, { "$ref":"#/components/schemas/BusinessPartner" }, { "$ref":"#/components/schemas/Consumer" }, { "$ref":"#/components/schemas/Producer" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef", "PartyRoleRef":"#/components/schemas/PartyRoleRef", "Individual":"#/components/schemas/Individual", "Organization":"#/components/schemas/Organization", "PartyRole":"#/components/schemas/PartyRole", "Supplier":"#/components/schemas/Supplier", "BusinessPartner":"#/components/schemas/BusinessPartner", "Consumer":"#/components/schemas/Consumer", "Producer":"#/components/schemas/Producer" } } }, "PartyOrPartyRole_FVO":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef_FVO" }, { "$ref":"#/components/schemas/PartyRoleRef_FVO" }, { "$ref":"#/components/schemas/Individual_FVO" }, { "$ref":"#/components/schemas/Organization_FVO" }, { "$ref":"#/components/schemas/PartyRole_FVO" }, { "$ref":"#/components/schemas/Supplier_FVO" }, { "$ref":"#/components/schemas/BusinessPartner_FVO" }, { "$ref":"#/components/schemas/Consumer_FVO" }, { "$ref":"#/components/schemas/Producer_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef_FVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_FVO", "Individual":"#/components/schemas/Individual_FVO", "Organization":"#/components/schemas/Organization_FVO", "PartyRole":"#/components/schemas/PartyRole_FVO", "Supplier":"#/components/schemas/Supplier_FVO", "BusinessPartner":"#/components/schemas/BusinessPartner_FVO", "Consumer":"#/components/schemas/Consumer_FVO", "Producer":"#/components/schemas/Producer_FVO" } } }, "PartyOrPartyRole_MVO":{ "type":"object", "description":"", "oneOf":[ { "$ref":"#/components/schemas/PartyRef_MVO" }, { "$ref":"#/components/schemas/PartyRoleRef_MVO" }, { "$ref":"#/components/schemas/Individual_MVO" }, { "$ref":"#/components/schemas/Organization_MVO" }, { "$ref":"#/components/schemas/PartyRole_MVO" }, { "$ref":"#/components/schemas/Supplier_MVO" }, { "$ref":"#/components/schemas/BusinessPartner_MVO" }, { "$ref":"#/components/schemas/Consumer_MVO" }, { "$ref":"#/components/schemas/Producer_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRef":"#/components/schemas/PartyRef_MVO", "PartyRoleRef":"#/components/schemas/PartyRoleRef_MVO", "Individual":"#/components/schemas/Individual_MVO", "Organization":"#/components/schemas/Organization_MVO", "PartyRole":"#/components/schemas/PartyRole_MVO", "Supplier":"#/components/schemas/Supplier_MVO", "BusinessPartner":"#/components/schemas/BusinessPartner_MVO", "Consumer":"#/components/schemas/Consumer_MVO", "Producer":"#/components/schemas/Producer_MVO" } } }, "PartyRole":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"The part played by a party in a given context.", "properties":{ "name":{ "type":"string", "description":"A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles; the unique name of the PartyRole." }, "description":{ "type":"string", "description":"A description of the PartyRole." }, "role":{ "type":"string", "description":"Specifies the role played by the engagedParty in this context. If a partyRoleSpecification defines the role, use this attribute to refine it; otherwise, use it to define the role." }, "engagedParty":{ "$ref":"#/components/schemas/PartyRef" }, "partyRoleSpecification":{ "$ref":"#/components/schemas/PartyRoleSpecificationRef" }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" }, "description":"Describes the characteristic of a party role." }, "account":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRef" } }, "agreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementRef" } }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium" } }, "paymentMethod":{ "type":"array", "items":{ "$ref":"#/components/schemas/PaymentMethodRef" } }, "creditProfile":{ "type":"array", "items":{ "$ref":"#/components/schemas/CreditProfile" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole" } }, "status":{ "type":"string", "description":"Tracks the lifecycle status of the party role." }, "statusReason":{ "type":"string", "description":"Provides an explanation of the lifecycle status value (for example: if the status is Rejected, statusReason provides the reason for rejection)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRole":"#/components/schemas/PartyRole", "Supplier":"#/components/schemas/Supplier", "Producer":"#/components/schemas/Producer", "Consumer":"#/components/schemas/Consumer", "BusinessPartner":"#/components/schemas/BusinessPartner" } } }, "PartyRoleSpecificationRef":{ "type":"object", "description":"Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRoleSpecificationRef":"#/components/schemas/PartyRoleSpecificationRef" } } }, "PartyRoleSpecificationRef_FVO":{ "type":"object", "description":"Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRoleSpecificationRef":"#/components/schemas/PartyRoleSpecificationRef_FVO" } } }, "PartyRoleSpecificationRef_MVO":{ "type":"object", "description":"Party role specification reference. A party role specification gives additional details on the part played by a party in a given context.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRoleSpecificationRef":"#/components/schemas/PartyRoleSpecificationRef_MVO" } } }, "PartyRole_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"The part played by a party in a given context.", "properties":{ "name":{ "type":"string", "description":"A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles. It's the name of the PartyRole unique entity." }, "description":{ "type":"string", "description":"A description of the PartyRole." }, "role":{ "type":"string", "description":"Specifies the role played by the engagedParty in this context. If a partyRoleSpecification defines the role, use this attribute to refine it; otherwise, use it to define the role." }, "engagedParty":{ "$ref":"#/components/schemas/PartyRef_FVO" }, "partyRoleSpecification":{ "$ref":"#/components/schemas/PartyRoleSpecificationRef_FVO" }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_FVO" }, "description":"Describes the characteristic of a party role." }, "account":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRef_FVO" } }, "agreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementRef_FVO" } }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_FVO" } }, "paymentMethod":{ "type":"array", "items":{ "$ref":"#/components/schemas/PaymentMethodRef_FVO" } }, "creditProfile":{ "type":"array", "items":{ "$ref":"#/components/schemas/CreditProfile_FVO" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_FVO" } }, "status":{ "type":"string", "description":"Tracks the lifecycle status of the party role." }, "statusReason":{ "type":"string", "description":"Provides an explanation of the lifecycle status value (for example: if the status is Rejected, statusReason provides the reason for rejection)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } }, "required":[ "name", "engagedParty" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRole":"#/components/schemas/PartyRole_FVO", "Supplier":"#/components/schemas/Supplier_FVO", "Producer":"#/components/schemas/Producer_FVO", "Consumer":"#/components/schemas/Consumer_FVO", "BusinessPartner":"#/components/schemas/BusinessPartner_FVO" } } }, "PartyRole_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"The part played by a party in a given context.", "properties":{ "name":{ "type":"string", "description":"A word, term, or phrase by which the PartyRole is known and distinguished from other PartyRoles; the unique name of the PartyRole." }, "description":{ "type":"string", "description":"A description of the PartyRole." }, "role":{ "type":"string", "description":"Specifies the role played by the engagedParty in this context. If a partyRoleSpecification defines the role, use this attribute to refine it; otherwise, use it to define the role." }, "engagedParty":{ "$ref":"#/components/schemas/PartyRef_MVO" }, "partyRoleSpecification":{ "$ref":"#/components/schemas/PartyRoleSpecificationRef_MVO" }, "characteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_MVO" }, "description":"Describes the characteristic of a party role." }, "account":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRef_MVO" } }, "agreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementRef_MVO" } }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_MVO" } }, "paymentMethod":{ "type":"array", "items":{ "$ref":"#/components/schemas/PaymentMethodRef_MVO" } }, "creditProfile":{ "type":"array", "items":{ "$ref":"#/components/schemas/CreditProfile_MVO" } }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_MVO" } }, "status":{ "type":"string", "description":"Used to track the lifecycle status of the party role." }, "statusReason":{ "type":"string", "description":"Provides an explanation of the lifecycle status value (for example: if the status is Rejected, statusReason provides the reason for rejection)." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PartyRole":"#/components/schemas/PartyRole_MVO", "Supplier":"#/components/schemas/Supplier_MVO", "Producer":"#/components/schemas/Producer_MVO", "Consumer":"#/components/schemas/Consumer_MVO", "BusinessPartner":"#/components/schemas/BusinessPartner_MVO" } } }, "Party_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Defines a generic, abstract Party structure that captures commonalities between Individual and Organization.", "properties":{ "externalReference":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_FVO" }, "description":"Lists identifiers of the party in external systems (for example: when party information is imported from a commerce system)." }, "partyCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_FVO" }, "description":"Lists additional characteristics that a party can have." }, "taxExemptionCertificate":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificate_FVO" }, "description":"Lists tax exemptions granted to the party (for example: a war veteran might have a partial state tax exemption and a full federal tax exemption)." }, "creditRating":{ "type":"array", "items":{ "$ref":"#/components/schemas/PartyCreditProfile_FVO" }, "description":"Lists credit profiles and scores for the party, usually received from an external credit broker." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_FVO" }, "description":"Lists parties or party roles related to this party." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_FVO" }, "description":"Lists means of contacting the party (for example: mobile phone or email address)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Party":"#/components/schemas/Party_FVO", "Organization":"#/components/schemas/Organization_FVO", "Individual":"#/components/schemas/Individual_FVO" } } }, "Party_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Defines a generic, abstract Party structure that captures commonalities between Individual and Organization.", "properties":{ "externalReference":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExternalIdentifier_MVO" }, "description":"Lists identifiers of the party in external systems (for example: when party information is imported from a commerce system)." }, "partyCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_MVO" }, "description":"Lists additional characteristics that a party can have." }, "taxExemptionCertificate":{ "type":"array", "items":{ "$ref":"#/components/schemas/TaxExemptionCertificate_MVO" }, "description":"Lists tax exemptions granted to the party (for example: a war veteran might have a partial state tax exemption and a full federal tax exemption)." }, "creditRating":{ "type":"array", "items":{ "$ref":"#/components/schemas/PartyCreditProfile_MVO" }, "description":"Lists credit profiles and scores for the party, typically received from an external credit broker." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedPartyOrPartyRole_MVO" }, "description":"Lists parties or party roles related to this party." }, "contactMedium":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactMedium_MVO" }, "description":"Lists means of contacting the party (for example: mobile phone or email address)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Party":"#/components/schemas/Party_MVO", "Organization":"#/components/schemas/Organization_MVO", "Individual":"#/components/schemas/Individual_MVO" } } }, "Place":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Entity" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Place":"#/components/schemas/Place", "GeographicSite":"#/components/schemas/GeographicSite", "GeographicLocation":"#/components/schemas/GeographicLocation", "GeographicAddress":"#/components/schemas/GeographicAddress" } } }, "PlaceRef":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PlaceRef":"#/components/schemas/PlaceRef" } } }, "PlaceRefOrValue":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Place entity, not to the PlaceRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation" }, { "$ref":"#/components/schemas/GeographicSite" }, { "$ref":"#/components/schemas/GeographicAddress" }, { "$ref":"#/components/schemas/PlaceRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation", "GeographicSite":"#/components/schemas/GeographicSite", "GeographicAddress":"#/components/schemas/GeographicAddress", "PlaceRef":"#/components/schemas/PlaceRef" } } }, "PlaceRefOrValue_FVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Place entity, not to the PlaceRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation_FVO" }, { "$ref":"#/components/schemas/GeographicSite_FVO" }, { "$ref":"#/components/schemas/GeographicAddress_FVO" }, { "$ref":"#/components/schemas/PlaceRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation_FVO", "GeographicSite":"#/components/schemas/GeographicSite_FVO", "GeographicAddress":"#/components/schemas/GeographicAddress_FVO", "PlaceRef":"#/components/schemas/PlaceRef_FVO" } } }, "PlaceRefOrValue_MVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Place entity, not to the PlaceRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/GeographicLocation_MVO" }, { "$ref":"#/components/schemas/GeographicSite_MVO" }, { "$ref":"#/components/schemas/GeographicAddress_MVO" }, { "$ref":"#/components/schemas/PlaceRef_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "GeographicLocation":"#/components/schemas/GeographicLocation_MVO", "GeographicSite":"#/components/schemas/GeographicSite_MVO", "GeographicAddress":"#/components/schemas/GeographicAddress_MVO", "PlaceRef":"#/components/schemas/PlaceRef_MVO" } } }, "PlaceRef_FVO":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PlaceRef":"#/components/schemas/PlaceRef_FVO" } } }, "PlaceRef_MVO":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PlaceRef":"#/components/schemas/PlaceRef_MVO" } } }, "Place_FVO":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Place":"#/components/schemas/Place_FVO", "GeographicSite":"#/components/schemas/GeographicSite_FVO", "GeographicLocation":"#/components/schemas/GeographicLocation_FVO", "GeographicAddress":"#/components/schemas/GeographicAddress_FVO" } } }, "Place_MVO":{ "type":"object", "description":"Place reference.", "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Place":"#/components/schemas/Place_MVO", "GeographicSite":"#/components/schemas/GeographicSite_MVO", "GeographicLocation":"#/components/schemas/GeographicLocation_MVO", "GeographicAddress":"#/components/schemas/GeographicAddress_MVO" } } }, "Price":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.", "properties":{ "dutyFreeAmount":{ "$ref":"#/components/schemas/Money" }, "percentage":{ "type":"number", "format":"float", "description":"The percentage to apply to a product offering price alteration." }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxRate":{ "type":"number", "format":"float", "description":"The tax rate." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Price":"#/components/schemas/Price" } } }, "PriceAlteration":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An amount, usually monetary, that modifies the price charged for an order item.", "properties":{ "applicationDuration":{ "type":"integer", "description":"The duration for which the alteration applies to the order item price (for example: 2 months free of charge for the recurring charge)." }, "description":{ "type":"string", "description":"Describes the semantics of this order item price alteration." }, "name":{ "type":"string", "description":"The order item price alteration name." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef" }, "priceType":{ "type":"string", "description":"The price category (for example: recurring, one time, or usage)." }, "priority":{ "type":"integer", "description":"The priority for applying this alteration among all defined alterations on the order item price." }, "recurringChargePeriod":{ "type":"string", "description":"Specifies the recurring charge period (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Specifies the unit of measure (for example: minutes or GB)." }, "price":{ "$ref":"#/components/schemas/Price" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlteration" } } }, "PriceAlteration_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"An amount, usually monetary, that modifies the price charged for an order item.", "properties":{ "applicationDuration":{ "type":"integer", "description":"The duration for which the alteration applies to the order item price (for example: 2 months free of charge for the recurring charge)." }, "description":{ "type":"string", "description":"Explains the semantics of this order item price alteration." }, "name":{ "type":"string", "description":"The order item price alteration name." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef_FVO" }, "priceType":{ "type":"string", "description":"The price category (for example: recurring, one time, or usage)." }, "priority":{ "type":"integer", "description":"The priority for applying this alteration among all defined alterations on the order item price." }, "recurringChargePeriod":{ "type":"string", "description":"Specifies the recurring charge period (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Specifies the unit of measure (for example: minutes or GB)." }, "price":{ "$ref":"#/components/schemas/Price_FVO" } }, "required":[ "priceType", "price" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlteration_FVO" } } }, "PriceAlteration_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An amount, usually monetary, that modifies the price charged for an order item.", "properties":{ "applicationDuration":{ "type":"integer", "description":"The duration for which the alteration applies to the order item price (for example: 2 months free of charge for the recurring charge)." }, "description":{ "type":"string", "description":"Explains the semantics of this order item price alteration." }, "name":{ "type":"string", "description":"The order item price alteration name." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef_MVO" }, "priceType":{ "type":"string", "description":"The price category (for example: recurring, one time, or usage)." }, "priority":{ "type":"integer", "description":"The priority for applying this alteration among all defined alterations on the order item price." }, "recurringChargePeriod":{ "type":"string", "description":"Specifies the recurring charge period (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Specifies the unit of measure (for example: minutes or GB)." }, "price":{ "$ref":"#/components/schemas/Price_MVO" } }, "required":[ "priceType", "price" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlteration_MVO" } } }, "PriceAlterationOracle":{ "allOf":[ { "$ref":"#/components/schemas/PriceAlteration" }, { "type":"object", "description":"Is an amount, usually of money, that modifies the price charged for an order item.", "properties":{ "priceType":{ "type":"string", "description":"A category that describes the price, such as AmountOverride, DiscountPercentageOverride, or DiscountAmountOverride.", "enum":[ "AmountOverride", "DiscountPercentageOverride", "DiscountAmountOverride" ] } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlterationOracle" } } }, "PriceAlterationOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/PriceAlteration_FVO" }, { "type":"object", "description":"Is an amount, usually of money, that modifies the price charged for an order item.", "properties":{ "priceType":{ "type":"string", "description":"A category that describes the price, such as AmountOverride, DiscountPercentageOverride, or DiscountAmountOverride.", "enum":[ "AmountOverride", "DiscountPercentageOverride", "DiscountAmountOverride" ] } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlterationOracle_FVO" } } }, "PriceAlterationOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/PriceAlteration_MVO" }, { "type":"object", "description":"Is an amount, usually of money, that modifies the price charged for an order item.", "properties":{ "priceType":{ "type":"string", "description":"A category that describes the price, such as AmountOverride, DiscountPercentageOverride, or DiscountAmountOverride.", "enum":[ "AmountOverride", "DiscountPercentageOverride", "DiscountAmountOverride" ] } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "PriceAlteration":"#/components/schemas/PriceAlterationOracle_MVO" } } }, "Price_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.", "properties":{ "dutyFreeAmount":{ "$ref":"#/components/schemas/Money" }, "percentage":{ "type":"number", "format":"float", "description":"The percentage to apply to a product offering price alteration." }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxRate":{ "type":"number", "format":"float", "description":"The tax rate." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Price":"#/components/schemas/Price_FVO" } } }, "Price_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Provides monetary amounts (tax included, duty-free), currency, and percentages to apply to Price and PriceAlteration.", "properties":{ "dutyFreeAmount":{ "$ref":"#/components/schemas/Money" }, "percentage":{ "type":"number", "format":"float", "description":"The percentage to apply to a product offering price alteration." }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxRate":{ "type":"number", "format":"float", "description":"The tax rate." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Price":"#/components/schemas/Price_MVO" } } }, "Producer":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole" } ] }, "Producer_FVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole_FVO" } ] }, "Producer_MVO":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/PartyRole_MVO" } ] }, "Product":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"A product offering procured by a customer or any other party playing a party role. The product is realized as one or more services or resources.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "description":{ "type":"string", "description":"Describes the product. You can copy it from the product offering description." }, "isBundle":{ "type":"boolean", "description":"Indicates whether the product is a ProductBundle (true) or a ProductComponent (false)." }, "name":{ "type":"string", "description":"The product name; it can match the product offering name." }, "productCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" } }, "productOffering":{ "$ref":"#/components/schemas/ProductOfferingRef" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRefOrValue" } }, "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPrice" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationship" } }, "realizingService":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceRef" } }, "startDate":{ "type":"string", "format":"date-time", "description":"The date the product starts." }, "status":{ "$ref":"#/components/schemas/ProductStatusType" }, "terminationDate":{ "type":"string", "format":"date-time", "description":"The date the product was terminated." } } } ] }, "ProductOracle":{ "allOf":[ { "$ref":"#/components/schemas/Product" }, { "type":"object", "description":"A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service and/or resources.", "properties":{ "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPriceOracle" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationshipOracle" } }, "cycleStart":{ "$ref":"#/components/schemas/CycleStartRef" }, "usageStart":{ "$ref":"#/components/schemas/UsageStartRef" }, "purchaseStart":{ "$ref":"#/components/schemas/PurchaseStartRef" }, "cycleEnd":{ "$ref":"#/components/schemas/CycleEndRef" }, "usageEnd":{ "$ref":"#/components/schemas/UsageEndRef" }, "purchaseEnd":{ "$ref":"#/components/schemas/PurchaseEndRef" }, "cycleStartDate":{ "type":"string", "format":"date-time", "description":"The purchased product cycle start date." }, "cycleEndDate":{ "type":"string", "format":"date-time", "description":"The purchased product cycle end date." }, "purchaseStartDate":{ "type":"string", "format":"date-time", "description":"The purchased product purchase start date." }, "purchaseEndDate":{ "type":"string", "format":"date-time", "description":"The purchased product purchase end date." }, "usageStartDate":{ "type":"string", "format":"date-time", "description":"The purchased product usage start date." }, "usageEndDate":{ "type":"string", "format":"date-time", "description":"The purchased product usage end date." }, "gracePeriod":{ "$ref":"#/components/schemas/GracePeriodRef" }, "specialRatingProfile":{ "description":"Service extended rating profile linked to the product.", "allOf":[ { "$ref":"#/components/schemas/SpecialRatingProfile" } ] }, "quantity":{ "type":"integer", "description":"Is the quantity of service while creation of a purchase product." } } } ] }, "ProductAttributeValueChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"ProductAttributeValueChange structure", "properties":{ "event":{ "$ref":"#/components/schemas/ProductAttributeValueChangePayload" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductAttributeValueChangeEvent":"#/components/schemas/ProductAttributeValueChangeEvent" } } }, "ProductAttributeValueChangePayload":{ "type":"object", "description":"ProductAttributeValueChangePayload generic structure", "properties":{ "product":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] } } }, "ProductCreateEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"The ProductCreateEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/ProductCreateEventPayload" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductCreateEvent":"#/components/schemas/ProductCreateEvent" } } }, "ProductCreateEventPayload":{ "type":"object", "description":"The ProductCreateEventPayload.", "properties":{ "product":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] } } }, "ProductDeleteEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"Defines the generic ProductDeleteEvent structure.", "properties":{ "event":{ "$ref":"#/components/schemas/ProductDeleteEventPayload" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductDeleteEvent":"#/components/schemas/ProductDeleteEvent" } } }, "ProductDeleteEventPayload":{ "type":"object", "description":"The product delete payload.", "properties":{ "product":{ "$ref":"#/components/schemas/Product" } } }, "ProductOfferingPriceRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.", "properties":{ "version":{ "type":"string", "description":"The product offering price version." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef" } } }, "ProductOfferingPriceRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.", "properties":{ "version":{ "type":"string", "description":"The product offering price version." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef_FVO" } } }, "ProductOfferingPriceRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"An amount, usually monetary, that is asked for or allowed when a ProductOffering is bought, rented, or leased.", "properties":{ "version":{ "type":"string", "description":"The product offering price version." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingPriceRef":"#/components/schemas/ProductOfferingPriceRef_MVO" } } }, "ProductOfferingRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Represents entities that are orderable from the catalog provider. This resource includes pricing information.", "properties":{ "version":{ "type":"string", "description":"Version of the product offering" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef" } } }, "ProductOfferingRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"ProductOffering reference. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information.", "properties":{ "version":{ "type":"string", "description":"The product offering version." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef_FVO" } } }, "ProductOfferingRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Represents entities that are orderable from the catalog provider. This resource includes pricing information.", "properties":{ "version":{ "type":"string", "description":"The product offering version." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductOfferingRef":"#/components/schemas/ProductOfferingRef_MVO" } } }, "ProductPrice":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes the price and any discount awarded.", "properties":{ "description":{ "type":"string", "description":"A description of the product price." }, "name":{ "type":"string", "description":"The name of the product price." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef" }, "recurringChargePeriod":{ "type":"string", "description":"Indicates the period for a recurring charge (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Unit of measure if the price depends on it (for example: GB or SMS volume)." }, "price":{ "$ref":"#/components/schemas/Price" }, "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlteration" } }, "priceType":{ "type":"string", "description":"Indicates whether the price is for a recurring or a non-recurring charge." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPrice" } } }, "ProductPrice_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Describes the price and any discount awarded.", "properties":{ "description":{ "type":"string", "description":"A description of the product price." }, "name":{ "type":"string", "description":"The name of the product price." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef_FVO" }, "recurringChargePeriod":{ "type":"string", "description":"Indicates the period for a recurring charge (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Unit of measure if the price depends on it (for example: GB or SMS volume)." }, "price":{ "$ref":"#/components/schemas/Price_FVO" }, "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlteration_FVO" } }, "priceType":{ "type":"string", "description":"Indicates whether the price is for a recurring or a non-recurring charge." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPrice_FVO" } } }, "ProductPrice_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"A description of the price and discount awarded.", "properties":{ "description":{ "type":"string", "description":"The description of the product price." }, "name":{ "type":"string", "description":"The name of the product price." }, "productOfferingPrice":{ "$ref":"#/components/schemas/ProductOfferingPriceRef_MVO" }, "recurringChargePeriod":{ "type":"string", "description":"Indicates the period for a recurring charge (for example: month or week)." }, "unitOfMeasure":{ "type":"string", "description":"Unit of measure if the price depends on it (for example: GB or SMS volume)." }, "price":{ "$ref":"#/components/schemas/Price_MVO" }, "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlteration_MVO" } }, "priceType":{ "type":"string", "description":"Indicates whether the price is for a recurring or a non-recurring charge." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPrice_MVO" } } }, "ProductPriceOracle":{ "allOf":[ { "$ref":"#/components/schemas/ProductPrice" }, { "type":"object", "description":"A description of the price and discount awarded.", "properties":{ "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlterationOracle" } }, "priceType":{ "type":"string", "description":"The price type: one-time or recurring.", "enum":[ "oneTime", "recurring" ] } }, "required":[ "priceType", "priceAlteration" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPriceOracle" } } }, "ProductPriceOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ProductPrice_FVO" }, { "type":"object", "description":"A description of the price and discount awarded.", "properties":{ "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlterationOracle_FVO" } }, "priceType":{ "type":"string", "description":"The price type: one-time or recurring.", "enum":[ "oneTime", "recurring" ] } }, "required":[ "priceType", "price" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPriceOracle_FVO" } } }, "ProductPriceOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ProductPrice_MVO" }, { "type":"object", "description":"A description of the price and discount awarded.", "properties":{ "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlterationOracle_MVO" } }, "priceType":{ "type":"string", "description":"The price type: one-time or recurring.", "enum":[ "oneTime", "recurring" ] } }, "required":[ "priceType", "price" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductPrice":"#/components/schemas/ProductPriceOracle_MVO" } } }, "ProductRef":{ "type":"object", "description":"A product reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ] }, "ProductRefOrValue":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductRef" }, { "$ref":"#/components/schemas/ProductOracle" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Product":"#/components/schemas/Product", "ProductRef":"#/components/schemas/ProductRef", "ProductOracle":"#/components/schemas/ProductOracle" } } }, "ProductRefOrValue_FVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/Product_FVO" }, { "$ref":"#/components/schemas/ProductRef_FVO" }, { "$ref":"#/components/schemas/ProductOracle_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Product":"#/components/schemas/Product_FVO", "ProductRef":"#/components/schemas/ProductRef_FVO", "ProductOracle":"#/components/schemas/ProductOracle_FVO" } } }, "ProductRefOrValue_MVO":{ "type":"object", "description":"The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the Product entity, not to the ProductRefOrValue class.", "oneOf":[ { "$ref":"#/components/schemas/Product_MVO" }, { "$ref":"#/components/schemas/ProductRef_MVO" }, { "$ref":"#/components/schemas/ProductOracle_MVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "Product":"#/components/schemas/Product_MVO", "ProductRef":"#/components/schemas/ProductRef_MVO", "ProductOracle":"#/components/schemas/ProductOracle_MVO" } } }, "ProductRef_FVO":{ "type":"object", "description":"A product reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" } ] }, "ProductRef_MVO":{ "type":"object", "description":"A product reference.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ] }, "ProductRelationship":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Describes the relationship between products.", "properties":{ "id":{ "type":"string", "description":"The related product's ID." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: bundledBy, bundles, tiedDiscount, or tiedProduct)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationship" } } }, "ProductRelationshipType":{ "enum":[ "bundles", "bundledBy", "tiedDiscount", "tiedProduct" ], "type":"string", "description":"The product relationship type: bundles, bundledBy, tiedDiscount, or tiedProduct." }, "ProductRelationship_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"Describes the relationship between products.", "properties":{ "id":{ "type":"string", "description":"The related product's ID." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: bundledBy, bundles, tiedDiscount, or tiedProduct)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationship_FVO" } } }, "ProductRelationship_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"Describes relationships between products.", "properties":{ "id":{ "type":"string", "description":"The related product's ID." }, "relationshipType":{ "type":"string", "description":"Specifies the relationship type (for example: bundledBy, bundles, tiedDiscount, or tiedProduct)." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationship_MVO" } } }, "ProductRelationshipOracle":{ "allOf":[ { "$ref":"#/components/schemas/ProductRelationship" }, { "type":"object", "description":"Used to describe the relationship between products.", "properties":{ "relationshipType":{ "type":"string", "description":"The relationship type: bundles, bundledBy, tiedDiscount, tiedProduct.", "enum":[ "bundles", "bundledBy", "tiedDiscount", "tiedProduct" ] } }, "required":[ "id", "relationshipType" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationshipOracle" } } }, "ProductRelationshipOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/ProductRelationship_FVO" }, { "type":"object", "description":"Used to describe the relationship between the products.", "properties":{ "id":{ "type":"string", "description":"Id of the related product" }, "relationshipType":{ "type":"string", "description":"The relationship type: bundles, bundledBy, tiedDiscount, tiedProduct.", "enum":[ "bundles", "bundledBy", "tiedDiscount", "tiedProduct" ] } }, "required":[ "id", "relationshipType" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationshipOracle_FVO" } } }, "ProductRelationshipOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/ProductRelationship_MVO" }, { "type":"object", "description":"Used to describe relationship between product.", "properties":{ "id":{ "type":"string", "description":"Id of the related product" }, "relationshipType":{ "type":"string", "description":"Relationship type as relies on, bundles, etc...", "enum":[ "bundles", "bundledBy", "tiedDiscount", "tiedProduct" ] } }, "required":[ "id", "relationshipType" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductRelationship":"#/components/schemas/ProductRelationshipOracle_MVO" } } }, "ProductSpecificationRef":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"A product specification represents entities orderable from the catalog provider.", "properties":{ "version":{ "type":"string", "description":"The product specification version." }, "targetProductSchema":{ "$ref":"#/components/schemas/TargetProductSchema" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductSpecificationRef":"#/components/schemas/ProductSpecificationRef" } } }, "ProductSpecificationRef_FVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" }, { "type":"object", "description":"A product specification represents entities orderable from the catalog provider.", "properties":{ "version":{ "type":"string", "description":"The product specification version." }, "targetProductSchema":{ "$ref":"#/components/schemas/TargetProductSchema_FVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductSpecificationRef":"#/components/schemas/ProductSpecificationRef_FVO" } } }, "ProductSpecificationRef_MVO":{ "allOf":[ { "$ref":"#/components/schemas/EntityRef" }, { "type":"object", "description":"A product specification represents entities orderable from the catalog provider.", "properties":{ "version":{ "type":"string", "description":"The product specification version." }, "targetProductSchema":{ "$ref":"#/components/schemas/TargetProductSchema_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductSpecificationRef":"#/components/schemas/ProductSpecificationRef_MVO" } } }, "ProductStateChangeEvent":{ "allOf":[ { "$ref":"#/components/schemas/Event" }, { "type":"object", "description":"The ProductStateChangeEvent generic structure.", "properties":{ "event":{ "$ref":"#/components/schemas/ProductStateChangeEventPayload" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductStateChangeEvent":"#/components/schemas/ProductStateChangeEvent" } } }, "ProductStateChangeEventPayload":{ "type":"object", "description":"The ProductStateChangeEventPayload generic structure.", "properties":{ "product":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] } } }, "ProductStatusType":{ "enum":[ "created", "pendingActive", "cancelled", "active", "pendingTerminate", "terminated", "suspended", "aborted" ], "type":"string", "description":"The possible values for a product's status." }, "ProductTerm":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes a product term linked to this product; represents a commitment with a duration.", "properties":{ "description":{ "type":"string", "description":"The product term's description." }, "duration":{ "$ref":"#/components/schemas/Duration" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"The product term's name.", "example":"12months commitment" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductTerm":"#/components/schemas/ProductTerm" } } }, "ProductTerm_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Describes a product term linked to this product; represents a commitment with a duration.", "properties":{ "description":{ "type":"string", "description":"The product term's description." }, "duration":{ "$ref":"#/components/schemas/Duration" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"The product term's name.", "example":"12months commitment" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductTerm":"#/components/schemas/ProductTerm_FVO" } } }, "ProductTerm_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Describes a product term linked to this product; represents a commitment with a duration.", "properties":{ "description":{ "type":"string", "description":"The product term's description." }, "duration":{ "$ref":"#/components/schemas/Duration" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "name":{ "type":"string", "description":"The product term's name.", "example":"12months commitment" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ProductTerm":"#/components/schemas/ProductTerm_MVO" } } }, "Product_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"A product offering procured by a customer or a party playing a party role. A product is realized as one or more services and resources.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef_FVO" }, "description":{ "type":"string", "description":"Describes the product. You can copy it from the product offering description." }, "isBundle":{ "type":"boolean", "description":"Indicates whether the product is a ProductBundle (true) or a ProductComponent (false)." }, "name":{ "type":"string", "description":"The product name; it can match the product offering name." }, "productCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_FVO" } }, "productOffering":{ "$ref":"#/components/schemas/ProductOfferingRef_FVO" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRefOrValue_FVO" } }, "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPrice_FVO" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationship_FVO" } }, "realizingService":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceRef_FVO" } }, "startDate":{ "type":"string", "format":"date-time", "description":"The date the product starts." }, "status":{ "$ref":"#/components/schemas/ProductStatusType" }, "terminationDate":{ "type":"string", "format":"date-time", "description":"The date the product was terminated." } }, "required":[ "status", "billingAccount" ] } ] }, "ProductOracle_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Product_FVO" }, { "type":"object", "description":"Provides extended fields for the product schema.", "properties":{ "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPriceOracle_FVO" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationshipOracle_FVO" } }, "cycleStart":{ "$ref":"#/components/schemas/CycleStartRef_FVO" }, "usageStart":{ "$ref":"#/components/schemas/UsageStartRef_FVO" }, "purchaseStart":{ "$ref":"#/components/schemas/PurchaseStartRef_FVO" }, "cycleEnd":{ "$ref":"#/components/schemas/CycleEndRef_FVO" }, "usageEnd":{ "$ref":"#/components/schemas/UsageEndRef_FVO" }, "purchaseEnd":{ "$ref":"#/components/schemas/PurchaseEndRef_FVO" }, "gracePeriod":{ "$ref":"#/components/schemas/GracePeriodRef_FVO" }, "tieId":{ "type":"string", "description":"Specifies the tie ID for tiedDiscount/tiedProduct scenarios." }, "specialRatingProfile":{ "description":"Service extended rating profile linked to the product.", "$ref":"#/components/schemas/SpecialRatingProfile_FVO" }, "quantity":{ "type":"integer", "description":"Specifies the service quantity when creating a purchase product." } } } ] }, "Product_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"A product offering procured by a customer or any other party playing a party role. A product is realized as one or more services and resources.", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef_MVO" }, "description":{ "type":"string", "description":"Describes the product. You can copy it from the product offering description." }, "isBundle":{ "type":"boolean", "description":"If true, the product is a ProductBundle which is an instantiation of a BundledProductOffering. If false, the product is a ProductComponent, which is an instantiation of a SimpleProductOffering." }, "name":{ "type":"string", "description":"The name of the product. It could be the same as the name of the product offering." }, "productCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic_MVO" } }, "productOffering":{ "$ref":"#/components/schemas/ProductOfferingRef_MVO" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRefOrValue_MVO" } }, "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPrice_MVO" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationship_MVO" } }, "realizingService":{ "type":"array", "items":{ "$ref":"#/components/schemas/ServiceRef_MVO" } }, "startDate":{ "type":"string", "format":"date-time", "description":"The date the product starts." }, "status":{ "$ref":"#/components/schemas/ProductStatusType" }, "terminationDate":{ "type":"string", "format":"date-time", "description":"The date the product was terminated." } } } ] }, "ProductOracle_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Product_MVO" }, { "type":"object", "description":"Provides extended fields for the product schema.", "properties":{ "productPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductPriceOracle_MVO" } }, "productRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRelationshipOracle_MVO" } }, "cycleStart":{ "$ref":"#/components/schemas/CycleStartRef_MVO" }, "usageStart":{ "$ref":"#/components/schemas/UsageStartRef_MVO" }, "purchaseStart":{ "$ref":"#/components/schemas/PurchaseStartRef_MVO" }, "cycleEnd":{ "$ref":"#/components/schemas/CycleEndRef_MVO" }, "usageEnd":{ "$ref":"#/components/schemas/UsageEndRef_MVO" }, "purchaseEnd":{ "$ref":"#/components/schemas/PurchaseEndRef_MVO" }, "quantity":{ "type":"integer", "description":"Specifies the service quantity when creating a purchase product." }, "tieId":{ "type":"string", "description":"Specifies the tie ID for tiedDiscount/tiedProduct scenarios." }, "specialRatingProfile":{ "description":"Service extended rating profile linked to the product.", "$ref":"#/components/schemas/SpecialRatingProfile_MVO" } } } ] }, "SpecialRatingProfile":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object" } ], "description":"Represents a product-linked special rating profile instance for BRM service extended rating.", "properties":{ "id":{ "type":"string", "description":"The profile identifier." }, "@type":{ "type":"string", "description":"Identifies the service extended rating profile type." }, "name":{ "type":"string", "description":"The special rating profile name." }, "label":{ "type":"string", "description":"The label used to identify the special rating profile in rating rules." }, "status":{ "type":"string", "enum":[ "noop", "provisioning", "provisioningFailed", "active", "unprovisioning", "unprovisioningFailed", "unprovisioned", "suspending", "suspendingFailed", "suspended" ], "description":"The special rating profile provisioning status." }, "referenceCount":{ "type":"integer", "description":"The special rating profile reference count." }, "data":{ "type":"array", "description":"The rating attribute values used by rating.", "items":{ "$ref":"#/components/schemas/SpecialRatingProfileData" } } } }, "SpecialRatingProfile_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/SpecialRatingProfile" }, { "type":"object", "properties":{ "data":{ "type":"array", "description":"The rating attribute values used by rating.", "items":{ "$ref":"#/components/schemas/SpecialRatingProfileData_FVO" } } } } ] }, "SpecialRatingProfile_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object" } ], "description":"Mutable fields for a product-linked special rating profile.", "properties":{ "id":{ "type":"string", "description":"The profile identifier." }, "@type":{ "type":"string", "description":"Identifies the service extended rating profile type." }, "name":{ "type":"string", "description":"The special rating profile name." }, "label":{ "type":"string", "description":"The label used to identify the special rating profile in rating rules." }, "status":{ "type":"string", "enum":[ "noop", "provisioning", "provisioningFailed", "active", "unprovisioning", "unprovisioningFailed", "unprovisioned", "suspending", "suspendingFailed", "suspended" ], "description":"The special rating profile provisioning status." }, "referenceCount":{ "type":"integer", "description":"The special rating profile reference count." }, "data":{ "type":"array", "description":"The rating attribute values used by rating.", "items":{ "$ref":"#/components/schemas/SpecialRatingProfileData" } } } }, "SpecialRatingProfileData":{ "type":"object", "description":"A name/value entry for a product-linked special rating profile.", "properties":{ "name":{ "type":"string", "description":"The profile data attribute name." }, "value":{ "type":"string", "description":"The profile data attribute value." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } }, "SpecialRatingProfileData_FVO":{ "allOf":[ { "$ref":"#/components/schemas/SpecialRatingProfileData" }, { "type":"object", "required":[ "name", "value" ] } ] }, "RelatedOrderItem":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An order item previously run.", "properties":{ "orderItemAction":{ "$ref":"#/components/schemas/ItemActionType" }, "orderHref":{ "type":"string", "description":"The reference to the related entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "role":{ "type":"string", "description":"The role played by the order." }, "orderId":{ "type":"string", "description":"The unique identifier of the related order." }, "orderItemId":{ "type":"string", "description":"The identifier of an item in a product order." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedOrderItem":"#/components/schemas/RelatedOrderItem" } } }, "RelatedOrderItem_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"An order item previously run.", "properties":{ "orderItemAction":{ "$ref":"#/components/schemas/ItemActionType" }, "orderHref":{ "type":"string", "description":"The reference to the related entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "role":{ "type":"string", "description":"The role played by the order." }, "orderId":{ "type":"string", "description":"The unique identifier of the related order." }, "orderItemId":{ "type":"string", "description":"The identifier of an item in a product order." } }, "required":[ "role", "orderId", "orderItemId" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedOrderItem":"#/components/schemas/RelatedOrderItem_FVO" } } }, "RelatedOrderItem_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"An order item previously run.", "properties":{ "orderItemAction":{ "$ref":"#/components/schemas/ItemActionType" }, "orderHref":{ "type":"string", "description":"The reference to the related entity." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance, used for disambiguation." }, "role":{ "type":"string", "description":"The role played by the order." }, "orderId":{ "type":"string", "description":"The unique identifier of the related order." }, "orderItemId":{ "type":"string", "description":"The identifier of an item in a product order." } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedOrderItem":"#/components/schemas/RelatedOrderItem_MVO" } } }, "RelatedPartyOrPartyRole":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Defines a party or party role (or its reference) linked to a specific entity.", "properties":{ "role":{ "description":"Role played by the related party or party role in the context of the specific entity (for example: initiator, customer, salesAgent, or user).", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyOrPartyRole" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPartyOrPartyRole":"#/components/schemas/RelatedPartyOrPartyRole" } } }, "RelatedPartyOrPartyRole_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Defines a party or party role (or its reference) linked to a specific entity.", "properties":{ "role":{ "description":"Role played by the related party or party role in the context of the specific entity (for example: initiator, customer, salesAgent, or user).", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyOrPartyRole_FVO" } }, "required":[ "role" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPartyOrPartyRole":"#/components/schemas/RelatedPartyOrPartyRole_FVO" } } }, "RelatedPartyOrPartyRole_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Defines a party or party role (or its reference) linked to a specific entity.", "properties":{ "role":{ "description":"Role played by the related party or party role in the context of the specific entity (for example: initiator, customer, salesAgent, or user).", "type":"string" }, "partyOrPartyRole":{ "$ref":"#/components/schemas/PartyOrPartyRole_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPartyOrPartyRole":"#/components/schemas/RelatedPartyOrPartyRole_MVO" } } }, "RelatedPlaceRefOrValue":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Entity reference. The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the RelatedPlace entity, not to the RelatedPlaceRefOrValue class.", "properties":{ "role":{ "type":"string", "description":"The role of the entity." }, "place":{ "$ref":"#/components/schemas/PlaceRefOrValue" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPlaceRefOrValue":"#/components/schemas/RelatedPlaceRefOrValue" } } }, "RelatedPlaceRefOrValue_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "type":"object", "description":"Entity reference. The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the RelatedPlace entity, not to the RelatedPlaceRefOrValue class.", "properties":{ "role":{ "type":"string", "description":"The role of the entity." }, "place":{ "$ref":"#/components/schemas/PlaceRefOrValue_FVO" } }, "required":[ "role", "place" ] } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPlaceRefOrValue":"#/components/schemas/RelatedPlaceRefOrValue_FVO" } } }, "RelatedPlaceRefOrValue_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "type":"object", "description":"Entity reference. The polymorphic attributes (@type, @schemaLocation, and @referredType) apply to the RelatedPlace entity, not to the RelatedPlaceRefOrValue class.", "properties":{ "role":{ "type":"string", "description":"The role of the entity." }, "place":{ "$ref":"#/components/schemas/PlaceRefOrValue_MVO" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "RelatedPlaceRefOrValue":"#/components/schemas/RelatedPlaceRefOrValue_MVO" } } }, "ResourceRef":{ "type":"object", "description":"The resource reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceRef":"#/components/schemas/ResourceRef" } } }, "ResourceRef_FVO":{ "type":"object", "description":"The resource reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceRef":"#/components/schemas/ResourceRef_FVO" } } }, "ResourceRef_MVO":{ "type":"object", "description":"The resource reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ResourceRef":"#/components/schemas/ResourceRef_MVO" } } }, "ServiceRef":{ "type":"object", "description":"The service reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ServiceRef":"#/components/schemas/ServiceRef" } } }, "ServiceRef_FVO":{ "type":"object", "description":"The service reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/Extensible_FVO" }, { "$ref":"#/components/schemas/EntityRef_FVO" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ServiceRef":"#/components/schemas/ServiceRef_FVO" } } }, "ServiceRef_MVO":{ "type":"object", "description":"The service reference used by other entities.", "allOf":[ { "$ref":"#/components/schemas/Extensible" }, { "$ref":"#/components/schemas/EntityRef" } ], "discriminator":{ "propertyName":"@type", "mapping":{ "ServiceRef":"#/components/schemas/ServiceRef_MVO" } } }, "Skill":{ "type":"object", "description":"Skills evaluated for an individual with a level and possibly with a limited validity when an obsolescence is defined (for example: the first-aid certificate first level is limited to one year and an update training is required each year to keep the level).", "properties":{ "skillCode":{ "type":"string", "description":"The skill code." }, "skillName":{ "type":"string", "description":"The skill name (for example: Java)." }, "evaluatedLevel":{ "type":"string", "description":"The individual's evaluated level of expertise for the skill." }, "comment":{ "type":"string", "description":"A free-text comment linked to the evaluation." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" } } }, "StandardIdentifier":{ "allOf":[ { "$ref":"#/components/schemas/Entity" }, { "type":"object", "description":"Identifies the resource across different standards or regulatory definitions. Includes the standard specification identifier (for example: ISO 3166-1 Alpha-2) and the corresponding value (for example: BE). Multiple standards may define a single entity (for example: country identifiers: ISO 3166-1 Alpha-2, ISO 3166-1 Alpha-3, or ISO 3166-1 Numeric).", "properties":{ "format":{ "type":"string", "description":"Standard or regulatory definition identifier (for example: ISO 3166-1).", "example":"ISO 3166-1" }, "value":{ "type":"string", "description":"The value of the resource in the corresponding standard (for example: a country code).", "example":"GB" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "StandardIdentifier":"#/components/schemas/StandardIdentifier" } } }, "StandardIdentifier_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_FVO" }, { "type":"object", "description":"Identifies the resource across different standards or regulatory definitions. Includes the standard specification identifier (for example: ISO 3166-1 Alpha-2) and the corresponding value (for example: BE). Multiple standards may define a single entity (for example: country identifiers: ISO 3166-1 Alpha-2, ISO 3166-1 Alpha-3, or ISO 3166-1 Numeric).", "properties":{ "format":{ "type":"string", "description":"Standard or regulatory definition identifier (for example: ISO 3166-1).", "example":"ISO 3166-1" }, "value":{ "type":"string", "description":"The value of the resource in the corresponding standard (for example: a country code).", "example":"GB" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "StandardIdentifier":"#/components/schemas/StandardIdentifier_FVO" } } }, "StandardIdentifier_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Entity_MVO" }, { "type":"object", "description":"Identifies the resource across different standards or regulatory definitions. Includes the standard specification identifier (for example: ISO 3166-1 Alpha-2) and the corresponding value (for example: BE). Multiple standards may define a single entity (for example: country identifiers: ISO 3166-1 Alpha-2, ISO 3166-1 Alpha-3, or ISO 3166-1 Numeric).", "properties":{ "format":{ "type":"string", "description":"The standard or regulatory definition identifier (for example: ISO 3166-1).", "example":"ISO 3166-1" }, "value":{ "type":"string", "description":"The value of the resource in the corresponding standard (for example: a country code).", "example":"GB" } } } ], "discriminator":{ "propertyName":"@type", "mapping":{ "StandardIdentifier":"#/components/schemas/StandardIdentifier_MVO" } } }, "StringArrayCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A list of characteristics with a String data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"string" } } } } ] }, "StringArrayCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A list of characteristics with a String data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"string" } } }, "required":[ "value" ] } ] }, "StringArrayCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A list of characteristics with a String data type.", "properties":{ "value":{ "type":"array", "items":{ "type":"string" } } }, "required":[ "value" ] } ] }, "StringCharacteristic":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic" }, { "type":"object", "description":"A characteristic with a String data type.", "properties":{ "value":{ "type":"string", "description":"The value of the characteristic." } } } ] }, "StringCharacteristic_FVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_FVO" }, { "type":"object", "description":"A characteristic with a String data type.", "properties":{ "value":{ "type":"string", "description":"The value of the characteristic." } }, "required":[ "value" ] } ] }, "StringCharacteristic_MVO":{ "allOf":[ { "$ref":"#/components/schemas/Characteristic_MVO" }, { "type":"object", "description":"A characteristic which value is a String.", "properties":{ "value":{ "type":"string", "description":"Value of the characteristic" } }, "required":[ "value" ] } ] }, "Supplier":{ "type":"object", "description":"Identifies the party role as a supplier.", "allOf":[ { "$ref":"#/components/schemas/PartyRole" } ] }, "Supplier_FVO":{ "type":"object", "description":"Identifies the party role as a supplier.", "allOf":[ { "$ref":"#/components/schemas/PartyRole_FVO" } ] }, "Supplier_MVO":{ "type":"object", "description":"When business partner is the Supplier ", "allOf":[ { "$ref":"#/components/schemas/PartyRole_MVO" } ] }, "TargetProductSchema":{ "type":"object", "description":"The reference object to the schema and type of target product described by the product specification.", "properties":{ "@type":{ "type":"string", "description":"The class type of the target product." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"The link to the schema describing the target product." } } }, "TargetProductSchema_FVO":{ "type":"object", "description":"The reference object to the schema and type of target product described by product specification.", "properties":{ "@type":{ "type":"string", "description":"The class type of the target product." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"Thea link to the schema describing the target product." } }, "required":[ "@type", "@schemaLocation" ] }, "TargetProductSchema_MVO":{ "type":"object", "description":"The reference object to the schema and type of target product described by the product specification.", "properties":{ "@type":{ "type":"string", "description":"The class type of the target product." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"The link to the schema describing the target product." } } }, "PaymentMethodType":{ "required":[ "@type", "details", "href", "id" ], "properties":{ "id":{ "type":"string", "description":"The payment method's ID." }, "href":{ "type":"string", "description":"The payment method's href." }, "name":{ "type":"string", "description":"The payment method's name." }, "description":{ "type":"string", "description":"The payment method's description." }, "validFor":{ "type":"object", "description":"The period of time for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriodType" }, "account":{ "type":"array", "description":"An account that owns or can use the payment method.", "items":{ "$ref":"#/components/schemas/AccountRefType" } }, "preferred":{ "type":"boolean", "description":"Whether this is the preferred payment method for the account, bill unit, or billing cycle specification (true) or not (false)." }, "relatedParty":{ "type":"array", "description":"The related party that owns the payment method.", "items":{ "$ref":"#/components/schemas/RelatedPartyRefType" } }, "@type":{ "type":"string", "description":"The payment method's type: tokenizedCard, bankAccountDebit, bankCard, or invoice. The value of this property determines the content of the details property.", "enum":[ "tokenizedCard", "bankAccountDebit", "bankCard", "invoice" ] }, "authorizationCode":{ "type":"string", "description":"An authorization code provided by a financial institution. Typically, for recurring payments using the payment method." }, "status":{ "type":"string", "description":"The payment method's status." }, "statusDate":{ "type":"string", "description":"The date the payment method's status was recorded.", "format":"date-time" }, "details":{ "type":"object", "description":"The payment method's details, which differ based on the @type property." } }, "description":"A payment method." }, "QuantityType":{ "required":[ "amount", "units" ], "properties":{ "amount":{ "type":"number", "description":"A numeric value.", "format":"decimal" }, "units":{ "type":"string", "description":"The unit the quantity is measured in." } }, "description":"A quantity or quantity range." }, "TimePeriodType":{ "required":[ "startDateTime" ], "properties":{ "startDateTime":{ "type":"string", "description":"The start of the time period.", "format":"date-time" }, "endDateTime":{ "type":"string", "description":"The end of the time period.", "format":"date-time" } }, "description":"A period of time." }, "RelatedPartyRefType":{ "required":[ "href", "id" ], "properties":{ "id":{ "type":"string", "description":"The related party's ID." }, "href":{ "type":"string", "description":"The related party's href." }, "@referredType":{ "type":"string", "description":"The type of related party. For example: account, customer, or user." }, "name":{ "type":"string", "description":"The related party's name." }, "role":{ "type":"string", "description":"The related party's role." } }, "description":"A related party." }, "PaymentMethodRequestType":{ "required":[ "details", "type" ], "properties":{ "name":{ "type":"string", "description":"The payment method's name." }, "description":{ "type":"string", "description":"The payment method's description." }, "validFor":{ "type":"object", "description":"The period of time for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriodType" }, "preferred":{ "type":"boolean", "description":"Whether this is the preferred payment method for the account (true) or not (false). If set to true, the payment method is assigned to the account's default bill unit." }, "account":{ "type":"array", "description":"The account number or external ID of the account that owns or can use the payment method.", "items":{ "$ref":"#/components/schemas/AccountRefType" } }, "relatedParty":{ "type":"array", "description":"The related party that owns the payment method.", "items":{ "$ref":"#/components/schemas/RelatedPartyRefType" } }, "type":{ "type":"string", "description":"The payment method's type. The value of this property determines the content of the details property.", "enum":[ "bankAccountDebit" ] }, "authorizationCode":{ "type":"string", "description":"An authorization code provided by a financial institution. Typically, for recurring payments using the payment method." }, "status":{ "type":"string", "description":"The payment method's status." }, "details":{ "type":"object", "description":"The payment method's details, which differ based on the type property. Use the following properties for type=bankAccountDebit: \n
For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due.
For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.", "$ref":"#/components/schemas/Quantity" }, "bieId":{ "type":"array", "x-cardinality":"1", "description":"The bills, items, or events associated with the adjustment.", "items":{ "$ref":"#/components/schemas/BieFieldOracle" } }, "bucket":{ "description":"The bucket to track the adjustment in. For noncurrency adjustments, this is required.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the adjustment. (BRM does not use this property).", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date that the adjustment was confirmed. (BRM does not use this property).", "format":"date-time" }, "impactedBucket":{ "type":"array", "description":"A bucket impacted by the adjustment request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"The logical resource associated with the adjusted balance. (BRM does not use this property).", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"The party account associated with the adjusted balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"The product associated with the adjusted balance.", "$ref":"#/components/schemas/ProductRef", "examples":{ "createAdjustmentProductIdExample":{ "value":"0.0.0.1+-service-telco-gsm-telephony+247218", "summary":"product.id=0.0.0.1+-service-telco-gsm-telephony+247218" }, "createAdjustmentProductIdExample2":{ "value":"aliasMsisdnBase_0010", "summary":"product.id=aliasMsisdnBase_0010" }, "createAdjustmentProductIdExample3":{ "value":"vemoort_gsm1", "summary":"product.id=vemoort_gsm1" } } }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the adjustment." }, "relatedParty":{ "type":"array", "description":"The parties are related to the adjusted balance. (BRM does not use this property).", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "description":"The date and time that the request was received.", "format":"date-time" }, "requestor":{ "description":"The party that requested the adjustment.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The adjustment's status." }, "taxTreatment":{ "type":"string", "description":"The tax treatment for the adjustment." }, "usageType":{ "type":"string", "description":"The usage type for the adjustment. (BRM does not use this property)." } }, "description":"An adjustment to a balance, used in AdjustBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests.
The value for amount can be a positive or negative integer. For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.
For noncurrency adjustments, the bucket property is required.." }, "AdjustBalance_Update":{ "type":"object", "title":"Adjust Balance Update", "properties":{ "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date and time that the adjustment was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Adjust Balance Description", "description":"The adjusted balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the adjustment." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date and time that the request was received.", "format":"date-time" }, "adjustType":{ "type":"string", "description":"The adjustment type." }, "amount":{ "description":"The amount to adjust.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket to track the adjustment in.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the adjustment.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "description":"The logical resource associated with the adjusted balance.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"The party account associated with the adjusted balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"The product associated with the adjusted balance.", "$ref":"#/components/schemas/ProductRef" }, "relatedParty":{ "type":"array", "description":"The parties are related to the adjusted balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party that requested the adjustment.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The adjustment's status." }, "usageType":{ "type":"string", "description":"The usage type associated with the adjusted balance." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An adjustment to a balance, used in AdjustBalance update requests. The id and href properties are not used in update requests." }, "AdjustType":{ "type":"string", "title":"Adjust Type", "description":"The type of adjustment: recurring or oneTime.", "enum":[ "recurring", "oneTime" ] }, "Bucket":{ "required":[ "id", "href", "validFor", "status" ], "type":"object", "title":"Bucket", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "description":{ "type":"string", "description":"The bucket's description. (BRM does not use this property)." }, "href":{ "type":"string", "title":"Bucket Href", "description":"The bucket's href. (BRM does not use this property)." }, "id":{ "type":"string", "title":"Bucket ID", "description":"The bucket's ID." }, "isShared":{ "type":"boolean", "title":"Is Shared", "description":"The value indicates whether the bucket is shared between several devices or users (true) or not (false)." }, "logicalResource":{ "type":"array", "description":"The logical resources are associated with the bucket.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "name":{ "type":"string", "title":"Bucket Name", "description":"The bucket's name." }, "partyAccount":{ "description":"The party account associated with the bucket.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"The products are associated with the bucket.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"The parties are related to the bucket. (BRM does not use this property).", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "remainingValue":{ "description":"The amount remaining in the bucket.", "$ref":"#/components/schemas/Quantity" }, "remainingValueName":{ "type":"string", "title":"Remaining Value", "description":"A string, including value and unit, representing the remaining amount in the bucket, used for display purposes. For example, 1.9 GB." }, "reservedValue":{ "description":"The amount reserved in the bucket.", "$ref":"#/components/schemas/Quantity" }, "status":{ "type":"string", "description":"The bucket's status. For example: active, expired, or suspended." }, "usageType":{ "type":"string", "description":"The bucket's usage type." }, "validFor":{ "description":"The time period for which the bucket is valid.", "$ref":"#/components/schemas/TimePeriod" } }, "description":"A bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency resources (such as messages, minutes, data)." }, "BucketRef":{ "required":[ "id" ], "type":"object", "title":"Bucket Ref", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "href":{ "type":"string", "description":"The bucket's href.", "format":"uri" }, "id":{ "type":"string", "title":"Bucket ID", "description":"The bucket's ID." }, "name":{ "type":"string", "title":"Bucket Name", "description":"The bucket's name." }, "usageType":{ "type":"string", "description":"The bucket's usage type." } }, "description":"A reference to a bucket." }, "BucketStatusType":{ "type":"string", "title":"Bucket Status Type", "description":"A bucket's status: active, suspended, or expired.", "enum":[ "active", "suspended", "expired" ] }, "BucketStatusExampleType":{ "type":"string", "description":"The example values for the bucket status: active, suspended, or expired.", "enum":[ "active", "suspended", "expired" ] }, "Bucket_Create":{ "required":[ "usageType" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "description":{ "type":"string", "description":"The text describes the contents of the balance managed by the bucket." }, "isShared":{ "type":"boolean", "description":"The value indicates whether the bucket is shared between several devices or users (true) or not (false)." }, "logicalResource":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "name":{ "type":"string", "description":"A friendly name to identify the bucket." }, "partyAccount":{ "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"The value is used to provide information about any other entity with relation. to the balance. For instance, to define a customer hierarchy for the balance (such as customerId, userId).", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "remainingValue":{ "$ref":"#/components/schemas/Quantity" }, "remainingValueName":{ "type":"string", "description":"The remaining amount is provided in a formatted string for the bucket given. in the balance unit (for example, 1.9 Gb). For example, this formatted string could be used for display needs." }, "reservedValue":{ "$ref":"#/components/schemas/Quantity" }, "status":{ "type":"string", "description":"The status for the bucket: active, expired, or suspended." }, "usageType":{ "type":"string", "description":"The bucket's usage type." }, "validFor":{ "description":"The time period for which the bucket is valid.", "$ref":"#/components/schemas/TimePeriod" } }, "description":"A bucket, used in bucket create requests." }, "ChannelRef":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "title":"Channel ID", "description":"The channel's ID." }, "href":{ "type":"string", "title":"Channel Href", "description":"The channel's href." }, "name":{ "type":"string", "title":"Channel Name", "description":"The channel's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to a channel." }, "CostOwnerType":{ "type":"string", "title":"Cost OwnerType", "description":"The type of cost owner: originator or receiver.", "enum":[ "originator", "receiver" ] }, "ImpactedBucket":{ "required":[ "item" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amountAfter":{ "description":"The amount in the bucket after the impact.", "$ref":"#/components/schemas/Quantity" }, "amountBefore":{ "description":"The amount in the bucket before the impact.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"A reference to the impacted bucket.", "$ref":"#/components/schemas/BucketRef" }, "confirmationDate":{ "type":"string", "description":"The date and time the impact was confirmed.", "format":"date-time" }, "description":{ "type":"string", "description":"The impacted bucket's description." }, "item":{ "minItems":1, "type":"array", "description":"The impacted bucket items.", "items":{ "$ref":"#/components/schemas/ImpactedBucketItem" } }, "name":{ "type":"string", "description":"The impacted bucket's name." }, "requestedDate":{ "type":"string", "description":"The date and time the request was received.", "format":"date-time" } }, "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation." }, "ImpactedBucketItem":{ "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amount":{ "description":"The impact item's amount.", "$ref":"#/components/schemas/Quantity" }, "description":{ "type":"string", "description":"The impact item's description." }, "itemType":{ "type":"string", "description":"The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit)." }, "name":{ "type":"string", "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees." }, "reason":{ "type":"string", "description":"The reason for the impact item." } }, "description":"An impact item that affects an ImpactedBucket object." }, "LogicalResourceRef":{ "required":[ "id" ], "type":"object", "title":"Logical Resource Ref", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "href":{ "type":"string", "title":"Href", "description":"The resource's href." }, "id":{ "type":"string", "title":"ID", "description":"The resource's ID." }, "name":{ "type":"string", "title":"Name", "description":"The resource's name." }, "value":{ "type":"string", "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)." } }, "description":"A reference to a logical resource." }, "PartyAccountRef":{ "required":[ "id" ], "type":"object", "title":"Party Account Ref", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "description":{ "type":"string", "title":"Description", "description":"The party account's description." }, "href":{ "type":"string", "title":"Href", "description":"The party account's href." }, "id":{ "type":"string", "title":"Account ID", "description":"The party account's ID." }, "name":{ "type":"string", "title":"Name", "description":"The party account's name." }, "status":{ "type":"string", "title":"Status", "description":"The overall status of the account. For example: due, paid, or in arrears." } }, "description":"A reference to a party account." }, "PaymentRef":{ "required":[ "id" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@referredType":{ "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "href":{ "type":"string", "description":"The payment's href.", "format":"uri" }, "id":{ "type":"string", "description":"The payment's ID." }, "name":{ "type":"string", "description":"The payment's name." } }, "description":"A payment received at order time." }, "RecurringPeriodType":{ "type":"string", "title":"Recurring Period Type", "description":"A type of recurring period: weekly, fortnightly, or monthly.", "enum":[ "weekly", "fortnightly", "monthly" ] }, "RelatedParty":{ "required":[ "@referredType", "id" ], "type":"object", "title":"Related Party", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "href":{ "type":"string", "title":"Href", "description":"The party's href.", "format":"uri" }, "id":{ "type":"string", "title":"Party ID", "description":"The party's ID." }, "name":{ "type":"string", "title":"Party Name", "description":"The party's name." }, "role":{ "type":"string", "title":"Party Role", "description":"The party's role." } }, "description":"A party related to another object." }, "RelatedTopupBalance":{ "required":[ "@referredType", "id" ], "type":"object", "title":"Related Topup Balance", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "href":{ "type":"string", "title":"Href", "description":"The top-up balance's href." }, "id":{ "type":"string", "title":"ID", "description":"The top-up balance's ID." }, "name":{ "type":"string", "title":"Name", "description":"The top-up balance's name." }, "role":{ "type":"string", "title":"Role", "description":"The top-up balance's role. For example, parent or child." } }, "description":"A relationship between balance top-ups that defines whether a balance is the parent or child of another." }, "TopupBalance":{ "type":"object", "title":"Topup Balance", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the top-up was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "href":{ "type":"string", "title":"Href", "description":"The top-up balance's href.", "format":"uri" }, "id":{ "type":"string", "title":"ID", "description":"The top-up balance's ID." }, "impactedBucket":{ "type":"array", "description":"A reference to the bucket impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"The value indicates whether the top-up is automatic (true) or not (false)." }, "logicalResource":{ "description":"A logical resource associated with the top-up.", "$ref":"#/components/schemas/LogicalResourceRef" }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely." }, "partyAccount":{ "description":"A party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "payment":{ "description":"A payment associated with the top-up.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "description":"A product associated with the top-up.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "recurringPeriod":{ "type":"string", "description":"The type of recurring period for the top-up." }, "relatedParty":{ "type":"array", "description":"The parties are related to the top-up.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "relatedTopupBalance":{ "description":"A balance related to the top-up. (BRM does not use this property).", "$ref":"#/components/schemas/RelatedTopupBalance" }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date and time that the top-up request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The status of the request." }, "usageType":{ "type":"string", "description":"The top-up's usage type." }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." } }, "description":"A top-up." }, "TopupBalance_Create":{ "required":[ "amount" ], "type":"object", "title":"Topup Balance Create", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date the top-up was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "impactedBucket":{ "type":"array", "description":"A reference to buckets impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"The value indicates whether the top-up is automatic (true) or not (false)." }, "logicalResource":{ "description":"A logical resource associated with the top-up.", "$ref":"#/components/schemas/LogicalResourceRef" }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely." }, "partyAccount":{ "description":"A party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "payment":{ "description":"A payment associated with the top-up.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "description":"A product associated with the top-up.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "recurringPeriod":{ "type":"string", "description":"The type of recurring period for the top-up." }, "relatedParty":{ "type":"array", "description":"The parties are related to the top-up.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "relatedTopupBalance":{ "description":"A balance related to the top-up. (BRM does not use this property).", "$ref":"#/components/schemas/RelatedTopupBalance" }, "requestedDate":{ "type":"string", "description":"The date the top-up request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "usageType":{ "type":"string", "description":"The top-up's usage type." }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." } }, "description":"A top-up, used in TopupBalance create requests." }, "TopupBalance_Update":{ "type":"object", "title":"Topup Balance Update", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that top-up was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "impactedBucket":{ "type":"array", "description":"A reference to the bucket impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"The value indicates whether the top-up is automatic (true) or not (false)." }, "logicalResource":{ "description":"A logical resource associated with the top-up.", "$ref":"#/components/schemas/LogicalResourceRef" }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, the top-up will continue automatically indefinitely." }, "partyAccount":{ "description":"A party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "payment":{ "description":"A payment associated with the top-up.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "description":"A product associated with the top-up.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "recurringPeriod":{ "type":"string", "description":"The type of recurring period for the top-up." }, "relatedParty":{ "type":"array", "description":"The parties are related to the top-up.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "relatedTopupBalance":{ "description":"A balance related to the top-up. (BRM does not use this property).", "$ref":"#/components/schemas/RelatedTopupBalance" }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the top-up request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The status of the request." }, "usageType":{ "type":"string", "description":"The top-up's usage type." }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." } }, "description":"A top-up, used in TopupBalance update requests." }, "TransferBalance":{ "type":"object", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the transfer was confirmed.", "format":"date-time" }, "costOwner":{ "type":"string", "description":"The value indicates whether the cost owner is sending or receiving the transfer true or not false." }, "description":{ "type":"string", "title":"Description", "description":"The transfer's description." }, "href":{ "type":"string", "title":"Href", "description":"The transferred balance's href.", "format":"uri" }, "id":{ "type":"string", "title":"ID", "description":"The transferred balance's ID." }, "impactedBucket":{ "type":"array", "description":"The buckets are impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"A logical resource associated with the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"A party account associated with the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"A product associated with the transfer.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "type":"string", "description":"The usage type of the bucket receiving the transfer." }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverPartyAccount":{ "description":"The party account receiving the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "relatedParty":{ "type":"array", "description":"The parties are related to the transfer.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date when the transfer request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "transferCost":{ "description":"The cost of the transfer.", "$ref":"#/components/schemas/Quantity" }, "usageType":{ "type":"string", "description":"The transfer's usage type." } }, "description":"A balance being transferred between buckets." }, "TransferBalance_Create":{ "required":[ "amount" ], "type":"object", "title":"Transfer Balance Create", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date that the transfer was confirmed.", "format":"date-time" }, "costOwner":{ "type":"string", "description":"The value indicates whether the cost owner is sending or receiving the transfer true or not false." }, "description":{ "type":"string", "title":"Description", "description":"The transfer's description." }, "impactedBucket":{ "type":"array", "description":"The buckets are impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"A logical resource associated with the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"A party account associated with the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"A product associated with the transfer.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "type":"string", "description":"The usage type of the bucket receiving the transfer." }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverPartyAccount":{ "description":"The party account associated with the entity receiving the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "relatedParty":{ "type":"array", "description":"The parties are related to the transfer.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "description":"The date that the transfer request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "transferCost":{ "description":"The transfer's cost.", "$ref":"#/components/schemas/Quantity" }, "usageType":{ "type":"string", "description":"The transfer's usage type." } }, "description":"A balance being transferred between buckets, used in TransferBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests." }, "TransferBalance_Update":{ "type":"object", "title":"Transfer Balance Update", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date that the transfer was confirmed.", "format":"date-time" }, "costOwner":{ "type":"string", "description":"The value indicates whether the cost owner is sending or receiving the transfer true or not false." }, "description":{ "type":"string", "description":"The transfer's description." }, "impactedBucket":{ "type":"array", "description":"The buckets are impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"A logical resource associated with the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"A party account associated with the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"A product associated with the transfer.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "type":"string", "description":"The usage type of the bucket receiving the transfer." }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverPartyAccount":{ "description":"The party account receiving the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "relatedParty":{ "type":"array", "description":"The parties are related to the transfer.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "description":"The date that the transfer request was made.", "format":"date-time" }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "transferCost":{ "description":"The transfer's cost.", "$ref":"#/components/schemas/Quantity" }, "usageType":{ "type":"string", "description":"The transfer's usage type." } }, "description":"A balance being transferred between buckets, used in TransferBalance update requests. The id, href, status, requestedDate, confirmationDate, relatedParty, partyAccount, validFor, and description properties are not used in update requests." }, "UsageType":{ "type":"string", "title":"Usage Type", "description":"The type of usage: monetary, voice, data, sms, or other.
For BRM REST Services Manager, only monetary and other are supported.", "enum":[ "monetary", "voice", "data", "sms", "other" ] }, "EventSubscription":{ "required":[ "callback", "id" ], "type":"object", "title":"Event Subscription", "properties":{ "callback":{ "type":"string", "title":"Event Callback", "description":"The callback being registered." }, "id":{ "type":"string", "title":"Event ID", "description":"The event subscription listener's ID." }, "query":{ "type":"string", "title":"Event Query", "description":"The additional data is sent." } }, "description":"The endpoint address to which a service instance sends notifications." }, "EventSubscriptionInput":{ "required":[ "callback" ], "type":"object", "title":"Event Subscription Input", "properties":{ "callback":{ "type":"string", "title":"Event Callback", "description":"The callback being registered." }, "query":{ "type":"string", "title":"Event Query", "description":"The additional data is sent." } }, "description":"The input for the event subscription notification message." }, "TopupBalanceCancelEvent":{ "type":"object", "title":"Topup Balance Cancel Event", "description":"An event to cancel a balance top-up.", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceCancelEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } } }, "TopupBalanceCancelEventPayload":{ "type":"object", "title":"Topup Balace Cancel Event Payload", "properties":{ "topupBalance":{ "description":"The top-up balance to cancel.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceCancelEvent." }, "TopupBalanceCreateEvent":{ "type":"object", "title":"Topup Balance Create Event", "properties":{ "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceCreateEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." } }, "description":"An event for creating a top-up balance." }, "TopupBalanceCreateEventPayload":{ "type":"object", "title":"Topup Balance Create Event Payload", "properties":{ "topupBalance":{ "description":"The top-up balance to create.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceCreateEvent." }, "TopupBalanceFailureEvent":{ "type":"object", "title":"Topup Balance Failure Event", "description":"An event for a failed balance top-up.", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } } }, "TopupBalanceFailureEventPayload":{ "type":"object", "title":"Topup Balance Failure Event Payload", "properties":{ "topupBalance":{ "description":"The failed balance top-up.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceFailureEvent." }, "AdjustBalanceCreateEvent":{ "type":"object", "title":"Adjust Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/AdjustBalanceCreateEventPayload" }, "eventId":{ "type":"string", "description":"The event's ID." }, "eventTime":{ "type":"string", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "description":"The event's type." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's description." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a balance adjustment." }, "AdjustBalanceCreateEventPayload":{ "type":"object", "title":"Adjust Balance Create Event Payload", "properties":{ "adjustBalance":{ "description":"The adjusted balance to create.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceCreateEvent." }, "AdjustBalanceDeleteEvent":{ "type":"object", "properties":{ "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "description":{ "type":"string", "description":"The event's description." }, "domain":{ "type":"string", "description":"The event's domain." }, "event":{ "$ref":"#/components/schemas/AdjustBalanceDeleteEventPayload" }, "eventId":{ "type":"string", "description":"The event's ID." }, "eventTime":{ "type":"string", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "description":"The event's type." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "description":"The time the event occurred.", "format":"date-time" }, "title":{ "type":"string", "description":"The event's title." } }, "description":"An event for deleting a balance adjustment." }, "AdjustBalanceDeleteEventPayload":{ "type":"object", "properties":{ "adjustBalance":{ "description":"The adjusted balance to delete.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceDeleteEvent." }, "AdjustBalanceFailureEvent":{ "type":"object", "title":"Adjust Balance Failure Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/AdjustBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for a failed balance adjustment." }, "AdjustBalanceFailureEventPayload":{ "type":"object", "title":"Adjust Balance Failure Event Payload", "properties":{ "adjustBalance":{ "description":"The failed balance adjustment.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceFailureEvent." }, "TransferBalanceCreateEvent":{ "type":"object", "title":"Transfer Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TransferBalanceCreateEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a balance transfer." }, "TransferBalanceCreateEventPayload":{ "type":"object", "title":"Transfer Balance Create Event Payload", "properties":{ "transferBalance":{ "description":"The balance transfer to create.", "$ref":"#/components/schemas/TransferBalance" } }, "description":"The payload for TransferBalanceCreateEvent." }, "TransferBalanceFailureEvent":{ "type":"object", "title":"Transfer Balance Failure Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TransferBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for a failed balance transfer." }, "TransferBalanceFailureEventPayload":{ "type":"object", "title":"Transfer Balance Failure Event Payload", "properties":{ "transferBalance":{ "description":"The failed balance transfer.", "$ref":"#/components/schemas/TransferBalance" } }, "description":"The payload for TransferBalanceFailureEvent." }, "BillingCycleSpecificationRefOracle":{ "title":"Billing Cycle Specification Ref Oracle", "description":"A reference to a billing cycle specification, extended for BRM REST Services Manager.", "type":"object", "properties":{ "id":{ "title":"ID", "type":"string", "description":"The billing cycle specification's ID." }, "href":{ "type":"string", "title":"Href", "description":"The billing cycle specification's href." }, "name":{ "type":"string", "title":"Name", "description":"The billing cycle specification's name." } } }, "BillStructureRef":{ "title":"Bill Structure Ref", "description":"A reference to a bill structure, extended for BRM REST Services Manager.", "type":"object", "properties":{ "id":{ "title":"ID", "type":"string", "description":"The bill structure's ID." }, "href":{ "type":"string", "title":"Href", "description":"The bill structure's href." }, "name":{ "type":"string", "title":"Name", "description":"The bill structure's name." } } }, "BieFieldOracle":{ "required":[ "id" ], "type":"object", "title":"BIEField Oracle", "description":"A bill, item, or event, extended for BRM REST Services Manager.", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The bill, item, or event ID." }, "href":{ "type":"string", "title":"Href", "description":"The bill, item, or event href." } } }, "DisputeBalanceOracle":{ "required":[ "id", "href", "bill", "billingCycleSpecification" ], "title":"Dispute Balance Oracle", "description":"A disputed balance, extended for BRM REST Services Manager.", "type":"object", "properties":{ "id":{ "title":"Dispute ID", "type":"string", "description":"The disputed balance's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed balance's href." }, "actionType":{ "type":"string", "title":"Action Type", "description":"The type of balance being disputed: BillDispute, ItemDispute, or EventDispute.", "enum":[ "BillDispute", "ItemDispute", "EventDispute" ] }, "disputeNo":{ "title":"Dispute Number", "type":"string", "description":"The dispute number to display on a bill." }, "amount":{ "description":"The disputed amount.", "$ref":"#/components/schemas/Quantity" }, "taxAmount":{ "description":"The tax amount for the dispute.", "$ref":"#/components/schemas/Quantity" }, "reason":{ "title":"Dispute Reason", "type":"string", "description":"The reason for the dispute." }, "description":{ "title":"Dispute Description", "type":"string", "description":"The dispute's description." }, "partyAccount":{ "description":"The party account associated with the dispute.", "$ref":"#/components/schemas/PartyAccountRef" }, "discount":{ "title":"Discount", "type":"string", "description":"A discount associated with the dispute." }, "taxTreatment":{ "title":"Tax Treatment", "description":"The status of taxes on the dispute: TaxIncluded, TaxExcluded, or TaxOnly.", "type":"string", "enum":[ "TaxIncluded", "TaxExcluded", "TaxOnly" ] }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the dispute was confirmed.", "format":"date-time" }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date the request was made.", "format":"date-time" }, "billingCycleSpecification":{ "description":"The billing cycle specification associated with the dispute.", "$ref":"#/components/schemas/BillingCycleSpecificationRefOracle" }, "billStructure":{ "description":"The bill structure associated with the dispute.", "$ref":"#/components/schemas/BillStructureRef" }, "bill":{ "description":"The bill associated with the dispute.", "$ref":"#/components/schemas/BillRef" }, "billItem":{ "type":"array", "description":"The bill items associated with the dispute.", "items":{ "$ref":"#/components/schemas/BillItemDisputeOracle" } }, "billEvent":{ "type":"array", "description":"The events are associated with the dispute.", "items":{ "$ref":"#/components/schemas/BillEventDisputeOracle" } }, "status":{ "title":"Status", "type":"string", "description":"The dispute's status: Settled or Open.", "enum":[ "Settled", "Open" ] }, "settlementId":{ "title":"Settlement ID", "type":"string", "description":"The ID of the settlement associated with the dispute." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "DisputeBalance_CreateOracle":{ "required":[ "bieId", "amount" ], "title":"Dispute Balance Create Oracle", "description":"A disputed balance, used in DisputeBalance create requests.", "type":"object", "properties":{ "actionType":{ "title":"Action Type", "type":"string", "description":"The type of balance being disputed: BillDispute, EventDispute, or ItemDispute.", "enum":[ "BillDispute", "EventDispute", "ItemDispute" ] }, "amount":{ "description":"The amount of the disputed balance.", "$ref":"#/components/schemas/Quantity" }, "bieId":{ "type":"array", "x-cardinality":"1", "description":"The bill, item, or event IDs associated with the dispute.", "items":{ "$ref":"#/components/schemas/BieFieldOracle" } }, "taxTreatment":{ "title":"Tax Treatment", "description":"The status of taxes on the dispute: TaxIncluded, TaxExcluded, or TaxOnly.", "type":"string", "enum":[ "TaxIncluded", "TaxExcluded", "TaxOnly" ] }, "reason":{ "title":"Dispute Reason", "type":"string", "description":"The reason for the dispute." }, "description":{ "title":"Dispute Description", "type":"string", "description":"The dispute's description." }, "partyAccount":{ "description":"The party account associated with the dispute.", "$ref":"#/components/schemas/PartyAccountRef" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "BillEventDisputeOracle":{ "title":"BillEvent Dispute Oracle", "description":"A disputed bill event.", "type":"object", "properties":{ "id":{ "title":"Id", "type":"string", "description":"The disputed event's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed event's href." }, "name":{ "title":"Name", "type":"string", "description":"The disputed event's name." }, "originalCharge":{ "description":"The original amount charged that is being disputed.", "$ref":"#/components/schemas/Money" }, "adjustmentAmount":{ "description":"The adjusted amount to settle the dispute.", "$ref":"#/components/schemas/Money" } } }, "BillItemDisputeOracle":{ "required":[ "id", "href", "name" ], "title":"BillItem Dispute Oracle", "description":"A disputed bill item (AppliedCustomerBillingRate).", "type":"object", "properties":{ "id":{ "title":"Id", "type":"string", "description":"The disputed item's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed item's href." }, "name":{ "title":"Name", "type":"string", "description":"The disputed item's name." }, "originalCharge":{ "description":"The original amount charged that is being disputed.", "$ref":"#/components/schemas/Money" }, "adjustmentAmount":{ "description":"The adjusted amount to settle the dispute.", "$ref":"#/components/schemas/Money" } } }, "BillRef":{ "type":"object", "title":"Bill Ref", "description":"A reference to a bill.", "properties":{ "id":{ "type":"string", "title":"Bill ID", "description":"The bill's ID." }, "href":{ "type":"string", "title":"Bill Href", "description":"The bill's href." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The actual type of the target instance when needed for disambiguation." } } }, "BalanceAction":{ "required":[ "@type" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amount":{ "description":"The amount associated with the action.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket associated with the action.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel associated with the action.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date that the action was confirmed.", "format":"date-time" }, "description":{ "type":"string", "description":"The action's description." }, "href":{ "type":"string", "description":"The action's href." }, "id":{ "type":"string", "description":"The action's ID." }, "impactedBucket":{ "type":"array", "description":"The buckets impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"A logical resource associated with the action.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"A party account associated with the action.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"A product associated with the action.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "description":"The reason for the action." }, "relatedParty":{ "type":"array", "description":"The parties are related to the action.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "description":"The date that the request for the action was made.", "format":"date-time" }, "requestor":{ "description":"The party that requested the action.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "usageType":{ "type":"string", "description":"The action's usage type." } }, "description":"An abstract resource for an action, such as adjusting or topping up a balance." }, "AdjustThreshold":{ "required":[ "accountId" ], "title":"Adjust Threshold", "type":"object", "properties":{ "accountId":{ "type":"string", "title":"Account Id", "description":"The ID or account number of the billing account to adjust the threshold for." }, "bucket":{ "description":"The bucket to adjust the threshold for.", "$ref":"#/components/schemas/BucketRef" }, "product":{ "description":"A product associated with the bucket being adjusted.", "$ref":"#/components/schemas/ProductRef" }, "resourceType":{ "type":"string", "title":"Resource Type", "description":"The resource type of the balance element with the adjusted threshold." }, "thresholds":{ "type":"array", "description":"The new threshold amount.", "items":{ "$ref":"#/components/schemas/Quantity" } }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A threshold adjustment." }, "AccumulatedBalanceOracle":{ "title":"Accumulated Balance Oracle", "description":"The accumulated balance extended for BRM REST Services Manager. When the request filters by billStructure.id, the response includes billStructure and sets billingCycleSpecification to null. Otherwise, the response can include billingCycleSpecification without populating billStructure.", "allOf":[ { "$ref":"#/components/schemas/AccumulatedBalance" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "AccumulatedBalanceOracle" ], "description":"Specifies the extended accumulated balance's type." }, "billingCycleSpecification":{ "type":"array", "nullable":true, "description":"Specifies the associated billing cycle specifications. The response sets this field to null when the request filters by billStructure.id.", "items":{ "$ref":"#/components/schemas/BillingCycleSpecificationRefOracle" } }, "billStructure":{ "type":"object", "nullable":true, "description":"Specifies the bill structure associated with the accumulated balance when the request filters by billStructure.id.", "allOf":[ { "$ref":"#/components/schemas/BillStructureRef" } ] }, "unbilledBalance":{ "description":"Specifies the amount of the balance that remains unbilled.", "allOf":[ { "$ref":"#/components/schemas/Quantity" } ] }, "originalBalance":{ "description":"Specifies the original balance amount.", "allOf":[ { "$ref":"#/components/schemas/Quantity" } ] } } } ] }, "PaymentMethod":{ "description":"Specifies the base model for the implemented cash, check, bank account debit, bank card, and tokenized card payment methods.", "type":"object", "required":[ "@type", "name" ], "properties":{ "name":{ "type":"string", "description":"Specifies the payment method's friendly name." }, "description":{ "type":"string", "description":"Specifies a textual description of the payment method's contents." }, "isPreferred":{ "type":"boolean", "description":"Specifies whether the owner prefers this payment method. Queries for a specific customer's or account's payment methods typically use this value." }, "authorizationCode":{ "type":"string", "description":"Specifies the authorization code that a financial institution provides. For recurring payments that use this method, this field typically contains the code; individual payments have their own authorization codes." }, "status":{ "type":"string", "description":"Specifies the payment method's status." }, "statusDate":{ "type":"string", "format":"date-time", "description":"Specifies when the payment method's status last changed." }, "statusReason":{ "type":"string", "description":"Specifies the reason for the last status change." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"Specifies the payment method's validity period." }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ], "description":"Specifies the base resource type for an out-of-the-box payment method." }, "@type":{ "type":"string", "enum":[ "cash", "tokenizedCard", "bankAccountDebit", "bankCard", "check" ], "description":"Specifies the payment method's type, such as bank card, cash, or voucher." }, "relatedParty":{ "$ref":"#/components/schemas/RelatedParty", "description":"Refers to the customer or party that owns or can use the payment method." }, "relatedPlace":{ "$ref":"#/components/schemas/RelatedPlace", "description":"Refers to the place for the billing or delivery address when it differs from the related party's address." }, "account":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccountRef" }, "description":"Refers to the payment method's linked accounts, which may be party accounts or financial accounts." } }, "allOf":[ { "$ref":"#/components/schemas/Entity" } ] }, "PaymentMethod_Update":{ "type":"object", "description":"Specifies the common attributes that you can update for an implemented payment method. You cannot update the id and account attributes.", "properties":{ "authorizationCode":{ "example":"1234567890", "type":"string", "description":"Specifies the authorization code that a financial institution provides. For recurring payments that use this method, this field typically contains the code; individual payments have their own authorization codes." }, "description":{ "example":"My gold mastercard.", "type":"string", "description":"Specifies a textual description of the payment method's contents." }, "isPreferred":{ "example":"True", "type":"boolean", "description":"Specifies whether the owner prefers this payment method. Queries for a specific customer's or account's payment methods typically use this value." }, "name":{ "example":"Main credit card", "type":"string", "description":"Specifies the payment method's friendly name." }, "status":{ "example":"Active", "type":"string", "description":"Specifies the payment method's status." }, "statusDate":{ "example":"2020-07-17T10:12:26+0000", "type":"string", "format":"date-time", "description":"Specifies when the payment method's status last changed." }, "statusReason":{ "example":"This payment method has expired, therefore its status is now inactive.", "type":"string", "description":"Specifies the reason for the last status change." }, "href":{ "type":"string", "format":"uri", "description":"Specifies the hyperlink reference." }, "relatedParty":{ "$ref":"#/components/schemas/RelatedParty", "description":"Refers to the customer or party that owns or can use the payment method." }, "relatedPlace":{ "$ref":"#/components/schemas/RelatedPlace", "description":"Refers to the place for the billing or delivery address when it differs from the related party's address." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod", "description":"Specifies the payment method's validity period." }, "city":{ "type":"string", "description":"Specifies the city in the BRM address." }, "street":{ "type":"string", "description":"Specifies the BRM street address." }, "stateOrProvince":{ "type":"string", "description":"Specifies the state or province in the BRM address." }, "postCode":{ "type":"string", "description":"Specifies the postal code in the BRM address." }, "country":{ "type":"string", "description":"Specifies the country in the BRM address." }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ], "description":"Specifies the base resource type for an out-of-the-box payment method." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"Refers to a JSON Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "enum":[ "cash", "check", "bankAccountDebit", "bankCard", "tokenizedCard" ], "description":"Specifies the out-of-the-box payment method subtype." } } }, "TokenizedCard_Update":{ "description":"Specifies the partial update payload for a tokenized card payment method.", "required":[ "@type" ], "allOf":[ { "$ref":"#/components/schemas/PaymentMethod_Update" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "tokenizedCard" ] }, "brand":{ "type":"string" }, "cardType":{ "type":"string" }, "lastFourDigits":{ "type":"string" }, "tokenType":{ "type":"string" }, "token":{ "type":"string" }, "issuer":{ "type":"string" }, "expirationDate":{ "type":"string" }, "countryOfIssue":{ "type":"string" } } } ] }, "Check_Update":{ "description":"Specifies the partial update payload for a check payment method.", "required":[ "@type" ], "allOf":[ { "$ref":"#/components/schemas/PaymentMethod_Update" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "check" ] }, "checkId":{ "type":"string" }, "drawer":{ "type":"string" }, "payee":{ "type":"string" }, "signedDate":{ "type":"string", "format":"date-time" }, "bank":{ "type":"string" } } } ] }, "Cash_Update":{ "description":"Specifies the partial update payload for a cash payment method.", "required":[ "@type" ], "allOf":[ { "$ref":"#/components/schemas/PaymentMethod_Update" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "cash" ] }, "recieptNo":{ "type":"string" }, "effectiveDate":{ "type":"string", "format":"date-time" } } } ] }, "BankCard_Update":{ "description":"Specifies the partial update payload for a bank card payment method.", "required":[ "@type" ], "allOf":[ { "$ref":"#/components/schemas/PaymentMethod_Update" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "bankCard" ] }, "brand":{ "type":"string" }, "cardType":{ "type":"string" }, "cardNumber":{ "type":"string" }, "expirationDate":{ "type":"string" }, "cvv":{ "type":"string" }, "lastFourDigits":{ "type":"string" }, "nameOnCard":{ "type":"string" }, "bank":{ "type":"string" } } } ] }, "BankAccountDebit_Update":{ "description":"Specifies the partial update payload for a bank account debit payment method.", "required":[ "@type" ], "allOf":[ { "$ref":"#/components/schemas/PaymentMethod_Update" }, { "type":"object", "properties":{ "@type":{ "type":"string", "enum":[ "bankAccountDebit" ] }, "accountNumber":{ "type":"string" }, "accountNumberType":{ "type":"string" }, "BIC":{ "type":"string" }, "owner":{ "type":"string" }, "bank":{ "type":"string" } } } ] }, "RelatedPlace":{ "type":"object", "description":"Specifies a place and its associated role, such as an installation address or delivery address.", "properties":{ "id":{ "type":"string", "description":"Specifies the place's unique ID." }, "href":{ "type":"string", "description":"Specifies the unique reference to the place." }, "name":{ "type":"string", "description":"Specifies the place's friendly name, such as Paris Store, London Store, or Main Home." }, "role":{ "type":"string", "description":"Specifies the place's role, such as home delivery or shop retrieval." }, "@baseType":{ "type":"string", "description":"Specifies the superclass when subclassing." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"Refers to a JSON Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"Specifies the extensible subclass name when subclassing." }, "@referredType":{ "type":"string", "description":"Specifies the target instance's actual type when needed for disambiguation." } } }, "TokenizedCard":{ "description":"Specifies a tokenized card payment method.", "type":"object", "required":[ "brand", "lastFourDigits", "tokenType", "token", "expirationDate" ], "properties":{ "@type":{ "type":"string", "enum":[ "tokenizedCard" ] }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ] }, "brand":{ "type":"string", "description":"Specifies the card's brand for possible display purposes." }, "cardType":{ "type":"string", "description":"Specifies the card's type for possible display purposes." }, "lastFourDigits":{ "type":"string", "description":"Specifies the credit card's last four digits." }, "tokenType":{ "type":"string", "description":"Specifies the token's type, such as emv." }, "token":{ "type":"string", "description":"Specifies the token as a series of randomly generated numbers." }, "issuer":{ "type":"string", "description":"Specifies the entity that issued the token." }, "expirationDate":{ "type":"string", "description":"Specifies the tokenized card's expiration date.", "example":"0325" }, "countryOfIssue":{ "type":"string", "description":"Specifies the tokenized card's country of issue as an ISO 3166-1 alpha-2 country code, such as GB, NG, or FR." }, "city":{ "type":"string", "description":"Specifies the city in the BRM address." }, "street":{ "type":"string", "description":"Specifies the BRM street address." }, "stateOrProvince":{ "type":"string", "description":"Specifies the state or province in the BRM address." }, "postCode":{ "type":"string", "description":"Specifies the postal code in the BRM address." }, "country":{ "type":"string", "description":"Specifies the country in the BRM address." } }, "allOf":[ { "$ref":"#/components/schemas/PaymentMethod" } ] }, "Check":{ "description":"Specifies a check payment method.", "type":"object", "required":[ "checkId", "drawer", "payee", "signedDate", "bank" ], "properties":{ "@type":{ "type":"string", "enum":[ "check" ] }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ] }, "checkId":{ "type":"string", "description":"Specifies the check's unique ID." }, "drawer":{ "type":"string", "description":"Specifies the person or entity that writes the check." }, "payee":{ "type":"string", "description":"Specifies the check's payee." }, "signedDate":{ "type":"string", "description":"Specifies the check's signing date.", "format":"date-time" }, "bank":{ "type":"string", "description":"Specifies the bank that pays the check." } }, "allOf":[ { "$ref":"#/components/schemas/PaymentMethod" } ] }, "Cash":{ "description":"Specifies a cash payment method with no additional data. You can extend it to include information such as the cashier who accepted the payment or the person who paid.", "type":"object", "required":[ "recieptNo", "effectiveDate" ], "properties":{ "@type":{ "type":"string", "enum":[ "cash" ] }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ] }, "recieptNo":{ "type":"string", "description":"Specifies the BRM cash receipt number." }, "effectiveDate":{ "type":"string", "format":"date-time", "description":"Specifies the cash payment's effective date." } }, "allOf":[ { "$ref":"#/components/schemas/PaymentMethod" } ] }, "BankCard":{ "description":"Specifies a bank card payment method.", "type":"object", "required":[ "cardNumber", "brand", "expirationDate", "nameOnCard" ], "properties":{ "@type":{ "type":"string", "enum":[ "bankCard" ] }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ] }, "brand":{ "type":"string", "description":"Specifies the card's brand." }, "cardType":{ "type":"string", "description":"Specifies the card's type, such as credit or debit." }, "cardNumber":{ "type":"string", "description":"Specifies the bank card's number." }, "expirationDate":{ "type":"string", "description":"Specifies the bank card's expiration date.", "example":"0325" }, "cvv":{ "type":"string", "description":"Specifies the card's security code, such as CVV or CVV2." }, "lastFourDigits":{ "type":"string", "description":"Specifies the credit card's last four digits." }, "nameOnCard":{ "type":"string", "description":"Specifies the name on the card." }, "bank":{ "type":"string", "description":"Specifies the bank that issued the card." }, "city":{ "type":"string", "description":"Specifies the city in the BRM address." }, "street":{ "type":"string", "description":"Specifies the BRM street address." }, "stateOrProvince":{ "type":"string", "description":"Specifies the state or province in the BRM address." }, "postCode":{ "type":"string", "description":"Specifies the postal code in the BRM address." }, "country":{ "type":"string", "description":"Specifies the country in the BRM address." } }, "allOf":[ { "$ref":"#/components/schemas/PaymentMethod" } ] }, "BankAccountDebit":{ "description":"Specifies a bank account debit payment method. You can extend it to include any authorization fields that recurring payments require.", "type":"object", "required":[ "accountNumber", "accountNumberType", "bank" ], "properties":{ "@type":{ "type":"string", "enum":[ "bankAccountDebit" ] }, "@baseType":{ "type":"string", "enum":[ "PaymentMethod" ] }, "accountNumber":{ "type":"string", "description":"Specifies the bank account's number, which may refer to the IBAN or SWIFT number." }, "accountNumberType":{ "type":"string", "description":"Specifies the account number's type, such as IBAN or SWIFT." }, "BIC":{ "type":"string", "description":"Specifies the financial institution's Business Identifier Code or SWIFT code for the account." }, "owner":{ "type":"string", "description":"Specifies the bank account's owner, which also serves as the account name." }, "bank":{ "type":"string", "description":"Specifies the bank's display name." }, "city":{ "type":"string", "description":"Specifies the city in the BRM address." }, "street":{ "type":"string", "description":"Specifies the BRM street address." }, "stateOrProvince":{ "type":"string", "description":"Specifies the state or province in the BRM address." }, "postCode":{ "type":"string", "description":"Specifies the postal code in the BRM address." }, "country":{ "type":"string", "description":"Specifies the country in the BRM address." } }, "allOf":[ { "$ref":"#/components/schemas/PaymentMethod" } ] }, "Any":{ }, "AppliedBillingRateCharacteristic":{ "type":"object", "title":"Applied Billing Rate Characteristic", "description":"A characteristic of an applied billing rate, based on the service type, line of business, or other parameters.", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "title":"Characteristic Name", "description":"The characteristic's name." }, "valueType":{ "type":"string", "title":"Characteristic Type", "description":"The data type of the characteristic's value." }, "value":{ "description":"The characteristic's value.", "$ref":"#/components/schemas/Any" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Scheme Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "AppliedBillingTaxRate":{ "type":"object", "title":"Applied Billing Tax Rate", "description":"The tax rate applied to a billing rate.", "properties":{ "taxCategory":{ "type":"string", "title":"Tax Category", "description":"The applied billing tax's category." }, "taxRate":{ "type":"number", "title":"Tax Rate", "format":"float", "description":"The applied billing tax rate." }, "taxAmount":{ "description":"The applied billing tax amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "AppliedCustomerBillingRate":{ "type":"object", "title":"Applied Customer Billing Rate", "description":"An applied customer billing rate.", "required":[ "id", "href" ], "properties":{ "id":{ "type":"string", "title":"Applied Customer Billing Rate ID", "description":"The applied customer billing rate's ID." }, "href":{ "type":"string", "title":"Applied Customer Billing Rate Href", "description":"The applied customer billing rate's href." }, "date":{ "type":"string", "title":"Applied Customer Billing Rate Created Date", "format":"date-time", "description":"The date the applied customer billing rate was created." }, "description":{ "type":"string", "title":"Description", "description":"The applied customer billing rate's description." }, "isBilled":{ "type":"boolean", "title":"Billed", "description":"Whether the applied customer billing rate has been billed (true) or not (false). If true, also provide a value for the bill property. If false, also provide a value for the billingAccount property." }, "name":{ "type":"string", "title":"Applied Customer Billing Rate Name", "description":"The applied customer billing rate's name." }, "type":{ "type":"string", "title":"Applied Billing Rate Type", "description":"The applied customer billing rate's type. For example: appliedBillingCharge (for recurring, one time, and usage charges), appliedBillingCredit (for rebates or product alteration credits), or appliedPenaltyCharge (for penalty charges like late fees or payment rejection fees.)" }, "appliedTax":{ "type":"array", "description":"The taxes applied to the applied customer billing rate.", "items":{ "$ref":"#/components/schemas/AppliedBillingTaxRate" } }, "bill":{ "description":"The bill associated with the applied customer billing rate. Set this property if isBilled is set to true.", "$ref":"#/components/schemas/BillRef" }, "billingAccount":{ "description":"The billing account associated with the applied customer billing rate. Set this property if isBilled is set to false.", "$ref":"#/components/schemas/BillingAccountRef" }, "characteristic":{ "type":"array", "description":"The characteristics that define the applied customer billing rate.", "items":{ "$ref":"#/components/schemas/AppliedBillingRateCharacteristic" } }, "periodCoverage":{ "description":"The time period that the applied customer billing rate covers.", "$ref":"#/components/schemas/TimePeriod" }, "product":{ "description":"The product associated with the applied customer billing rate.", "$ref":"#/components/schemas/ProductRef" }, "taxExcludedAmount":{ "description":"The amount of the applied customer billing rate, excluding taxes.", "$ref":"#/components/schemas/Money" }, "taxIncludedAmount":{ "description":"The amount of the applied customer billing rate, including taxes.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "AppliedPayment":{ "type":"object", "title":"Applied Payment", "description":"A payment that can be assigned to a bill.", "properties":{ "appliedAmount":{ "description":"The amount of the payment that has been applied.", "$ref":"#/components/schemas/Money" }, "payment":{ "description":"The payment.", "$ref":"#/components/schemas/PaymentRef" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "CustomerBill":{ "type":"object", "title":"Customer Bill", "description":"A customer bill, also called an invoice.", "properties":{ "id":{ "type":"string", "title":"Bill ID", "description":"The bill ID, or the bill number." }, "href":{ "type":"string", "title":"Bill Href", "description":"The bill's href." }, "billDate":{ "type":"string", "title":"Bill Date", "format":"date-time", "description":"The date the bill was generated." }, "billNo":{ "type":"string", "title":"Bill Number", "description":"The bill's number." }, "category":{ "type":"string", "title":"Bill Category", "description":"The bill's category. For example: normal, duplicate, interim, or last." }, "lastUpdate":{ "type":"string", "title":"Bill Last Updated Date", "format":"date-time", "description":"The date that the bill was last updated." }, "nextBillDate":{ "type":"string", "title":"Next Bill Date", "format":"date-time", "description":"The date the next bill will be generated." }, "paymentDueDate":{ "type":"string", "title":"Payment Due Date", "format":"date-time", "description":"The bill's due date." }, "runType":{ "type":"string", "title":"Bill Run Type", "description":"The way the bill was generated, either onCycle (a regular billing cycle run) or offCycle (an on-demand request. For example: if requested by the customer or if the account closes.)" }, "amountDue":{ "description":"The amount due on the bill.", "$ref":"#/components/schemas/Money" }, "appliedPayment":{ "type":"array", "description":"The payments applied to the bill.", "items":{ "$ref":"#/components/schemas/AppliedPayment" } }, "billDocument":{ "type":"array", "description":"A document attached to the bill.", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue" } }, "billingAccount":{ "description":"The billing account related to the bill.", "$ref":"#/components/schemas/BillingAccountRef" }, "billingPeriod":{ "description":"The billing period for the bill.", "$ref":"#/components/schemas/TimePeriod" }, "financialAccount":{ "description":"The financial account related to the bill.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentMethod":{ "description":"The bill's payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "relatedParty":{ "type":"array", "description":"The parties related to the bill.", "items":{ "$ref":"#/components/schemas/RelatedPartyRef" } }, "remainingAmount":{ "description":"The remaining amount on the bill.", "$ref":"#/components/schemas/Money" }, "state":{ "description":"The bill's state.", "$ref":"#/components/schemas/stateValue" }, "taxExcludedAmount":{ "description":"The amount on the bill, excluding taxes.", "$ref":"#/components/schemas/Money" }, "taxIncludedAmount":{ "description":"The amount on the bill, including taxes.", "$ref":"#/components/schemas/Money" }, "taxItem":{ "type":"array", "description":"The taxes on the bill.", "items":{ "$ref":"#/components/schemas/TaxItem" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "required":[ "id", "href", "state", "billDate", "amountDue", "paymentDueDate" ] }, "CustomerBill_Update":{ "type":"object", "title":"Customer Bill Update", "description":"A customer bill, used in the bill update request when changing the bill's state.", "properties":{ "state":{ "description":"The bill's state.", "$ref":"#/components/schemas/stateValue" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "CustomerBillOnDemand":{ "type":"object", "title":"Customer Bill OnDemand", "description":"A customer bill created on demand.", "properties":{ "id":{ "type":"string", "title":"Bill ID", "description":"The on-demand bill's ID or bill number." }, "href":{ "type":"string", "title":"Bill Href", "description":"The on-demand bill's href." }, "description":{ "type":"string", "title":"Bill Description", "description":"The on-demand bill's description." }, "lastUpdate":{ "type":"string", "title":"Last Updated Date", "description":"The date that the on-demand bill was last updated." }, "name":{ "type":"string", "title":"Bill Name", "description":"The on-demand bill's name." }, "billingAccount":{ "description":"The billing account related to the on-demand bill.", "$ref":"#/components/schemas/BillingAccountRef" }, "customerBill":{ "description":"A reference to the related bill.", "$ref":"#/components/schemas/BillRef" }, "relatedParty":{ "description":"The party related to the on-demand bill.", "$ref":"#/components/schemas/RelatedPartyRef" }, "state":{ "description":"The on-demand bill's state.", "$ref":"#/components/schemas/StateValues" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "required":[ "id", "href", "state", "billingAccount" ] }, "CustomerBillOnDemand_Create":{ "type":"object", "title":"Customer Bill OnDemand Create", "description":"An on-demand customer bill, used in the create request. The id and href properties are not used in the create request.", "properties":{ "description":{ "type":"string", "title":"Bill Description", "description":"The on-demand bill's description." }, "lastUpdate":{ "type":"string", "title":"Last Updated Date", "description":"The date that the on-demand bill was last updated." }, "name":{ "type":"string", "title":"Bill Name", "description":"The on-demand bill's name." }, "billingAccount":{ "description":"The billing account related to the on-demand bill.", "$ref":"#/components/schemas/BillingAccountRef" }, "customerBill":{ "description":"A reference to the related bill.", "$ref":"#/components/schemas/BillRef" }, "relatedParty":{ "description":"The party related to the on-demand bill.", "$ref":"#/components/schemas/RelatedPartyRef" }, "state":{ "description":"The on-demand bill's state.", "$ref":"#/components/schemas/StateValues" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "required":[ "billingAccount" ] }, "FinancialAccountRef":{ "type":"object", "title":"Financial Account Ref", "description":"A financial account reference.", "properties":{ "id":{ "type":"string", "title":"Financial Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Financial Account Href", "description":"The account's href." }, "name":{ "type":"string", "title":"Financial Account Name", "description":"The account's name." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system. If baseType and type, need further disambiguation." } }, "required":[ "id" ] }, "Reference":{ "type":"object", "title":"Reference", "description":"The general referencing resource schema.", "properties":{ "id":{ "type":"string", "title":"Reference ID", "description":"The reference's ID." }, "href":{ "type":"string", "title":"Reference Href", "description":"The reference's href." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system. If baseType and type, need further disambiguation." } } }, "RelatedPartyRef":{ "type":"object", "title":"Related Party Ref", "description":"A reference to the party related to an object.", "properties":{ "id":{ "type":"string", "title":"Related Party ID", "description":"The related party's ID." }, "href":{ "type":"string", "title":"Related Party Href", "description":"The related party's href." }, "name":{ "type":"string", "title":"Related Party Name", "description":"The related party's name." }, "role":{ "type":"string", "title":"Related Party Role", "description":"The related party's role." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system. If baseType and type, need further disambiguation." } }, "required":[ "id" ] }, "StateValues":{ "type":"string", "title":"State Values", "description":"The possible values for an on-demand bill's state: inProgress, rejected, done, and terminatedWithError.", "enum":[ "inProgress", "rejected", "done", "terminatedWithError" ] }, "TaxItem":{ "type":"object", "title":"State Values", "description":"A tax item.", "properties":{ "taxCategory":{ "type":"string", "title":"Tax Category", "description":"The tax item's category." }, "taxRate":{ "type":"number", "title":"Tax Rate", "format":"float", "description":"The tax item's applied rate." }, "taxAmount":{ "description":"The tax item's amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"The URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "stateValue":{ "type":"string", "title":"State Value", "description":"The possible values for a bill's state: new, partiallyPaid, settled, onHold, and inProgress.", "enum":[ "new", "partiallyPaid", "settled", "onHold", "inProgress" ] }, "RatedProductUsage":{ "type":"object", "description":"An occurrence of employing a product for its intended purpose with all rating details.", "properties":{ "taxCode":{ "type":"string", "description":"The tax code." }, "taxExcludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxRate":{ "type":"number", "format":"float", "description":"The tax rate." } } }, "NonCurrencyDetail":{ "type":"object", "description":"Rated details for a non-currency resource.", "properties":{ "originalNetAmount":{ "type":"number", "format":"double", "description":"The original net amount." }, "priorAdjustment":{ "type":"number", "format":"double", "description":"The prior adjustment amount." }, "priorDisputes":{ "type":"number", "format":"double", "description":"The prior disputed amount." }, "resourceName":{ "type":"string", "description":"The resource name." } } }, "Usage":{ "type":"object", "description":"An occurrence of employing a Product, Service, or Resource for its intended purpose, which is of interest to the business and can have charges applied to it. It is comprised of characteristics, which represent attributes of usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." }, "href":{ "type":"string", "format":"uri", "description":"The hyperlink reference." }, "description":{ "example":"Voicemail Retrieval", "type":"string", "description":"The description of the usage." }, "appliedCustomerBillingRate":{ "type":"object", "description":"The applied customer billing rate associated with the usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." } } }, "bill":{ "type":"object", "description":"The bill associated with the usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." } } }, "billStructure":{ "type":"object", "description":"The bill structure associated with the usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." } } }, "billingAccount":{ "type":"object", "description":"The billing account associated with the usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." } } }, "bytesIn":{ "type":"integer", "description":"The number of incoming bytes." }, "bytesOut":{ "type":"integer", "description":"The number of outgoing bytes." }, "calledToNumber":{ "type":"string", "description":"The called telephone number." }, "cycleEnd":{ "type":"string", "format":"date-time", "description":"The end date and time of the cycle." }, "cycleStart":{ "type":"string", "format":"date-time", "description":"The start date and time of the cycle." }, "effectiveDate":{ "type":"string", "format":"date-time", "description":"The date and time when the usage became effective." }, "endTime":{ "type":"string", "format":"date-time", "description":"The end date and time of the usage." }, "nonCurrencyDetails":{ "type":"array", "description":"The rated details for non-currency resources.", "items":{ "$ref":"#/components/schemas/NonCurrencyDetail" } }, "quantity":{ "type":"number", "format":"double", "description":"The consumed quantity." }, "rumName":{ "type":"string", "description":"The rating unit of measure name." }, "service":{ "type":"object", "description":"The service associated with the usage.", "properties":{ "id":{ "type":"string", "description":"The unique identifier." } } }, "usageDate":{ "example":"2020-09-21T09:13:16-07:00", "type":"string", "format":"date-time", "description":"The date of the usage." }, "usageType":{ "type":"string", "description":"The type of usage." }, "ratedProductUsage":{ "type":"array", "items":{ "$ref":"#/components/schemas/RatedProductUsage" } }, "taxAmount":{ "$ref":"#/components/schemas/Money" }, "adjustedAmount":{ "$ref":"#/components/schemas/Money" }, "remainingAmount":{ "$ref":"#/components/schemas/Money" }, "discount":{ "$ref":"#/components/schemas/Money" }, "disputedAmount":{ "$ref":"#/components/schemas/Money" }, "settledDisputeAmount":{ "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "description":"When sub-classing, this defines the super-class." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"When sub-classing, this defines the sub-class Extensible name." } } }, "UsageStatusType":{ "type":"string", "description":"The possible values for the status of the Usage.", "enum":[ "received", "rejected", "recycled", "guided", "rated", "rerated", "billed" ] }, "Payment":{ "required":[ "id", "href", "paymentDate", "totalAmount", "account", "paymentMethod", "status" ], "type":"object", "title":"Payment", "properties":{ "id":{ "type":"string", "title":"Payment ID", "description":"The payment's ID." }, "href":{ "type":"string", "title":"Payment Href", "description":"The payment's href." }, "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"A payment correlation ID from a client application." }, "description":{ "type":"string", "title":"Payment Description", "description":"The payment's description." }, "name":{ "type":"string", "title":"Payment Name", "description":"The payment's name." }, "paymentDate":{ "type":"string", "title":"Payment Date", "description":"The date the payment was made.", "format":"date-time" }, "status":{ "type":"string", "title":"Payment Status", "description":"The payment's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date the payment's status was recorded.", "format":"date-time" }, "account":{ "description":"An account related to the payment.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The payment's monetary amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The payment's channel.", "$ref":"#/components/schemas/ChannelRef" }, "payer":{ "description":"The party that made the payment.", "$ref":"#/components/schemas/RelatedParty" }, "paymentItem":{ "type":"array", "description":"Payment items that can be assigned to bills.", "items":{ "$ref":"#/components/schemas/PaymentItem" } }, "paymentMethod":{ "description":"The payment method.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "taxAmount":{ "description":"The amount of tax on the payment.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount on the payment.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment, including information about the payment, the payment amount, and the payment method." }, "Payment_Create":{ "required":[ "account", "paymentMethod", "totalAmount" ], "type":"object", "title":"Payment Create", "properties":{ "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"A payment correlation ID from a client application." }, "description":{ "type":"string", "title":"Payment Description", "description":"The payment's description." }, "name":{ "type":"string", "title":"Payment Name", "description":"The payment's name." }, "account":{ "description":"An account-related to the payment.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The payment amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The payment channel.", "$ref":"#/components/schemas/ChannelRef" }, "payer":{ "description":"The party that made the payment.", "$ref":"#/components/schemas/RelatedParty" }, "paymentItem":{ "type":"array", "description":"Payment items that can be assigned to bills.", "items":{ "$ref":"#/components/schemas/PaymentItem" } }, "paymentMethod":{ "description":"The payment method.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "taxAmount":{ "description":"The amount of tax on the payment.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount of the payment.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment, used in payment create requests. The id, href, status, statusDate, and paymentDate properties aren't used in the create request." }, "PaymentItem":{ "required":[ "item" ], "type":"object", "title":"Payment Item", "properties":{ "id":{ "type":"string", "title":"Payment Item ID", "description":"The payment item's ID." }, "amount":{ "description":"The payment item amount.", "$ref":"#/components/schemas/Money" }, "item":{ "description":"A payment item entity.", "$ref":"#/components/schemas/EntityRef" }, "taxAmount":{ "description":"The amount of tax on the payment item.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount on the payment item.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A portion of a payment that can be assigned to a bill." }, "PaymentMethodRefOrValue":{ "type":"object", "title":"Payment Method Ref Or Value", "properties":{ "id":{ "type":"string", "title":"Payment Method ID", "description":"The payment method's ID or external ID." }, "href":{ "type":"string", "title":"Payment Method Href", "description":"The payment method's href." }, "description":{ "type":"string", "title":"Payment Method Description", "description":"The payment method's description." }, "isPreferred":{ "type":"boolean", "title":"Payment Method Preferred", "description":"Whether this is the preferred payment method (true) or not (false)." }, "name":{ "type":"string", "title":"Payment Method Name", "description":"The payment method's name." }, "status":{ "type":"string", "title":"Status", "description":"The payment method's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date the payment method's status was recorded.", "format":"date-time" }, "account":{ "type":"array", "description":"Accounts associated with the payment method.", "items":{ "$ref":"#/components/schemas/AccountRef" } }, "relatedParty":{ "description":"The party associated with the payment method.", "$ref":"#/components/schemas/RelatedParty" }, "validFor":{ "description":"The time period for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The payment method's type. Valid values are PaymentMethodRef for a credit or debit card, Cash, or Check. When the value is PaymentMethodRef, the payment method specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit is refunded instead. (For payments and refunds, @type is not used for subclassing.)" }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system if baseType and type need further disambiguation." } }, "description":"A link to the resource containing information about the payment method.", "required":[ "id", "@type" ] }, "PaymentStatusExampleType":{ "type":"string", "title":"Payment Status Example Type", "description":"Examples of possible values for a payment's status.", "enum":[ "pendingAuthorization", "authorized", "captured", "failed", "canceled", "denied", "done" ] }, "PaymentAllocationRequestRefOracle":{ "title":"Payment Allocation Request Ref Oracle", "description":"A payment allocation request.", "type":"object", "properties":{ "paymentId":{ "type":"string", "title":"Payment Id", "description":"The ID of a payment to be allocated to a bill." }, "bill":{ "type":"array", "description":"The bill to which the payment is allocated.", "items":{ "$ref":"#/components/schemas/BillWisePaymentAllocationReqOracle" } } }, "required":[ "bill", "paymentId" ] }, "BillWisePaymentAllocationReqOracle":{ "title":"BillWise Payment Allocation Req Oracle", "description":"Bill information for a payment allocation request.", "type":"object", "properties":{ "id":{ "title":"Bill Id", "type":"string", "description":"The bill ID or bill number to which the payment is allocated." }, "allocatedAmount":{ "description":"The amount of the payment to allocate to the bill.", "$ref":"#/components/schemas/Money" } }, "required":[ "id", "allocatedAmount" ] }, "Refund":{ "required":[ "account", "paymentMethod" ], "type":"object", "title":"Refund", "properties":{ "id":{ "type":"string", "title":"Refund ID", "description":"The refund's ID or item refund number." }, "href":{ "type":"string", "title":"Refund Href", "description":"The refund's href." }, "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"A refund correlation ID from a client application." }, "description":{ "type":"string", "title":"Refund Description", "description":"The refund's description." }, "name":{ "type":"string", "title":"Refund Name", "description":"The refund's name." }, "refundDate":{ "type":"string", "title":"Refund Date", "description":"The date when the refund was made.", "format":"date-time" }, "status":{ "type":"string", "title":"Refund Status", "description":"The refund's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date when the refund's status was recorded.", "format":"date-time" }, "account":{ "description":"The account associated with the refund.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The refund amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The refund channel.", "$ref":"#/components/schemas/ChannelRef" }, "payment":{ "description":"The payment to be refunded.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the refund.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "requestor":{ "description":"The party requesting the refund.", "$ref":"#/components/schemas/RelatedParty" }, "taxAmount":{ "description":"The refund tax amount.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total refund amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A refund for a payment." }, "RefundCreate":{ "required":[ "account", "paymentMethod", "totalAmount" ], "type":"object", "title":"Refund Create", "properties":{ "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"A refund correlation ID from a client application." }, "description":{ "type":"string", "title":"Refund Description", "description":"The refund's description." }, "name":{ "type":"string", "title":"Refund Name", "description":"The refund's name." }, "refundDate":{ "type":"string", "title":"Refund Date", "description":"The date when the refund was made.", "format":"date-time" }, "account":{ "description":"The account associated with the refund.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The refund amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The refund channel.", "$ref":"#/components/schemas/ChannelRef" }, "payment":{ "description":"The payment to be refunded.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the refund.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "requestor":{ "description":"The party requesting the refund.", "$ref":"#/components/schemas/RelatedParty" }, "taxAmount":{ "description":"The refund tax amount.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total refund amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A refund for a payment used in the create refund request.
The id, href, status, statusDate, and refundDate properties are not used in the create request." }, "RefundStatusExampleType":{ "type":"string", "title":"Refund Status Example Type", "description":"Examples of possible values for a refund's status.", "enum":[ "pendingAuthorization", "authorized", "captured", "failed", "canceled", "denied", "done" ] }, "PaymentCreateEvent":{ "type":"object", "title":"Payment Create Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentCreateEventPayload" } }, "description":"An event for creating a payment." }, "PaymentCreateEventPayload":{ "type":"object", "title":"Payment Create Event Payload", "properties":{ "payment":{ "description":"The payment to create.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentCreateEvent." }, "PaymentAttributeValueChangeEvent":{ "type":"object", "title":"Payment Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentAttributeValueChangeEventPayload" } }, "description":"An event for changing a payment's attribute." }, "PaymentAttributeValueChangeEventPayload":{ "type":"object", "title":"Payment Attribute Value Change Event Payload", "properties":{ "payment":{ "description":"The payment with a changed attribute.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentAttributeValueChangeEvent." }, "PaymentStateChangeEvent":{ "type":"object", "title":"Payment State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentStateChangeEventPayload" } }, "description":"An event for changing a payment's state." }, "PaymentStateChangeEventPayload":{ "type":"object", "title":"Payment State Change Event Payload", "properties":{ "payment":{ "description":"The payment with the changed state.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentStateChangeEvent." }, "PaymentDeleteEvent":{ "type":"object", "title":"Payment Delete Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentDeleteEventPayload" } }, "description":"An event for deleting a payment." }, "PaymentDeleteEventPayload":{ "type":"object", "title":"Payment Delete Event Payload", "properties":{ "payment":{ "description":"The payment to delete.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentDeleteEvent." }, "RefundCreateEvent":{ "type":"object", "title":"Refund Create Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundCreateEventPayload" } }, "description":"An event for creating a refund." }, "RefundCreateEventPayload":{ "type":"object", "title":"Refund Create Event Payload", "properties":{ "refund":{ "description":"The refund to create.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundCreateEvent." }, "RefundAttributeValueChangeEvent":{ "type":"object", "title":"Refund Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundAttributeValueChangeEventPayload" } }, "description":"An event for changing a refund's attribute." }, "RefundAttributeValueChangeEventPayload":{ "type":"object", "title":"Refund Attribute Change Event Payload", "properties":{ "refund":{ "description":"The refund with the changed attribute.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundAttributeValueChangeEvent." }, "RefundStateChangeEvent":{ "type":"object", "title":"Refund State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundStateChangeEventPayload" } }, "description":"An event for changing a refund's state." }, "RefundStateChangeEventPayload":{ "type":"object", "title":"Refund State Change Event Payload", "properties":{ "refund":{ "description":"The refund with the changed state.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundStateChangeEvent." }, "RefundDeleteEvent":{ "type":"object", "title":"Refund Delete Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundDeleteEventPayload" } }, "description":"An event for deleting a refund." }, "RefundDeleteEventPayload":{ "type":"object", "title":"Refund Delete Event Payload", "properties":{ "refund":{ "description":"The refund to delete.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundDeleteEvent." } }, "parameters":{ "Id":{ "name":"id", "required":true, "schema":{ "type":"string" }, "in":"path", "description":"The resource's ID." }, "Fields":{ "name":"fields", "in":"query", "description":"Specifies the comma-separated properties to include in the response.", "schema":{ "type":"string" } }, "Offset":{ "name":"offset", "in":"query", "description":"Specifies the index of the first resource to include in the response.", "schema":{ "type":"integer" } }, "Limit":{ "name":"limit", "in":"query", "description":"Specifies the number of resources to include in the response.", "schema":{ "type":"integer" } }, "Name":{ "name":"name", "in":"query", "description":"The resource's name.", "schema":{ "type":"string" } }, "BillingDateShift":{ "name":"billingDateShift", "in":"query", "description":"The number of days to shift the billing date, for example 4.", "schema":{ "type":"integer" } }, "PaymentDueDateOffset":{ "name":"paymentDueDateOffset", "in":"query", "description":"The number of days from the billing date until payment is due.", "schema":{ "type":"integer" } }, "Frequency":{ "name":"frequency", "in":"query", "description":"The billing frequency, for example monthly yearly.", "schema":{ "type":"string", "enum":[ "monthly", "bi-monthly", "quarterly", "semiYearly", "yearly" ] } }, "Description":{ "name":"description", "in":"query", "description":"The resource's description.", "schema":{ "type":"string" } }, "CreditLimit":{ "name":"creditLimit", "in":"query", "description":"The resource's credit limit.", "schema":{ "type":"number" } }, "AccountType":{ "name":"accountType", "in":"query", "description":"The resource's account type.", "schema":{ "type":"string" } }, "State":{ "name":"state", "in":"query", "description":"The resource's current state.", "schema":{ "type":"string" } }, "RatingType":{ "name":"ratingType", "in":"query", "description":"The resource's rating type.", "schema":{ "type":"string" } }, "PaymentStatus":{ "name":"paymentStatus", "in":"query", "description":"The resource account's payment status.", "schema":{ "type":"string" } }, "RelatedParty":{ "name":"relatedParty", "in":"query", "description":"The party or party role related to the account or resource.", "schema":{ "type":"object" } }, "PartyOrPartyRoleId":{ "name":"relatedParty.partyOrPartyRole.id", "in":"query", "description":"The related party or party role ID.", "schema":{ "type":"string" } }, "PartyOrPartyRoleName":{ "name":"relatedParty.partyOrPartyRole.name", "in":"query", "description":"The related party or party role name.", "schema":{ "type":"string" } }, "PartyOrPartyRolePartyId":{ "name":"relatedParty.partyOrPartyRole.partyId", "in":"query", "description":"The reference party ID code for the related party or party role.", "schema":{ "type":"string" } }, "PartyOrPartyRolePartyName":{ "name":"relatedParty.partyOrPartyRole.partyName", "in":"query", "description":"The reference party name for the related party or party role.", "schema":{ "type":"string" } }, "ContactName":{ "name":"contact.contactName", "in":"query", "description":"The account contact's name.", "schema":{ "type":"string" } }, "ContactType":{ "name":"contact.contactType", "in":"query", "description":"The account contact type, for example primary secondary.", "schema":{ "type":"string", "enum":[ "primary", "secondary" ] } }, "ContactMediumStreet1":{ "name":"contact.contactMedium.street1", "in":"query", "description":"The first line of the contact's street address.", "schema":{ "type":"string" } }, "ContactMediumCity":{ "name":"contact.contactMedium.city", "in":"query", "description":"The contact's city.", "schema":{ "type":"string" } }, "ContactMediumStateOrProvince":{ "name":"contact.contactMedium.stateOrProvince", "in":"query", "description":"The state or province of the contact's address.", "schema":{ "type":"string" } }, "ContactMediumPostCode":{ "name":"contact.contactMedium.postCode", "in":"query", "description":"The postal or ZIP code of the contact's address.", "schema":{ "type":"string" } }, "ContactMediumCountry":{ "name":"contact.contactMedium.country", "in":"query", "description":"The contact's country.", "schema":{ "type":"string" } }, "ContactMediumEmailAddress":{ "name":"contact.contactMedium.emailAddress", "in":"query", "description":"The contact's email address.", "schema":{ "type":"string" } }, "ContactMediumPhoneNumber":{ "name":"contact.contactMedium.phoneNumber", "in":"query", "description":"The contact's phone number.", "schema":{ "type":"string" } }, "ContactMediumMediumType":{ "name":"contact.contactMedium.mediumType", "in":"query", "description":"The contact medium type, for example phone email postalAddress.", "schema":{ "type":"string" } }, "ContactMediumPhoneType":{ "name":"contact.contactMedium.phoneType", "in":"query", "description":"The phone contact type, for example home work fax pager portable pop support.", "schema":{ "type":"string", "enum":[ "home", "work", "fax", "pager", "portable", "pop", "support" ] } }, "AccountNum":{ "name":"accountNum", "in":"query", "description":"The unique account number.", "schema":{ "type":"string" } }, "Attribute":{ "name":"attribute", "in":"query", "description":"The resource's custom attribute value.", "schema":{ "type":"string" } }, "CustomerSegmentList":{ "name":"customerSegmentList", "in":"query", "description":"The customer segments associated with this account or resource.", "schema":{ "type":"string" } }, "VatCertificate":{ "name":"vatCertificate", "in":"query", "description":"The resource's or account's VAT certificate.", "schema":{ "type":"string" } }, "BillStructure":{ "name":"billStructure", "in":"query", "description":"The resource's bill structure.", "schema":{ "type":"string" } }, "BillStructureId":{ "name":"billStructure.id", "in":"query", "description":"The bill structure's ID.", "schema":{ "type":"string" } }, "BillStructureName":{ "name":"billStructure.name", "in":"query", "description":"The bill structure's name.", "schema":{ "type":"string" } }, "BillStructurePresentationMediaName":{ "name":"billStructure.presentationMedia.name", "in":"query", "description":"The bill structure's presentation media name.", "schema":{ "type":"string" } }, "BillStructureFormatId":{ "name":"billStructure.format.id", "in":"query", "description":"The bill structure's format ID.", "schema":{ "type":"string" } }, "BillStructureFormatName":{ "name":"billStructure.format.name", "in":"query", "description":"The bill structure's format name.", "schema":{ "type":"string" } }, "BillStructureCycleSpecificationId":{ "name":"billStructure.cycleSpecification.id", "in":"query", "description":"The bill structure's cycle specification ID.", "schema":{ "type":"string" } }, "BillStructureCycleSpecificationName":{ "name":"billStructure.cycleSpecification.name", "in":"query", "description":"The bill structure's cycle specification name.", "schema":{ "type":"string" } }, "TaxExemptionCertificate":{ "name":"taxExemptionCertificate", "in":"query", "description":"The assigned tax exemption certificate.", "schema":{ "type":"string" } }, "TaxExemptionCertificateId":{ "name":"taxExemptionCertificate.id", "in":"query", "description":"The tax exemption certificate's ID.", "schema":{ "type":"string" } }, "TaxExemptionCertificateNumber":{ "name":"taxExemption.certificateNumber", "in":"query", "description":"The tax exemption certificate number.", "schema":{ "type":"string" } }, "TaxExemptionIssuingJurisdiction":{ "name":"taxExemption.issuingJurisdiction", "in":"query", "description":"The tax exemption issuing jurisdiction.", "schema":{ "type":"string" } }, "TaxExemptionValidForStartDateTime":{ "name":"taxExemption.validFor.startDateTime", "in":"query", "description":"The tax exemption validity start date and time.", "schema":{ "type":"string", "format":"date-time" } }, "TaxExemptionValidForEndDateTime":{ "name":"taxExemption.validFor.endDateTime", "in":"query", "description":"The tax exemption validity end date and time.", "schema":{ "type":"string", "format":"date-time" } }, "TaxExemptionReason":{ "name":"taxExemption.reason", "in":"query", "description":"The reason for the tax exemption.", "schema":{ "type":"string" } }, "TaxExemptionId":{ "name":"taxExemption.id", "in":"query", "description":"The tax exemption's ID.", "schema":{ "type":"string" } }, "AccountBalance":{ "name":"accountBalance", "in":"query", "description":"The account balance information.", "schema":{ "type":"string" } }, "AccountBalanceId":{ "name":"accountBalance.id", "in":"query", "description":"The account balance record's ID.", "schema":{ "type":"string" } }, "BrmAccountType":{ "name":"brmAccountType", "in":"query", "description":"The BRM account type.", "schema":{ "type":"string" } }, "GlSegment":{ "name":"glSegment", "in":"query", "description":"The general ledger segment information.", "schema":{ "type":"string" } }, "Currency":{ "name":"currency", "in":"query", "description":"The account's primary currency.", "schema":{ "type":"string" } }, "CurrencySecondary":{ "name":"currencySecondary", "in":"query", "description":"The account's secondary currency.", "schema":{ "type":"string" } }, "Locale":{ "name":"locale", "in":"query", "description":"The resource or account locale setting.", "schema":{ "type":"string" } }, "ServiceBillStructure":{ "name":"serviceBillStructure", "in":"query", "description":"The resource's service bill structure.", "schema":{ "type":"string" } }, "ServiceBillStructureId":{ "name":"serviceBillStructure.id", "in":"query", "description":"The service bill structure's ID.", "schema":{ "type":"string" } }, "ServiceBillStructureName":{ "name":"serviceBillStructure.name", "in":"query", "description":"The service bill structure's name.", "schema":{ "type":"string" } }, "ServiceBillStructurePresentationMediaName":{ "name":"serviceBillStructure.presentationMedia.name", "in":"query", "description":"The service bill structure's presentation media name.", "schema":{ "type":"string" } }, "ServiceBillStructureFormatId":{ "name":"serviceBillStructure.format.id", "in":"query", "description":"The service bill structure's format ID.", "schema":{ "type":"string" } }, "ServiceBillStructureFormatName":{ "name":"serviceBillStructure.format.name", "in":"query", "description":"The service bill structure's format name.", "schema":{ "type":"string" } }, "ServiceBillStructureCycleSpecificationId":{ "name":"serviceBillStructure.cycleSpecification.id", "in":"query", "description":"The service bill structure's cycle specification ID.", "schema":{ "type":"string" } }, "ServiceBillStructureCycleSpecificationName":{ "name":"serviceBillStructure.cycleSpecification.name", "in":"query", "description":"The service bill structure's cycle specification name.", "schema":{ "type":"string" } }, "ContactContactType":{ "name":"contact.contactType", "in":"query", "description":"The account contact type.", "schema":{ "type":"string" } }, "ContactContactName":{ "name":"contact.contactName", "in":"query", "description":"The account contact's name.", "schema":{ "type":"string" } }, "RelatedPartyRole":{ "name":"relatedParty.role", "in":"query", "description":"The related party role associated with the account.", "schema":{ "type":"string" } }, "Sort":{ "name":"sort", "in":"query", "description":"Specifies the response sort order, for example ascending descending.", "schema":{ "type":"string" } }, "Filter":{ "name":"filter", "in":"query", "description":"Specifies an advanced filter expression for nested fields, for example JSONPath.", "schema":{ "type":"string" }, "examples":{ "filterByPrimaryContact":{ "summary":"Filter by primary contact", "value":"$[?@.contact[?@.contactType==primary]]" }, "filterByPostCode":{ "summary":"Filter by post code", "value":"$[?@.contact[?@.contactMedium[?@.postCode==75014]]]" }, "filterByPhoneNumber":{ "summary":"Filter by phone number", "value":"$[?@.contact[?@.contactMedium[?@.phoneNumber==28412]]]" }, "filterByEmail":{ "summary":"Filter by email address", "value":"$[?@.contact[?@.contactMedium[?@.emailAddress==test@oracle.com]]]" }, "filterByStateOrProvince":{ "summary":"Filter by state or province", "value":"$[?@.contact[?@.contactMedium[?@.stateOrProvince==IN]]]" }, "filterByCountry":{ "summary":"Filter by country", "value":"$[?@.contact[?@.contactMedium[?@.country==France]]]" }, "filterByCity":{ "summary":"Filter by city", "value":"$[?@.contact[?@.contactMedium[?@.city==France]]]" }, "filterByStreet":{ "summary":"Filter by street", "value":"$[?@.contact[?@.contactMedium[?@.street1==Rue%20des%20Canards%20test2%20blr]]]" }, "filterByCertificateNumber":{ "summary":"Filter by certificate number", "value":"$[?@.taxExemption[?@.certificateNumber==1234]]" }, "filterByIssuingJurisdiction":{ "summary":"Filter by issuing jurisdiction", "value":"$[?@.taxExemption[?@.issuingJurisdiction==USA]]" }, "filterByValidForStart":{ "summary":"Filter by validFor start date and time", "value":"$[?@.taxExemption[?@.validFor.startDateTime==2024-07-31T11:30:00.00Z]]" }, "filterByValidForEnd":{ "summary":"Filter by validFor end date and time", "value":"$[?@.taxExemption[?@.validFor.endDateTime==2027-08-06T11:30:00.00Z]]" }, "filterByReason":{ "summary":"Filter by reason", "value":"$[?@.taxExemption[?@.reason==NGO]]" }, "filterByTaxId":{ "summary":"Filter by tax exemption ID", "value":"$[?@.taxExemption[?@.id==EXEM01]]" }, "filterByParentAccountRelationship":{ "summary":"Filter by parent account relationship", "value":"$[?@.accountRelationship[?@.relationshipType==Parent%26%26@.account[?@.billStructure.id==parent_billunit_id]]]" }, "filterByRelatedPartyRole":{ "summary":"Filter by related party role", "value":"$[?@.relatedParty[?@.role==service%20provider]]" }, "filterBySecondaryContactName":{ "summary":"Filter by secondary contact name", "value":"$[?@.contact[?@.contactType==secondary%26%26@.contactName==Rachel%20Douglas]]" }, "filterByCertificateNumberAndReason":{ "summary":"Filter by certificate number and reason", "value":"$[?@.taxExemption[?@.certificateNumber==1234%26%26@.reason==NGO]]" } } }, "StartDate":{ "name":"startDate", "in":"query", "description":"The resource start date. The expected ISO-8601 format: 2025-01-02T01:30:00Z.\n", "schema":{ "type":"string", "format":"date-time", "example":"2018-01-02T01:30:00Z" } }, "TerminationDate":{ "name":"terminationDate", "in":"query", "description":"The resource termination date. The expected ISO-8601 format: 2025-01-02T01:30:00Z.\n", "schema":{ "type":"string", "format":"date-time", "example":"2025-01-02T01:30:00Z" } }, "CycleStartDate":{ "name":"cycleStartDate", "in":"query", "description":"The purchased product cycle start date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "CycleEndDate":{ "name":"cycleEndDate", "in":"query", "description":"The purchased product cycle end date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "PurchaseStartDate":{ "name":"purchaseStartDate", "in":"query", "description":"The purchased product purchase start date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "PurchaseEndDate":{ "name":"purchaseEndDate", "in":"query", "description":"The purchased product purchase end date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "UsageStartDate":{ "name":"usageStartDate", "in":"query", "description":"The purchased product usage start date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "UsageEndDate":{ "name":"usageEndDate", "in":"query", "description":"The purchased product usage end date in ISO-8601 date-time format.", "schema":{ "type":"string", "format":"date-time" } }, "IsBundle":{ "name":"isBundle", "in":"query", "description":"Wether the resource is a bundle.", "schema":{ "type":"boolean" } }, "Status":{ "name":"status", "in":"query", "description":"The resource's status.", "schema":{ "type":"string" } }, "ProductOfferingId":{ "name":"productOffering.id", "in":"query", "description":"The identifier of the associated product offering.", "schema":{ "type":"string" } }, "ProductOfferingName":{ "name":"productOffering.name", "in":"query", "description":"The name of the associated product offering.", "schema":{ "type":"string" } }, "Quantity":{ "name":"quantity", "in":"query", "description":"The service quantity when creating a purchase product.", "schema":{ "type":"integer" } }, "SpecialRatingProfileId":{ "name":"specialRatingProfile.id", "in":"query", "description":"The identifier of the special rating profile. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string" }, "example":"88-1ZVHQ4-044" }, "SpecialRatingProfileName":{ "name":"specialRatingProfile.name", "in":"query", "description":"The special rating profile name. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string" }, "example":"FRIENDS_FAMILY" }, "SpecialRatingProfileLabel":{ "name":"specialRatingProfile.label", "in":"query", "description":"The special rating profile label. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string" }, "example":"Smart Calling up to 5 Numbers" }, "SpecialRatingProfileStatus":{ "name":"specialRatingProfile.status", "in":"query", "description":"The special rating profile provisioning status. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string", "enum":[ "noop", "provisioning", "provisioningFailed", "active", "unprovisioning", "unprovisioningFailed", "unprovisioned", "suspending", "suspendingFailed", "suspended" ] }, "example":"active" }, "SpecialRatingProfileReferenceCount":{ "name":"specialRatingProfile.referenceCount", "in":"query", "description":"The special rating profile reference count. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"integer" }, "example":1 }, "SpecialRatingProfileDataName":{ "name":"specialRatingProfile.data.name", "in":"query", "description":"The special rating profile data attribute name. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string" }, "example":"dummy" }, "SpecialRatingProfileDataValue":{ "name":"specialRatingProfile.data.value", "in":"query", "description":"The special rating profile data attribute value. Append a supported operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string" }, "example":"0449335686849545" }, "SpecialRatingProfileDataStartDateTime":{ "name":"specialRatingProfile.data.validFor.startDateTime", "in":"query", "description":"The start of the special rating profile data validity period. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-02T18:23:39.00Z" }, "SpecialRatingProfileDataEndDateTime":{ "name":"specialRatingProfile.data.validFor.endDateTime", "in":"query", "description":"The end of the special rating profile data validity period. Append a supported comparison operator suffix to the parameter name when required; an unsuffixed parameter uses equality.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-05-01T00:00:00.00Z" }, "SpecialRatingProfileIdEq":{ "name":"specialRatingProfile.id.eq", "in":"query", "description":"Filters products whose special rating profile identifier equals the specified value.", "schema":{ "type":"string" }, "example":"88-1ZVHQ4-044" }, "SpecialRatingProfileIdLike":{ "name":"specialRatingProfile.id.like", "in":"query", "description":"Filters products whose special rating profile identifier matches the specified wildcard pattern.", "schema":{ "type":"string" }, "example":"88-1ZVHQ4-%" }, "SpecialRatingProfileNameEq":{ "name":"specialRatingProfile.name.eq", "in":"query", "description":"Filters products whose special rating profile name equals the specified value.", "schema":{ "type":"string" }, "example":"FRIENDS_FAMILY" }, "SpecialRatingProfileNameLike":{ "name":"specialRatingProfile.name.like", "in":"query", "description":"Filters products whose special rating profile name matches the specified wildcard pattern.", "schema":{ "type":"string" }, "example":"FRIENDS%" }, "SpecialRatingProfileLabelEq":{ "name":"specialRatingProfile.label.eq", "in":"query", "description":"Filters products whose special rating profile label equals the specified value.", "schema":{ "type":"string" }, "example":"Smart Calling up to 5 Numbers" }, "SpecialRatingProfileLabelLike":{ "name":"specialRatingProfile.label.like", "in":"query", "description":"Filters products whose special rating profile label matches the specified wildcard pattern.", "schema":{ "type":"string" }, "example":"Smart%" }, "SpecialRatingProfileStatusEq":{ "name":"specialRatingProfile.status.eq", "in":"query", "description":"Filters products whose special rating profile status equals the specified value.", "schema":{ "type":"string" }, "example":"active" }, "SpecialRatingProfileStatusLt":{ "name":"specialRatingProfile.status.lt", "in":"query", "description":"Filters products whose special rating profile status precedes the specified status in mapper enum order.", "schema":{ "type":"string" }, "example":"active" }, "SpecialRatingProfileStatusLte":{ "name":"specialRatingProfile.status.lte", "in":"query", "description":"Filters products whose special rating profile status precedes or equals the specified status in mapper enum order.", "schema":{ "type":"string" }, "example":"active" }, "SpecialRatingProfileStatusGt":{ "name":"specialRatingProfile.status.gt", "in":"query", "description":"Filters products whose special rating profile status follows the specified status in mapper enum order.", "schema":{ "type":"string" }, "example":"active" }, "SpecialRatingProfileStatusGte":{ "name":"specialRatingProfile.status.gte", "in":"query", "description":"Filters products whose special rating profile status follows or equals the specified status in mapper enum order.", "schema":{ "type":"string" }, "example":"active" }, "SpecialRatingProfileReferenceCountEq":{ "name":"specialRatingProfile.referenceCount.eq", "in":"query", "description":"Filters products whose special rating profile reference count equals the specified value.", "schema":{ "type":"integer" }, "example":1 }, "SpecialRatingProfileReferenceCountLt":{ "name":"specialRatingProfile.referenceCount.lt", "in":"query", "description":"Filters products whose special rating profile reference count is less than the specified value.", "schema":{ "type":"integer" }, "example":2 }, "SpecialRatingProfileReferenceCountLte":{ "name":"specialRatingProfile.referenceCount.lte", "in":"query", "description":"Filters products whose special rating profile reference count is less than or equal to the specified value.", "schema":{ "type":"integer" }, "example":1 }, "SpecialRatingProfileReferenceCountGt":{ "name":"specialRatingProfile.referenceCount.gt", "in":"query", "description":"Filters products whose special rating profile reference count is greater than the specified value.", "schema":{ "type":"integer" }, "example":0 }, "SpecialRatingProfileReferenceCountGte":{ "name":"specialRatingProfile.referenceCount.gte", "in":"query", "description":"Filters products whose special rating profile reference count is greater than or equal to the specified value.", "schema":{ "type":"integer" }, "example":1 }, "SpecialRatingProfileDataNameEq":{ "name":"specialRatingProfile.data.name.eq", "in":"query", "description":"Filters products whose special rating profile data name equals the specified value.", "schema":{ "type":"string" }, "example":"dummy" }, "SpecialRatingProfileDataNameLike":{ "name":"specialRatingProfile.data.name.like", "in":"query", "description":"Filters products whose special rating profile data name matches the specified wildcard pattern.", "schema":{ "type":"string" }, "example":"dum%" }, "SpecialRatingProfileDataValueEq":{ "name":"specialRatingProfile.data.value.eq", "in":"query", "description":"Filters products whose special rating profile data value equals the specified value.", "schema":{ "type":"string" }, "example":"0449335686849545" }, "SpecialRatingProfileDataValueLike":{ "name":"specialRatingProfile.data.value.like", "in":"query", "description":"Filters products whose special rating profile data value matches the specified wildcard pattern.", "schema":{ "type":"string" }, "example":"044%" }, "SpecialRatingProfileDataStartDateTimeEq":{ "name":"specialRatingProfile.data.validFor.startDateTime.eq", "in":"query", "description":"Filters products whose special rating profile data start time equals the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-02T18:23:39.00Z" }, "SpecialRatingProfileDataStartDateTimeLt":{ "name":"specialRatingProfile.data.validFor.startDateTime.lt", "in":"query", "description":"Filters products whose special rating profile data start time is before the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-03T00:00:00.00Z" }, "SpecialRatingProfileDataStartDateTimeLte":{ "name":"specialRatingProfile.data.validFor.startDateTime.lte", "in":"query", "description":"Filters products whose special rating profile data start time is before or equal to the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-02T18:23:39.00Z" }, "SpecialRatingProfileDataStartDateTimeGt":{ "name":"specialRatingProfile.data.validFor.startDateTime.gt", "in":"query", "description":"Filters products whose special rating profile data start time is after the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-01T00:00:00.00Z" }, "SpecialRatingProfileDataStartDateTimeGte":{ "name":"specialRatingProfile.data.validFor.startDateTime.gte", "in":"query", "description":"Filters products whose special rating profile data start time is after or equal to the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-02T18:23:39.00Z" }, "SpecialRatingProfileDataEndDateTimeEq":{ "name":"specialRatingProfile.data.validFor.endDateTime.eq", "in":"query", "description":"Filters products whose special rating profile data end time equals the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-05-01T00:00:00.00Z" }, "SpecialRatingProfileDataEndDateTimeLt":{ "name":"specialRatingProfile.data.validFor.endDateTime.lt", "in":"query", "description":"Filters products whose special rating profile data end time is before the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-05-02T00:00:00.00Z" }, "SpecialRatingProfileDataEndDateTimeLte":{ "name":"specialRatingProfile.data.validFor.endDateTime.lte", "in":"query", "description":"Filters products whose special rating profile data end time is before or equal to the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-05-01T00:00:00.00Z" }, "SpecialRatingProfileDataEndDateTimeGt":{ "name":"specialRatingProfile.data.validFor.endDateTime.gt", "in":"query", "description":"Filters products whose special rating profile data end time is after the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-04-30T00:00:00.00Z" }, "SpecialRatingProfileDataEndDateTimeGte":{ "name":"specialRatingProfile.data.validFor.endDateTime.gte", "in":"query", "description":"Filters products whose special rating profile data end time is after or equal to the specified date-time.", "schema":{ "type":"string", "format":"date-time" }, "example":"2031-05-01T00:00:00.00Z" }, "RealizingServiceId":{ "name":"realizingService.id", "in":"query", "description":"The ID of the associated realizing service.", "schema":{ "type":"string" } }, "BillingAccountId":{ "name":"billingAccount.id", "in":"query", "description":"The ID of the associated billing account.", "schema":{ "type":"string" } }, "ProductCharacteristicId":{ "name":"productCharacteristic.id", "in":"query", "description":"The ID of the associated product characteristic.", "schema":{ "type":"string" } } }, "requestBodies":{ "PartyAccount_FVO":{ "description":"The PartyAccount to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount_FVO" }, "examples":{ "PartyAccount_create_example":{ "$ref":"#/components/examples/PartyAccount_create_example_request" } } } }, "required":true }, "PartyAccount_MVO":{ "description":"The PartyAccount to update.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount_MVO" }, "examples":{ "PartyAccount_update_example_Implied_Merge":{ "$ref":"#/components/examples/PartyAccount_update_example_Implied_Merge_request" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount_MVO" }, "examples":{ "PartyAccount_update_example_Patch_Merge":{ "$ref":"#/components/examples/PartyAccount_update_example_Patch_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PartyAccount_update_example_JSON_Patch":{ "$ref":"#/components/examples/PartyAccount_update_example_JSON_Patch_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PartyAccount_update_example_JSON_Patch_Query":{ "$ref":"#/components/examples/PartyAccount_update_example_JSON_Patch_Query_request" } } } }, "required":true }, "PartyAccountCreateEvent":{ "description":"The PartyAccount create event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccountCreateEvent" }, "examples":{ "CreatePartyAccountEvent":{ "$ref":"#/components/examples/CreatePartyAccountEvent_request" } } } }, "required":true }, "PartyAccountAttributeValueChangeEvent":{ "description":"The PartyAccount attribute-value-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccountAttributeValueChangeEvent" }, "examples":{ "PartyAccountAttributeValueChangeEvent":{ "$ref":"#/components/examples/PartyAccountAttributeValueChangeEvent_request" } } } }, "required":true }, "PartyAccountStateChangeEvent":{ "description":"The PartyAccount state-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccountStateChangeEvent" }, "examples":{ "PartyAccountStateChangeEvent":{ "$ref":"#/components/examples/PartyAccountStateChangeEvent_request" } } } }, "required":true }, "PartyAccountDeleteEvent":{ "description":"The PartyAccount delete event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccountDeleteEvent" }, "examples":{ "PartyAccountDeleteEvent":{ "$ref":"#/components/examples/PartyAccountDeleteEvent_request" } } } }, "required":true }, "BillingAccount_FVO":{ "description":"The BillingAccount to create.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount_FVO" }, { "$ref":"#/components/schemas/BillingAccountOracle_FVO" } ] }, "examples":{ "BillingAccount_Create_example":{ "$ref":"#/components/examples/BillingAccount_Create_example_request" }, "BillingAccount_Create_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_Oracle_example_request" }, "BillingAccount_Create_WithoutBillStructure_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withoutBillStructure_Oracle_example_request" }, "BillingAccount_Create_WithTaxExemption_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withTaxExemptions_Oracle_example_request" }, "BillingAccount_Create_WithAccountRelationship_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withAccountRelationship_Oracle_example_request" }, "BillingAccount_Create_WithVatCert_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withVatCert_Oracle_example_request" }, "BillingAccount_Create_WithCreditLimit_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withCreditLimit_Oracle_example_request" } } } }, "required":true }, "BillingAccount_MVO":{ "description":"The BillingAccount to update.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount_MVO" }, { "$ref":"#/components/schemas/BillingAccountOracle_MVO" } ] }, "examples":{ "BillingAccount_Update_example_Implied_Merge":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_Merge_request" }, "BillingAccount_Update_state_closed_example_Implied_Merge":{ "$ref":"#/components/examples/PatchStateForDeletingAccount" }, "BillingAccount_Update_account_type_example_Implied_Merge":{ "$ref":"#/components/examples/PatchAccountType" }, "BillingAccount_Update_extended_fields_example_Implied_Merge":{ "$ref":"#/components/examples/PatchAdditionalFields" }, "BillingAccount_Update_BillStructure_example_Implied_Merge":{ "$ref":"#/components/examples/PatchBillStructure" }, "BillingAccount_Update_contact_extended_fields_example_Implied_Merge":{ "$ref":"#/components/examples/PatchContactNameAndContactMedium" }, "BillingAccount_Update_vatCert_fields_example_Implied_Merge":{ "$ref":"#/components/examples/PatchVatCert" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillingAccount_MVO" }, "examples":{ "BillingAccount_Update_example_Patch_Merge":{ "$ref":"#/components/examples/BillingAccount_Update_example_Patch_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "BillingAccount_Update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "BillingAccount_Update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_request" }, "BillingAccount_Update_example_JSON_AddNewBillStructure_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_jsonPatch_addNewBillStructure_request" }, "BillingAccount_Update_example_JSON_AddNewAccountRelationship_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchAddAccountRelationshipParent_request" }, "BillingAccount_Update_example_JSON_ReplacePresentationMedia_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchReplacePresentationMedia_request" }, "BillingAccount_Update_example_JSON_RemoveTaxExemption_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchRemoveTaxExemption_request" } } } }, "required":true }, "BillingAccountCreateEvent":{ "description":"The BillingAccount create event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingAccountCreateEvent" }, "examples":{ "BillingAccountCreateEvent":{ "$ref":"#/components/examples/BillingAccountCreateEvent_request" } } } }, "required":true }, "BillingAccountAttributeValueChangeEvent":{ "description":"The BillingAccount attribute-value-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingAccountAttributeValueChangeEvent" }, "examples":{ "BillingAccountAttributeValueChangeEvent":{ "$ref":"#/components/examples/BillingAccountAttributeValueChangeEvent_request" } } } }, "required":true }, "BillingAccountStateChangeEvent":{ "description":"The BillingAccount state-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingAccountStateChangeEvent" }, "examples":{ "BillingAccountStateChangeEvent":{ "$ref":"#/components/examples/BillingAccountStateChangeEvent_request" } } } }, "required":true }, "BillingAccountDeleteEvent":{ "description":"The BillingAccount delete event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingAccountDeleteEvent" }, "examples":{ "BillingAccountDeleteEvent":{ "$ref":"#/components/examples/BillingAccountDeleteEvent_request" } } } }, "required":true }, "BillFormat_FVO":{ "description":"The BillFormat to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormat_FVO" }, "examples":{ "CreateBillFormat_example":{ "$ref":"#/components/examples/CreateBillFormat_example_request" }, "BillFormat_create_example":{ "$ref":"#/components/examples/BillFormat_create_example_request" } } } }, "required":true }, "BillFormat_MVO":{ "description":"The BillFormat to update.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormat_MVO" } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillFormat_MVO" }, "examples":{ "BillFormat_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillFormat_update_example_Patch_Merge_request" }, "BillFormat_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillFormat_update_example_Implied_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PatchBillFormat_update_example_JSON":{ "$ref":"#/components/examples/PatchBillFormat_update_example_JSON_request" }, "BillFormat_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillFormat_update_example_JSON_Patch_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" } } }, "required":true }, "BillFormatCreateEvent":{ "description":"The BillFormat create event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormatCreateEvent" }, "examples":{ "CreateBillFormatEvent":{ "$ref":"#/components/examples/CreateBillFormatEvent_request" } } } }, "required":true }, "BillFormatAttributeValueChangeEvent":{ "description":"The BillFormat attribute-value-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormatAttributeValueChangeEvent" }, "examples":{ "BillFormatAttributeValueChangeEvent":{ "$ref":"#/components/examples/BillFormatAttributeValueChangeEvent_request" } } } }, "required":true }, "BillFormatStateChangeEvent":{ "description":"The BillFormat state-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormatStateChangeEvent" }, "examples":{ "BillFormatStateChangeEvent":{ "$ref":"#/components/examples/BillFormatStateChangeEvent_request" } } } }, "required":true }, "BillFormatDeleteEvent":{ "description":"The BillFormat delete event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormatDeleteEvent" }, "examples":{ "BillFormatDeleteEvent":{ "$ref":"#/components/examples/BillFormatDeleteEvent_request" } } } }, "required":true }, "BillPresentationMedia_FVO":{ "description":"The BillPresentationMedia to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia_FVO" }, "examples":{ "CreateBillPresentationMedia_example":{ "$ref":"#/components/examples/CreateBillPresentationMedia_example_request" }, "BillPresentationMedia_create_example":{ "$ref":"#/components/examples/BillPresentationMedia_create_example_request" } } } }, "required":true }, "BillPresentationMedia_MVO":{ "description":"The BillPresentationMedia to update.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia_MVO" } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia_MVO" }, "examples":{ "BillPresentationMedia_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_Patch_Merge_request" }, "BillPresentationMedia_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_Implied_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PatchBillPresentationMedia_update_example_JSON":{ "$ref":"#/components/examples/PatchBillPresentationMedia_update_example_JSON_request" }, "BillPresentationMedia_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_JSON_Patch_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" } } }, "required":true }, "BillPresentationMediaCreateEvent":{ "description":"The BillPresentationMedia create event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMediaCreateEvent" }, "examples":{ "CreateBillPresentationMediaEvent":{ "$ref":"#/components/examples/CreateBillPresentationMediaEvent_request" } } } }, "required":true }, "BillPresentationMediaAttributeValueChangeEvent":{ "description":"The BillPresentationMedia attribute-value-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMediaAttributeValueChangeEvent" }, "examples":{ "BillPresentationMediaAttributeValueChangeEvent":{ "$ref":"#/components/examples/BillPresentationMediaAttributeValueChangeEvent_request" } } } }, "required":true }, "BillPresentationMediaStateChangeEvent":{ "description":"The BillPresentationMedia state-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMediaStateChangeEvent" }, "examples":{ "BillPresentationMediaStateChangeEvent":{ "$ref":"#/components/examples/BillPresentationMediaStateChangeEvent_request" } } } }, "required":true }, "BillPresentationMediaDeleteEvent":{ "description":"The BillPresentationMedia delete event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMediaDeleteEvent" }, "examples":{ "BillPresentationMediaDeleteEvent":{ "$ref":"#/components/examples/BillPresentationMediaDeleteEvent_request" } } } }, "required":true }, "BillingCycleSpecification_FVO":{ "description":"The BillingCycleSpecification to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification_FVO" }, "examples":{ "CreateBillingCycleSpecification_example":{ "$ref":"#/components/examples/CreateBillingCycleSpecification_example_request" }, "BillingCycleSpecification_create_example":{ "$ref":"#/components/examples/BillingCycleSpecification_create_example_request" } } } }, "required":true }, "BillingCycleSpecification_MVO":{ "description":"The BillingCycleSpecification to update.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification_MVO" }, "examples":{ "BillingCycleSpecification_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Implied_Merge_request" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification_MVO" }, "examples":{ "BillingCycleSpecification_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Patch_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "BillingCycleSpecification_update_example_JSON_Patch_Query":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_Query_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PatchBillingCycleSpecification_update_example_JSON":{ "$ref":"#/components/examples/PatchBillingCycleSpecification_update_example_JSON_request" }, "BillingCycleSpecification_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_request" } } } }, "required":true }, "BillingCycleSpecificationOracle_FVO":{ "description":"The BillingCycleSpecification to create.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle_FVO" }, { "$ref":"#/components/schemas/BillingCycleSpecification_FVO" } ] }, "examples":{ "CreateBillingCycleSpecification_example":{ "$ref":"#/components/examples/CreateBillingCycleSpecification_example_request" }, "BillingCycleSpecification_create_example":{ "$ref":"#/components/examples/BillingCycleSpecification_create_example_request" } } } }, "required":true }, "BillingCycleSpecificationOracle_MVO":{ "description":"The BillingCycleSpecification to update.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle_MVO" }, { "$ref":"#/components/schemas/BillingCycleSpecification_MVO" } ] }, "examples":{ "BillingCycleSpecification_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Implied_Merge_Oracle_request" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification_MVO" }, "examples":{ "BillingCycleSpecification_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Patch_Merge_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "BillingCycleSpecification_update_example_JSON_Patch_Query":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_Query_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "PatchBillingCycleSpecification_update_example_JSON":{ "$ref":"#/components/examples/PatchBillingCycleSpecification_update_example_JSON_request" }, "BillingCycleSpecification_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_request" } } } }, "required":true }, "BillingCycleSpecificationCreateEvent":{ "description":"The BillingCycleSpecification create event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecificationCreateEvent" }, "examples":{ "CreateBillingCycleSpecificationEvent":{ "$ref":"#/components/examples/CreateBillingCycleSpecificationEvent_request" } } } }, "required":true }, "BillingCycleSpecificationAttributeValueChangeEvent":{ "description":"The BillingCycleSpecification attribute-value-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecificationAttributeValueChangeEvent" }, "examples":{ "BillingCycleSpecificationAttributeValueChangeEvent":{ "$ref":"#/components/examples/BillingCycleSpecificationAttributeValueChangeEvent_request" } } } }, "required":true }, "BillingCycleSpecificationStateChangeEvent":{ "description":"The BillingCycleSpecification state-change event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecificationStateChangeEvent" }, "examples":{ "BillingCycleSpecificationStateChangeEvent":{ "$ref":"#/components/examples/BillingCycleSpecificationStateChangeEvent_request" } } } }, "required":true }, "BillingCycleSpecificationDeleteEvent":{ "description":"The BillingCycleSpecification delete event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecificationDeleteEvent" }, "examples":{ "BillingCycleSpecificationDeleteEvent":{ "$ref":"#/components/examples/BillingCycleSpecificationDeleteEvent_request" } } } }, "required":true }, "Hub_FVO":{ "description":"The data that contains the callback endpoint for delivering information.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Hub_FVO" } } }, "required":true }, "Product_FVO":{ "description":"The product to create.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product_FVO" }, { "$ref":"#/components/schemas/ProductOracle_FVO" } ] }, "examples":{ "CreateProductNonTelco":{ "$ref":"#/components/examples/CreateProductNonTelco_request" }, "CreateProductTelco":{ "$ref":"#/components/examples/CreateProductTelco_request" }, "CreateProductBundle":{ "$ref":"#/components/examples/CreateProductBundle_request" }, "CreateProduct_ProductOracle":{ "$ref":"#/components/examples/CreateProduct_ProductOracle_request_With_ERA" }, "CreateProductSharingGroupOwner":{ "$ref":"#/components/examples/CreateProductSharingGroupOwner_request" }, "CreateProductSharingGroupMember":{ "$ref":"#/components/examples/CreateProductSharingGroupMember_request" }, "CreateProductSharingGroupExplicit":{ "$ref":"#/components/examples/CreateProductSharingGroupExplicit_request" }, "CreateProductSharingGroupOffer":{ "$ref":"#/components/examples/CreateProductSharingGroupOffer_request" } } } }, "required":true }, "Product_MVO":{ "description":"The product to update.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product_MVO" }, { "$ref":"#/components/schemas/ProductOracle_MVO" } ] }, "examples":{ "Product_partialupdate_example_application_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_json_request" }, "Product_flattenedServiceAliasUpdate_example_application_json":{ "$ref":"#/components/examples/Product_flattenedServiceAliasUpdate_example_application_json_request" }, "Product_nonFlattenedServiceAliasUpdate_example_application_json":{ "$ref":"#/components/examples/Product_nonFlattenedServiceAliasUpdate_example_application_json_request" }, "Product_productPriceUpdate_example_application_json":{ "$ref":"#/components/examples/Product_productPriceUpdate_example_application_json_request" }, "Product_productRelationshipPatch_example_application_json":{ "$ref":"#/components/examples/Product_productRelationshipPatch_example_application_json_request" }, "ProductOracle_partialupdate_example_application_json":{ "$ref":"#/components/examples/ProductOracle_partialupdate_example_application_json_request" }, "ProductSharingGroupRemoval":{ "$ref":"#/components/examples/ProductSharingGroupRemoval_request" }, "ProductSharingGroupEnable":{ "$ref":"#/components/examples/ProductSharingGroupEnable_request" }, "ProductSharingDiscountGroupRemoval":{ "$ref":"#/components/examples/ProductSharingDiscountGroupRemoval_request" }, "ProductOracle_specialRatingProfileAdd_example_application_json":{ "$ref":"#/components/examples/ProductOracle_specialRatingProfileAdd_example_application_json_request" } } }, "application/merge-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product_MVO" }, { "$ref":"#/components/schemas/ProductOracle_MVO" } ] }, "examples":{ "Product_partialupdate_example_application_merge_patch_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_merge_patch_json_request" } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "Product_partialupdate_example_application_json_patch_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_json_patch_json_request" } } }, "application/json-patch-query+json":{ "schema":{ "$ref":"#/components/schemas/JsonPatchOperations" }, "examples":{ "Product_partialupdate_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productPriceAdd_example_application_json_patch_query_json_request" }, "Product_partialupdate_productPriceReplace_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productPriceReplace_example_application_json_patch_query_json_request" }, "Product_partialupdate_productPriceRemove_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productPriceRemove_example_application_json_patch_query_json_request" }, "Product_partialupdate_productCharacteristicServiceAliasAdd_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasAdd_example_application_json_patch_query_json_request" }, "Product_partialupdate_productCharacteristicServiceAliasReplace_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasReplace_example_application_json_patch_query_json_request" }, "Product_partialupdate_productCharacteristicServiceAliasRemove_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasRemove_example_application_json_patch_query_json_request" }, "Product_partialupdate_productRelationshipAdd_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipAdd_example_application_json_patch_query_json_request" }, "Product_partialupdate_productRelationshipReplace_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipReplace_example_application_json_patch_query_json_request" }, "Product_partialupdate_productRelationshipRemove_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipRemove_example_application_json_patch_query_json_request" }, "Product_partialupdate_specialRatingDataAdd_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataAdd_example_application_json_patch_query_json_request" }, "Product_partialupdate_specialRatingDataReplace_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataReplace_example_application_json_patch_query_json_request" }, "Product_partialupdate_specialRatingDataRemove_example_application_json_patch_query_json":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataRemove_example_application_json_patch_query_json_request" }, "ProductEnableCommunityMemberJsonPatch":{ "$ref":"#/components/examples/ProductEnableCommunityMemberJsonPatch_request" }, "ProductRemoveCommunityMember":{ "$ref":"#/components/examples/ProductRemoveCommunityMember_request" }, "ProductCommunityOfferEnable":{ "$ref":"#/components/examples/ProductCommunityOfferEnable_request" } } } }, "required":true }, "ProductCreateEvent":{ "description":"The ProductCreateEvent payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductCreateEvent" }, "examples":{ "ProductCreateEvent":{ "$ref":"#/components/examples/ProductCreateEvent_request" } } } }, "required":true }, "ProductAttributeValueChangeEvent":{ "description":"The ProductAttributeValueChangeEvent payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductAttributeValueChangeEvent" }, "examples":{ "ProductAttributeValueChangeEvent":{ "$ref":"#/components/examples/ProductAttributeValueChangeEvent_request" } } } }, "required":true }, "ProductStateChangeEvent":{ "description":"The ProductStateChange event payload.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductStateChangeEvent" }, "examples":{ "ProductStateChangeEvent":{ "$ref":"#/components/examples/ProductStateChangeEvent_request" } } } }, "required":true }, "ProductDeleteEvent":{ "description":"The payload for the ProductDeleteEvent event.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ProductDeleteEvent" }, "examples":{ "ProductDeleteEvent":{ "$ref":"#/components/examples/ProductDeleteEvent_request" } } } }, "required":true } }, "responses":{ "200":{ "description":"The request completed successfully." }, "202":{ "description":"The request was accepted." }, "204":{ "description":"The resource was deleted." }, "400":{ "description":"The server received a bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The request is unauthorized.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request is forbidden.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"The resource is not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"The method is not allowed.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request conflicts with the resource state.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The server encountered an internal error.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "501":{ "description":"The server does not implement this operation.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "503":{ "description":"The service is unavailable.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "200PartyAccountArray":{ "description":"The request completed successfully.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PartyAccount" } }, "examples":{ "PartyAccount_list_example":{ "$ref":"#/components/examples/PartyAccount_list_example_response" } } } } }, "200PartyAccount_Get":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount" }, "examples":{ "PartyAccount_retrieve_example":{ "$ref":"#/components/examples/PartyAccount_retrieve_example_response" } } } } }, "200PartyAccount_Patch":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount" }, "examples":{ "PartyAccount_update_example_Implied_Merge":{ "$ref":"#/components/examples/PartyAccount_update_example_Implied_Merge_response" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount" }, "examples":{ "PartyAccount_update_example_Patch_Merge":{ "$ref":"#/components/examples/PartyAccount_update_example_Patch_Merge_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/PartyAccount" }, { "type":"array", "items":{ "$ref":"#/components/schemas/PartyAccount" } }, { "type":"string", "nullable":true } ] }, "examples":{ "PartyAccount_update_example_JSON_Patch":{ "$ref":"#/components/examples/PartyAccount_update_example_JSON_Patch_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/PartyAccount" }, { "type":"array", "items":{ "$ref":"#/components/schemas/PartyAccount" } }, { "type":"string", "nullable":true } ] }, "examples":{ "PartyAccount_update_example_JSON_Patch_Query":{ "$ref":"#/components/examples/PartyAccount_update_example_JSON_Patch_Query_response" } } } } }, "201PartyAccount":{ "description":"The resource was updated or created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PartyAccount" }, "examples":{ "PartyAccount_create_example":{ "$ref":"#/components/examples/PartyAccount_create_example_response" } } } } }, "200BillingAccountArray":{ "description":"The request completed successfully.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] } }, "examples":{ "BillingAccount_Oracle_list_example":{ "$ref":"#/components/examples/BillingAccount_list_example_response" }, "BillingAccount_Oracle_list_specific_field_example":{ "$ref":"#/components/examples/BillingAccount_list_example_response_specific_fields" } } } } }, "200BillingAccount_Get":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "BillingAccount_retrieve_example":{ "$ref":"#/components/examples/BillingAccount_retrieve_example_response" }, "BillingAccount_Oracle_GET_withBalances_Example":{ "$ref":"#/components/examples/BillingAccount_Oracle_GET_withBalances_Example" }, "BillingAccount_Oracle_GET_withAccountRelationship_Example":{ "$ref":"#/components/examples/BillingAccount_Oracle_GET_withAccountRelationship_Example" } } } } }, "200BillingAccount_Patch":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "BillingAccount_Update_example_Implied_Merge":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_Merge_response" }, "BillingAccount_Update_example_Implied_State_Closed_response":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_Merge_State_Closed_response" }, "BillingAccount_Update_example_AccountType_business_response":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_Merge_AccountType_business_response" }, "BillingAccount_Update_example_Extended_Fields_response":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_Merge_Extended_Fields_response" }, "BillingAccount_Update_example_BillStructure_response":{ "$ref":"#/components/examples/BillingAccount_Update_example_Implied_BillStructure_Fields_response" }, "BillingAccount_Update_example_Patch_Contact_responsee":{ "$ref":"#/components/examples/BillingAccount_Update_example_Patch_Contact_response" }, "BillingAccount_Update_example_Patch_VatCert_responsee":{ "$ref":"#/components/examples/BillingAccount_Update_example_Patch_VatCert_response" } } }, "application/merge-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "BillingAccount_Update_example_Patch_Merge":{ "$ref":"#/components/examples/BillingAccount_Update_example_Patch_Merge_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "BillingAccount_Update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "BillingAccount_Update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_response" }, "BillingAccount_Update_example_JSON_Patch_AddBillStructure":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_AddBillStructure_response" }, "BillingAccount_Update_example_JSON_Patch_AddAccountRelationShip":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_Add_Account_RelationShip_response" }, "BillingAccount_Update_example_JSON_Patch_ReplaceBillStructurePresentationMedia":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_BillStructurePresentatoinMedia_response" }, "BillingAccount_Update_example_JSON_Patch_RemoveTaxExemption":{ "$ref":"#/components/examples/BillingAccount_Update_example_JSON_Patch_RemoveTaxExemption_response" } } } } }, "201BillingAccount":{ "description":"The resource was updated or created.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingAccount" }, { "$ref":"#/components/schemas/BillingAccountOracle" } ] }, "examples":{ "CreateBillingAccount_example":{ "$ref":"#/components/examples/CreateBillingAccount_example_response" }, "BillingAccount_Create_example":{ "$ref":"#/components/examples/BillingAccount_Create_example_response" }, "BillingAccount_Create_withoutBillStructure_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withoutBillStructure_Oracle_example_response" }, "BillingAccount_Create_withTaxExemption_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withTaxExemptions_Oracle_example_response" }, "BillingAccount_Create_withAccountRelationship_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withAccountRelationship_Oracle_example_response" }, "BillingAccount_Create_withVatCert_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withVatCert_Oracle_example_response" }, "BillingAccount_Create_withCreditLimit_Oracle_example":{ "$ref":"#/components/examples/BillingAccount_Create_withCreditLimit_Oracle_example_response" } } } } }, "200BillFormatArray":{ "description":"The request completed successfully.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillFormat" } }, "examples":{ "ListBillFormat_example":{ "$ref":"#/components/examples/ListBillFormat_example_response" }, "BillFormat_list_example":{ "$ref":"#/components/examples/BillFormat_list_example_response" } } } } }, "200BillFormat_Get":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormat" }, "examples":{ "RetrieveBillFormat_example":{ "$ref":"#/components/examples/RetrieveBillFormat_example_response" }, "BillFormat_retrieve_example":{ "$ref":"#/components/examples/BillFormat_retrieve_example_response" } } } } }, "200BillFormat_Patch":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormat" } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillFormat" }, "examples":{ "PatchBillFormat_update_example_JSON":{ "$ref":"#/components/examples/PatchBillFormat_update_example_JSON_response" }, "BillFormat_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillFormat_update_example_Patch_Merge_response" }, "BillFormat_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillFormat_update_example_Implied_Merge_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillFormat" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillFormat" } }, { "type":"string", "nullable":true } ] }, "examples":{ "BillFormat_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillFormat_update_example_JSON_Patch_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillFormat" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillFormat" } }, { "type":"string", "nullable":true } ] } } } }, "201BillFormat":{ "description":"The resource was updated or created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillFormat" }, "examples":{ "CreateBillFormat_example":{ "$ref":"#/components/examples/CreateBillFormat_example_response" }, "BillFormat_create_example":{ "$ref":"#/components/examples/BillFormat_create_example_response" } } } } }, "200BillPresentationMediaArray":{ "description":"The request completed successfully.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMedia" } }, "examples":{ "ListBillPresentationMedia_example":{ "$ref":"#/components/examples/ListBillPresentationMedia_example_response" }, "BillPresentationMedia_list_example":{ "$ref":"#/components/examples/BillPresentationMedia_list_example_response" } } } } }, "200BillPresentationMedia_Get":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia" }, "examples":{ "RetrieveBillPresentationMedia_example":{ "$ref":"#/components/examples/RetrieveBillPresentationMedia_example_response" }, "BillPresentationMedia_retrieve_example":{ "$ref":"#/components/examples/BillPresentationMedia_retrieve_example_response" } } } } }, "200BillPresentationMedia_Patch":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia" } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia" }, "examples":{ "PatchBillPresentationMedia_update_example_JSON":{ "$ref":"#/components/examples/PatchBillPresentationMedia_update_example_JSON_response" }, "BillPresentationMedia_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_Patch_Merge_response" }, "BillPresentationMedia_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_Implied_Merge_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillPresentationMedia" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMedia" } }, { "type":"string", "nullable":true } ] }, "examples":{ "BillPresentationMedia_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillPresentationMedia_update_example_JSON_Patch_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillPresentationMedia" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillPresentationMedia" } }, { "type":"string", "nullable":true } ] } } } }, "201BillPresentationMedia":{ "description":"The resource was updated or created.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BillPresentationMedia" }, "examples":{ "CreateBillPresentationMedia_example":{ "$ref":"#/components/examples/CreateBillPresentationMedia_example_response" }, "BillPresentationMedia_create_example":{ "$ref":"#/components/examples/BillPresentationMedia_create_example_response" } } } } }, "200BillingCycleSpecificationArray":{ "description":"The request completed successfully.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle" }, { "$ref":"#/components/schemas/BillingCycleSpecification" } ] } }, "examples":{ "ListBillingCycleSpecification_example":{ "$ref":"#/components/examples/ListBillingCycleSpecification_example_response" }, "BillingCycleSpecification_list_example":{ "$ref":"#/components/examples/BillingCycleSpecification_list_example_response" } } } } }, "200BillingCycleSpecification_Get":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecificationOracle" }, { "$ref":"#/components/schemas/BillingCycleSpecification" } ] }, "examples":{ "RetrieveBillingCycleSpecification_example":{ "$ref":"#/components/examples/RetrieveBillingCycleSpecification_example_response" }, "BillingCycleSpecification_retrieve_example":{ "$ref":"#/components/examples/BillingCycleSpecification_retrieve_example_response" } } } } }, "200BillingCycleSpecification_Patch":{ "description":"The request completed successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification" }, { "$ref":"#/components/schemas/BillingCycleSpecificationOracle" } ] }, "examples":{ "BillingCycleSpecification_update_example_Implied_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Implied_Merge_Oracle_response" } } }, "application/merge-patch+json":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification" }, "examples":{ "BillingCycleSpecification_update_example_Patch_Merge":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_Patch_Merge_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillingCycleSpecification" } }, { "type":"string", "nullable":true } ] }, "examples":{ "BillingCycleSpecification_update_example_JSON_Patch_Query":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_Query_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification" }, { "type":"array", "items":{ "$ref":"#/components/schemas/BillingCycleSpecification" } }, { "type":"string", "nullable":true } ] }, "examples":{ "PatchBillingCycleSpecification_update_example_JSON":{ "$ref":"#/components/examples/PatchBillingCycleSpecification_update_example_JSON_response" }, "BillingCycleSpecification_update_example_JSON_Patch":{ "$ref":"#/components/examples/BillingCycleSpecification_update_example_JSON_Patch_response" } } } } }, "201BillingCycleSpecification":{ "description":"The resource was updated or created.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/BillingCycleSpecification" }, { "$ref":"#/components/schemas/BillingCycleSpecificationOracle" } ] }, "examples":{ "CreateBillingCycleSpecification_example":{ "$ref":"#/components/examples/CreateBillingCycleSpecification_example_response" }, "BillingCycleSpecification_create_example":{ "$ref":"#/components/examples/BillingCycleSpecification_create_example_response" } } } } }, "Error":{ "description":"An error occurred.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "Hub":{ "description":"The client listener was notified.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Hub" } } } }, "200ProductArray":{ "description":"The request was successfully completed.", "headers":{ "X-Total-Count":{ "$ref":"#/components/headers/X-Total-Count" }, "X-Result-Count":{ "$ref":"#/components/headers/X-Result-Count" } }, "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] }, "examples":{ "RetrieveProductByList":{ "$ref":"#/components/examples/RetrieveProductByList_response" }, "RetrieveProductByListwithFieldsSelection":{ "$ref":"#/components/examples/RetrieveProductByListwithFieldsSelection_response" } } } } }, "200Product_Get":{ "description":"The request was successfully completed.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] }, "examples":{ "RetrieveProduct1":{ "$ref":"#/components/examples/RetrieveProduct1_response" }, "RetrieveProductSpecialRating":{ "$ref":"#/components/examples/RetrieveProductSpecialRating_response" } } } } }, "200Product_Patch":{ "description":"The request was successfully completed.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] }, "examples":{ "Product_partialupdate_example_application_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_json_response" }, "Product_flattenedServiceAliasUpdate_example_application_json":{ "$ref":"#/components/examples/Product_flattenedServiceAliasUpdate_example_application_json_response" }, "Product_nonFlattenedServiceAliasUpdate_example_application_json":{ "$ref":"#/components/examples/Product_nonFlattenedServiceAliasUpdate_example_application_json_response" }, "Product_productPriceUpdate_example_application_json":{ "$ref":"#/components/examples/Product_productPriceUpdate_example_application_json_response" }, "Product_productRelationshipPatch_example_application_json":{ "$ref":"#/components/examples/Product_productRelationshipPatch_example_application_json_response" }, "ProductOracle_partialupdate_example_application_json":{ "$ref":"#/components/examples/ProductOracle_partialupdate_example_application_json_response" }, "ProductOracle_specialRatingProfileAdd_example_application_json":{ "$ref":"#/components/examples/ProductOracle_specialRatingProfileAdd_example_application_json_response" }, "ProductSharingGroupRemoval":{ "$ref":"#/components/examples/ProductSharingGroupRemoval_response" }, "ProductSharingGroupEnable":{ "$ref":"#/components/examples/ProductSharingGroupEnable_response" }, "ProductSharingDiscountGroupRemoval":{ "$ref":"#/components/examples/ProductSharingDiscountGroupRemoval_response" } } }, "application/merge-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] }, "examples":{ "Product_partialupdate_example_application_merge_patch_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_merge_patch_json_response" } } }, "application/json-patch+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" }, { "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] } }, { "type":"string", "nullable":true } ] }, "examples":{ "Product_partialupdate_example_application_json_patch_json":{ "$ref":"#/components/examples/Product_partialupdate_example_application_json_patch_json_response" } } }, "application/json-patch-query+json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" }, { "type":"array", "items":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] } }, { "type":"string", "nullable":true } ] }, "examples":{ "Product_partialupdate_productPriceAdd":{ "$ref":"#/components/examples/Product_partialupdate_productPriceAdd_example_application_json_patch_query_json_response" }, "Product_partialupdate_productPriceReplace":{ "$ref":"#/components/examples/Product_partialupdate_productPriceReplace_example_application_json_patch_query_json_response" }, "Product_partialupdate_productPriceRemove":{ "$ref":"#/components/examples/Product_partialupdate_productPriceRemove_example_application_json_patch_query_json_response" }, "Product_partialupdate_productCharacteristicServiceAliasAdd":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasAdd_example_application_json_patch_query_json_response" }, "Product_partialupdate_productCharacteristicServiceAliasReplace":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasReplace_example_application_json_patch_query_json_response" }, "Product_partialupdate_productCharacteristicServiceAliasRemove":{ "$ref":"#/components/examples/Product_partialupdate_productCharacteristicServiceAliasRemove_example_application_json_patch_query_json_response" }, "Product_partialupdate_productRelationshipAdd":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipAdd_example_application_json_patch_query_json_response" }, "Product_partialupdate_productRelationshipReplace":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipReplace_example_application_json_patch_query_json_response" }, "Product_partialupdate_productRelationshipRemove":{ "$ref":"#/components/examples/Product_partialupdate_productRelationshipRemove_example_application_json_patch_query_json_response" }, "Product_partialupdate_specialRatingDataAdd":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataAdd_example_application_json_patch_query_json_response" }, "Product_partialupdate_specialRatingDataReplace":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataReplace_example_application_json_patch_query_json_response" }, "Product_partialupdate_specialRatingDataRemove":{ "$ref":"#/components/examples/Product_partialupdate_specialRatingDataRemove_example_application_json_patch_query_json_response" }, "ProductEnableCommunityMemberJsonPatch":{ "$ref":"#/components/examples/ProductEnableCommunityMemberJsonPatch_response" }, "ProductRemoveCommunityMember":{ "$ref":"#/components/examples/ProductRemoveCommunityMember_response" }, "ProductCommunityOfferEnable":{ "$ref":"#/components/examples/ProductCommunityOfferEnable_response" } } } } }, "201Product":{ "description":"The product was created successfully.", "content":{ "application/json":{ "schema":{ "oneOf":[ { "$ref":"#/components/schemas/Product" }, { "$ref":"#/components/schemas/ProductOracle" } ] }, "examples":{ "CreateProductNonTelco":{ "$ref":"#/components/examples/CreateProductNonTelco_response" }, "CreateProductTelco":{ "$ref":"#/components/examples/CreateProductTelco_response" }, "CreateProductBundle":{ "$ref":"#/components/examples/CreateProductBundle_response" }, "CreateProduct_ProductOracle":{ "$ref":"#/components/examples/CreateProduct_ProductOracle_response_With_ERA" }, "CreateProductSharingGroupOwner":{ "$ref":"#/components/examples/CreateProductSharingGroupOwner_response" }, "CreateProductSharingGroupMember":{ "$ref":"#/components/examples/CreateProductSharingGroupMember_response" }, "CreateProductSharingGroupExplicit":{ "$ref":"#/components/examples/CreateProductSharingGroupExplicit_response" }, "CreateProductSharingGroupOffer":{ "$ref":"#/components/examples/CreateProductSharingGroupOffer_response" } } } } } }, "headers":{ "X-Total-Count":{ "description":"The total number of items that match the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The actual number of items returned in the response body.", "schema":{ "type":"integer" } } }, "securitySchemes":{ }, "examples":{ "PartyAccount_list_example_response":{ "value":[ { "@type":"PartyAccount", "id":"9473", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/9473", "creditLimit":{ "unit":"USD", "value":50000 }, "name":"Administration Account" }, { "@type":"PartyAccount", "id":"9899", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/9899", "creditLimit":{ "unit":"USD", "value":1000000 }, "name":"Bahamas Account" } ], "description":"Here is an example of a response for retrieving multiple PartyAccounts." }, "PartyAccount_retrieve_example_response":{ "value":{ "@type":"PartyAccount", "creditLimit":{ "unit":"USD", "value":20000 }, "description":"This party account ...", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "lastModified":"2018-06-14T00:00:00.000Z", "name":"Travel account", "state":"Suspended", "accountType":"Business", "paymentStatus":"In Arrears", "billStructure":{ "@type":"BillStructure", "presentationMedia":[ { "@type":"BillPresentationMedia", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/8800", "id":"8800", "name":"Electronic" } ], "format":{ "@type":"BillFormat", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/4824", "id":"4824", "name":"Summary invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "dateShift":8, "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/1309", "id":"1309", "name":"Monthly billing" } }, "paymentPlan":[ { "@type":"PaymentPlan", "numberOfPayments":12, "paymentFrequency":"monthly", "priority":2, "status":"Ineffective", "totalAmount":{ "unit":"USD", "value":100 }, "planType":"regular", "validFor":{ "startDateTime":"2018-06-17T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "paymentMethod":{ "@type":"PaymentMethodRef", "href":"https://host:port/tmf-api/paymentMethods/v5/paymentMethod/6895", "id":"6895", "name":"family payment" } } ], "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665", "name":"John Doe Ltd" } } ], "taxExemption":[ { "@type":"TaxExemption", "certificateNumber":"45678889876", "issuingJurisdiction":"USA", "reason":"Embassy", "taxDefinition":[ { "@type":"TaxDefinition", "id":"96", "name":"Value Added Tax", "taxType":"federalVat" } ], "attachment":{ "@type":"Attachment", "id":"66235558562345", "href":"https://host:port/tmf-api/document/v5/attachment/66235558562345", "attachmentType":"taxExemptionCertificate", "name":"TaxExemptionCertificate-654321.pdf", "description":"Electronic version of the tax exemption certificate", "mimeType":"application/pdf", "url":"http://host:port/DocumentManager/666/TaxExemptionCertificate-654321.pdf" }, "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "contact":[ { "@type":"Contact", "contactName":"Anna Cristal", "contactType":"primary", "partyRoleType":"Publisher", "validFor":{ "startDateTime":"2018-06-11T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "contactMedium":[ { "@type":"GeographicAddressContactMedium", "preferred":false, "mediumType":"PostalAddress", "validFor":{ "startDateTime":"2018-06-14T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "city":"Paris", "country":"France", "postCode":"75014", "street1":"15 Rue des Canards" } ], "relatedParty":{ "role":"bill receiver", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@referredType":"Individual", "@type":"PartyRefOrPartyRoleRef", "href":"https://host:port/tmf-api/partyManagement/v5/individual/2186", "id":"2186", "name":"Gustave Flaubert" } } } ], "accountBalance":[ { "@type":"AccountBalance", "amount":{ "unit":"USD", "value":53.29 }, "balanceType":"DepositBalance", "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "accountRelationship":[ { "@type":"AccountRelationship", "relationshipType":"contains", "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "account":{ "@referredType":"BillingAccount", "@type":"AccountRef", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/9522", "id":"9522", "name":"Travel Account" } } ] }, "description":"Here is an example of a response for retrieving a specific PartyAccount." }, "BillingAccount_list_example_response":{ "value":[ { "@type":"BillingAccount", "id":"42", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/42", "name":"Lakes Agency Account", "description":"Business account for Lakes Agency marketing services", "lastUpdate":"2018-01-01T08:00:00.00Z", "accountType":"business", "state":"active", "taxExemption":[ { "issuingJurisdiction":"USA", "id":"EXEM03", "reason":"Business Tax Credit", "certificateNumber":"BTC-2024-42", "validFor":{ "endDateTime":"2026-12-31T23:59:59.00Z", "startDateTime":"2024-01-01T00:00:00.00Z" } } ], "billStructure":{ "id":"lakes-bill-structure", "name":"Standard Business Billing", "format":{ "id":"format-business-001", "name":"Detailed Invoice" }, "cycleSpecification":{ "id":"cycle-monthly", "name":"Monthly billing", "billingDateShift":1, "paymentDueDateOffset":15, "frequency":"monthly" }, "balanceGroup":[ { "isDefault":"true", "limit":[ { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":"5000.00" } ] } ], "presentationMedia":[ { "id":"media-email", "name":"Electronic" } ] }, "contact":[ { "contactMedium":[ { "stateOrProvince":"CA", "country":"USA", "mediumType":"PostalAddress", "city":"San Francisco", "street1":"123 Market Street", "postCode":"94105", "company":"Lakes Agency", "geoCode":"US-CA" }, { "emailAddress":"billing@lakesagency.com", "mediumType":"Email" }, { "phoneType":"business", "phoneNumber":"+1-415-555-0142" } ], "contactType":"billing", "contactName":"Sarah Johnson" } ], "relatedParty":[ { "partyOrPartyRole":{ "id":"42-001", "name":"Account Manager", "partyName":"Lakes Agency Inc.", "partyId":"PARTY-42" }, "role":"account holder" } ] }, { "@type":"BillingAccount", "id":"billing-account-comprehensive", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/billing-account-comprehensive", "name":"Full Home Account", "lastUpdate":"2018-01-01T08:00:00.00Z", "description":"This comprehensive billing account includes all possible fields.", "accountType":"consumer", "state":"active", "taxExemption":[ { "issuingJurisdiction":"USA", "id":"EXEM01", "reason":"NGO", "certificateNumber":"1234", "validFor":{ "endDateTime":"2027-08-06T11:30:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" } }, { "issuingJurisdiction":"USA", "id":"EXEM02", "reason":"Embassy", "certificateNumber":"6789", "validFor":{ "endDateTime":"2027-08-06T11:30:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" } } ], "billStructure":{ "id":"service-bill-2", "name":"Service Bill Structure 2", "format":{ "id":"", "name":"Detailed Invoice" }, "cycleSpecification":{ "id":"", "name":"Annual billing", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "isDefault":"true", "limit":[ { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":null }, { "unit":"MIN", "dynamicCreditFloor":"false", "creditFloor":null } ] } ], "presentationMedia":[ { "id":"", "name":"Post Mail" } ] }, "serviceBillStructure":[ { "id":"comprehensive-billstructure-id", "name":"Comprehensive Bill Structure", "format":{ "id":"", "name":"Summary Invoice" }, "cycleSpecification":{ "id":"cycle-spec-id-1", "name":"Annual Billing", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "isDefault":"true", "limit":[ { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":null } ] }, { "limit":[ { "unit":"CAD", "dynamicCreditFloor":"true", "creditFloor":null }, { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":"false", "creditFloor":null } ] } ], "presentationMedia":[ { "id":"", "name":"Post Mail" }, { "id":"", "name":"Electronic" } ] }, { "id":"service-bill-1", "name":"Service Bill Structure 1", "format":{ "id":"format-id-123-001", "name":"Summary Invoice-001" }, "cycleSpecification":{ "id":"", "name":"Annual billing", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "isDefault":"true", "limit":[ { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":"false", "creditFloor":null } ] } ], "presentationMedia":[ { "id":"", "name":"Post Mail" } ] } ], "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "country":"France", "mediumType":"PostalAddress", "city":"France", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneNumber":"28412" }, { "phoneType":"fax", "phoneNumber":"141231112" } ], "contactType":"primary", "contactName":"John " }, { "contactMedium":[ { "stateOrProvince":"IN", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN", "geoCode":"" }, { "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "phoneNumber":"890128412" } ], "contactType":"", "contactName":"Douglas Rachel" } ], "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "role":"service provider2" } ] } ], "description":"Here is an example of a response for retrieving BillingAccount resources. " }, "BillingAccount_list_example_response_specific_fields":{ "value":[ { "@type":"BillingAccount", "id":"100", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/100", "relatedParty":[ { "partyOrPartyRole":{ "id":"PARTY-100", "name":"Main Account Contact", "partyName":"Example Corp", "partyId":"EX-100" }, "role":"service provider" } ] }, { "@type":"BillingAccount", "id":"101", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/101", "relatedParty":[ { "partyOrPartyRole":{ "id":"PARTY-101", "name":"Secondary Account Contact", "partyName":"Beta Solutions Ltd.", "partyId":"EX-101" }, "role":"service provider" } ] }, { "@type":"BillingAccount", "id":"102", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/102", "relatedParty":[ { "partyOrPartyRole":{ "id":"PARTY-102", "name":"Finance Admin", "partyName":"Gamma Group", "partyId":"EX-102" }, "role":"service provider" } ] } ] }, "BillingAccount_retrieve_example_response":{ "value":{ "@type":"BillingAccount", "id":"42", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/42", "name":"Lakes Agency Account", "lastUpdate":"2018-01-01T08:00:00.00Z", "description":"Business account for Lakes Agency marketing services", "accountType":"business", "state":"active", "taxExemption":[ { "issuingJurisdiction":"USA", "id":"EXEM03", "reason":"Business Tax Credit", "certificateNumber":"BTC-2024-42", "validFor":{ "endDateTime":"2026-12-31T23:59:59.00Z", "startDateTime":"2024-01-01T00:00:00.00Z" } } ], "billStructure":{ "id":"lakes-bill-structure", "name":"Standard Business Billing", "format":{ "id":"format-business-001", "name":"Detailed Invoice" }, "cycleSpecification":{ "id":"cycle-monthly", "name":"Monthly billing", "billingDateShift":1, "paymentDueDateOffset":15, "frequency":"monthly" }, "balanceGroup":[ { "isDefault":"true", "limit":[ { "unit":"USD", "dynamicCreditFloor":"false", "creditFloor":"5000.00" } ] } ], "presentationMedia":[ { "id":"media-email", "name":"Electronic" } ] }, "contact":[ { "contactMedium":[ { "stateOrProvince":"CA", "country":"USA", "mediumType":"PostalAddress", "city":"San Francisco", "street1":"123 Market Street", "postCode":"94105", "company":"Lakes Agency", "geoCode":"US-CA" }, { "emailAddress":"billing@lakesagency.com", "mediumType":"Email" }, { "phoneType":"business", "phoneNumber":"+1-415-555-0142" } ], "contactType":"billing", "contactName":"Sarah Johnson" } ], "relatedParty":[ { "partyOrPartyRole":{ "id":"42-001", "name":"Account Manager", "partyName":"Lakes Agency Inc.", "partyId":"PARTY-42" }, "role":"account holder" } ] }, "description":"Here is an example of a response for retrieving a specific BillingAccount." }, "BillingAccount_Oracle_GET_withBalances_Example":{ "value":{ "name":"Home Account", "@type":"BillingAccountOracle", "billStructure":{ "payType":"invoice", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"billStruct-id-002", "@type":"BillStructureOracle", "format":{ "name":"Summary Invoice-098", "id":"0.0.0.1+-config-bill_format+183906", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+183906", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+180578", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+180578", "@type":"BillingCycleSpecificationOracle", "billingDateShift":8, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+181474", "name":"", "rules":[ { "unit":"USD", "consumptionRule":null } ], "balances":[ { "grantedBal":{ "value":0, "unit":"USD" }, "amount":{ "unit":"USD", "value":0 }, "totalAmount":{ "unit":"USD", "value":0 }, "outstandingAmount":{ "unit":"USD", "value":0 } } ], "isDefault":true, "services":[ { "id":"0.0.0.1+-service-ip+183376" } ], "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "overrideCreditLimit":0, "creditThreshold":0, "fixedThreshold":"" } ] } ], "presentationMedia":[ { "name":"Post Mail-098", "id":"0.0.0.1+-config-bill_presentation_media+182882", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+182882", "@type":"BillPresentationMedia" }, { "name":"Electronic-098", "id":"0.0.0.1+-config-bill_presentation_media+181858", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+181858", "@type":"BillPresentationMedia" } ] }, "accountBalance":[ { "validFor":{ "endDateTime":"", "startDateTime":"2018-01-03T08:00:00.00Z" }, "amount":{ "unit":"USD", "value":11.55 }, "grantedBal":{ "unit":"USD", "value":0 }, "nextBal":{ "unit":"USD", "value":0 }, "delayedBal":{ "unit":"USD", "value":0 } } ], "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "id":"9947", "partyName":"PartyName101", "@type":"PartyRefOrPartyRoleRef", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "id":"9948", "partyName":"", "@type":"PartyRefOrPartyRoleRef", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-temp-limit-test-100-002", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/account-with-temp-limit-test-100-002", "lastUpdate":"2018-01-01T08:00:00.00Z", "brmAccountType":"standard", "currencySecondary":"", "attribute":0, "accountNum":"account-with-temp-limit-test-100-002", "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"GET response example for a BillingAccountOracle with balance details." }, "BillingAccount_Oracle_GET_withAccountRelationship_Example":{ "value":{ "name":"Home Account", "@type":"BillingAccountOracle", "billStructure":{ "payType":"invoice", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"billing-account-test-bunit-parent01", "@type":"BillStructureOracle", "format":{ "name":"Summary Invoice-test-id-01", "id":"test3", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/test3", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"test4", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecificationOracle", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+189485", "name":"", "rules":[ { "unit":"USD", "consumptionRule":null } ], "balances":[ { "grantedBal":{ "value":0, "unit":"USD" }, "amount":{ "unit":"USD", "value":0 }, "totalAmount":{ "unit":"USD", "value":0 }, "outstandingAmount":{ "unit":"USD", "value":0 } } ], "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "overrideCreditLimit":0, "creditThreshold":0, "fixedThreshold":"", "creditLimit":10000 } ] }, { "id":"0.0.0.1+-balance_group+191533", "name":"", "rules":[ { "unit":"CAD", "consumptionRule":null }, { "unit":"USD", "consumptionRule":null }, { "unit":"YES", "consumptionRule":null } ], "balances":[ { "grantedBal":{ "value":0, "unit":"CAD" }, "amount":{ "unit":"CAD", "value":0 }, "totalAmount":{ "unit":"CAD", "value":0 }, "outstandingAmount":{ "unit":"CAD", "value":0 } }, { "grantedBal":{ "value":0, "unit":"USD" }, "amount":{ "unit":"USD", "value":0 }, "totalAmount":{ "unit":"USD", "value":0 }, "outstandingAmount":{ "unit":"USD", "value":0 } }, { "grantedBal":{ "value":0, "unit":"YES" }, "amount":{ "unit":"YES", "value":0 }, "totalAmount":{ "unit":"YES", "value":0 }, "outstandingAmount":{ "unit":"YES", "value":0 } } ], "limit":[ { "unit":"CAD", "dynamicCreditFloor":false, "creditFloor":-500, "overrideCreditLimit":0, "creditThreshold":0, "fixedThreshold":"", "creditLimit":1000 }, { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "overrideCreditLimit":0, "creditThreshold":0, "fixedThreshold":"", "creditLimit":1000 }, { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null, "overrideCreditLimit":0, "creditThreshold":0, "fixedThreshold":"", "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+9229", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+9229", "@type":"BillPresentationMedia" }, { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+9102", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+9102", "@type":"BillPresentationMedia" } ] }, "accountRelationship":[ { "@type":"AccountRelationshipOracle", "billStructure":{ "name":"BI_NAME405", "id":"billing-account-test-bunit-parent01" }, "relationshipType":"Subordinate", "account":{ "id":"billing-account-test-child02", "billStructure":{ "name":"BI_NAME405", "id":"billing-account-test-bunit-child02" } } }, { "@type":"AccountRelationshipOracle", "billStructure":{ "name":"BI_NAME405", "id":"billing-account-test-bunit-parent01" }, "relationshipType":"Child", "account":{ "id":"billing-account-test-child02", "billStructure":{ "name":"BI_NAME405", "id":"billing-account-test-bunit-child02" } } } ], "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "id":"9947", "partyName":"PartyName101", "@type":"PartyRefOrPartyRoleRef", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "id":"9948", "partyName":"", "@type":"PartyRefOrPartyRoleRef", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"billing-account-test-parent01", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/billing-account-test-parent01", "lastUpdate":"2018-01-01T08:00:00.00Z", "brmAccountType":"standard", "currencySecondary":"", "attribute":0, "accountNum":"billing-account-test-parent01", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMediumOracle", "mediumType":"PostalAddress", "country":"France", "city":"France", "street1":"Rue des Canards", "street2":"test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":null, "@type":"PhoneContactMediumOracle", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"ContactOracle", "contactType":"primary", "contactName":"John", "salutation":"" }, { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMediumOracle", "mediumType":"PostalAddress", "country":"France", "city":"Paris", "street1":"Rue des Canards", "street2":"test ind", "postCode":"75014", "company":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "@type":"PhoneContactMediumOracle", "phoneNumber":"890128412", "mediumType":"Phone" } ], "@type":"ContactOracle", "contactType":"secondary", "contactName":"Rachel Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"GET response example for a BillingAccountOracle with subordinate and child account relationships." }, "BillFormat_list_example_response":{ "value":[ { "@type":"BillFormat", "id":"42", "name":"simple invoice" }, { "@type":"BillFormat", "id":"43", "name":"detailed invoice" } ], "description":"Retrieving all bill formats." }, "BillFormat_retrieve_example_response":{ "value":{ "@type":"BillFormat", "description":"This bill format provides a detailed invoice.", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" }, "description":"Provides an example request for retrieving a BillFormat resource." }, "ListBillFormat_example_response":{ "value":[ { "id":"post-mail-id-test-7", "href":"https://host:port/brm/accountManagement/v5/billFormat/post-mail-id-test-7", "@type":"BillFormat", "name":"Post Mail-1-test-46", "description":"Provides a test description." }, { "id":"post-mail-id-test-5", "href":"https://host:port/brm/accountManagement/v5/billFormat/post-mail-id-test-5", "@type":"BillFormat", "name":"Post Mail-1-test-6", "description":"Provides a second test description." }, { "id":"post-bf-id-test-001", "href":"https://host:port/brm/accountManagement/v5/billFormat/post-bf-id-test-001", "@type":"BillFormat", "name":"POST Bill Format test 001", "description":"Provides a patching example." } ], "description":"Describes the BillFormat list response." }, "RetrieveBillFormat_example_response":{ "value":{ "id":"post-mail-id-test-7", "href":"https://host:port/brm/accountManagement/v5/billFormat/post-mail-id-test-7", "@type":"BillFormat", "name":"Post Mail-1-test-46", "description":"Provides a test description." }, "description":"Describes the BillFormat retrieval response." }, "BillPresentationMedia_list_example_response":{ "value":[ { "@type":"BillPresentationMedia", "id":"42", "name":"signed mail" }, { "@type":"BillPresentationMedia", "id":"43", "name":"postal" }, { "@type":"BillPresentationMedia", "id":"44", "name":"web" } ], "description":"Retrieving all bill presentation medias." }, "BillPresentationMedia_retrieve_example_response":{ "value":{ "@type":"BillPresentationMedia", "description":"This bill presentation media ...", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/4506", "id":"4506", "name":"Electronic" }, "description":"Provides an example response for retrieving a BillPresentationMedia resource." }, "ListBillPresentationMedia_example_response":{ "value":[ { "id":"post-mail-id-test-3", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/post-mail-id-test-3", "@type":"BillPresentationMedia", "name":"Provides a patching example.", "description":"Provides a patching example." }, { "id":"0.0.0.1+-config-bill_presentation_media+20134", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+20134", "@type":"BillPresentationMedia", "name":"Electronic", "description":"Electronic or Email presentation media" }, { "id":"0.0.0.1+-config-bill_presentation_media+14933", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+14933", "@type":"BillPresentationMedia", "name":"Post Mail", "description":"Postal or post-mail presentation media." } ], "description":"Describes the BillPresentationMedia list response." }, "RetrieveBillPresentationMedia_example_response":{ "value":{ "id":"post-mail-id-test-3", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/post-mail-id-test-3", "@type":"BillPresentationMedia", "name":"Provides a patching example.", "description":"Provides a patching example." }, "description":"Describes the BillPresentationMedia retrieval response." }, "BillingCycleSpecification_list_example_response":{ "value":[ { "@type":"BillCycleSpecification", "id":"9473", "name":"bimonthly" }, { "@type":"BillCycleSpecification", "id":"9473", "name":"monthly" }, { "@type":"BillCycleSpecification", "id":"9899", "name":"weekly" } ], "description":"Here is an example of a response for retrieving multiple BillingCycleSpecifications." }, "BillingCycleSpecification_retrieve_example_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":20, "billingPeriod":"monthly", "chargeDateOffset":10, "creditDateOffset":15, "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":25, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2025-01-10T00:00:00.000Z" } }, "description":"Here is an example of a response for retrieving a specific BillingCycleSpecification." }, "ListBillingCycleSpecification_example_response":{ "value":[ { "id":"post-BCS-id-test-4", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-4", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-4", "description":"Provides a test description.", "billingDateShift":4, "paymentDueDateOffset":30, "frequency":"monthly" }, { "id":"post-BCS-id-test-7", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-7", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-7", "description":"Provides a patching example.", "billingDateShift":4, "paymentDueDateOffset":30, "frequency":"yearly" }, { "id":"post-BCS-id-test-2", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-2", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-2", "description":"Provides a patching example.", "billingDateShift":42, "paymentDueDateOffset":30, "frequency":"yearly" } ], "description":"Describes the BillingCycleSpecification list response." }, "RetrieveBillingCycleSpecification_example_response":{ "value":{ "id":"post-BCS-id-test-4", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-4", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-4", "description":"Provides a test description.", "billingDateShift":4, "paymentDueDateOffset":30, "frequency":"monthly" }, "description":"Describes the BillingCycleSpecification retrieval response." }, "PartyAccount_create_example_request":{ "value":{ "@type":"PartyAccount", "name":"Travel account", "relatedParty":[ { "@type":"RelatedPartyRefOrPartyRoleRef", "role":"owner", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665" } } ] }, "description":"Here is an example of a request for creating a PartyAccount." }, "PartyAccount_create_example_response":{ "value":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "name":"Travel account", "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665", "name":"John Doe Ltd" } } ] }, "description":"Here is an example of a response for creating a PartyAccount." }, "BillingAccount_Create_example_request":{ "value":{ "@type":"BillingAccount", "name":"Home Account", "relatedParty":[ { "role":"service provider", "@type":"RelatedPartyRefOrRelatedPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/9947", "id":"9947", "name":"Richard Cole" } } ] }, "description":"Here is an example of a request for creating a BillingAccount." }, "BillingAccount_Create_example_response":{ "value":{ "@type":"BillingAccount", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/5430", "id":"5430", "name":"Home Account", "relatedParty":[ { "role":"service provider", "@type":"RelatedPartyRefOrRelatedPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/9947", "id":"9947", "name":"Richard Cole" } } ] }, "description":"Here is an example of a response for creating a BillingAccount." }, "BillingAccount_Create_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "id":"ID4174", "name":"Home Account", "description":"This billing account represents the main household billing structure.", "state":"active", "accountType":"consumer", "billStructure":{ "@type":"BillStructure", "name":"BI_NAME405", "id":"BI_ID4174", "presentationMedia":[ { "name":"Post Mail" }, { "name":"Electronic" } ], "format":{ "name":"Summary Invoice" }, "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":3, "frequency":"yearly", "name":"Annual billing", "paymentDueDateOffset":3 }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":10000 } ], "isDefault":true }, { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":10000 }, { "unit":"CAD", "creditLimit":1000, "dynamicCreditFloor":true, "creditFloor":-500 } ] } ] }, "serviceBillStructure":[ { "@type":"BillStructure", "name":"BI_NAME505", "presentationMedia":[ { "name":"Post Mail" } ], "format":{ "name":"No Invoice" }, "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":1000 } ] } ] }, { "@type":"BillStructure", "name":"BI_NAME606", "presentationMedia":[ { "name":"Post Mail" } ], "format":{ "name":"Detailed Invoice" }, "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"MIN", "creditLimit":10000 } ] } ] } ], "contact":[ { "contactType":null, "contactName":"Rachel Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test ind", "company":"IN", "stateOrProvince":"IN", "geoCode":"IND" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test-email@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" } ] }, { "contactType":"primary", "contactName":"John", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test2 blr", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test-email@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Provides a BillingAccount creation request example." }, "BillingAccount_Create_withoutBillStructure_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "id":"billing-account-post-without-bill-structure", "name":"Home Account", "description":"This billing account is created with a contact and related party.", "state":"active", "accountType":"consumer", "contact":[ { "contactType":"primary", "contactName":"John mb jobg", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"15 Rue des Canards", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Provides a BillingAccount creation request example." }, "BillingAccount_Create_withTaxExemptions_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "id":"billing-account-post-with-tax-exemptions", "name":"Home Account", "description":"This billing account represents the main household billing structure.", "state":"active", "accountType":"consumer", "billStructure":{ "@type":"BillStructure", "name":"BI_NAME405", "id":"billing-account-structure-post-eventcreate-S5", "presentationMedia":[ { "name":"Post Mail" }, { "name":"Electronic" } ], "format":{ "name":"Summary Invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":3, "frequency":"yearly", "name":"Annual billing", "paymentDueDateOffset":3 }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":10000 } ], "isDefault":true }, { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":10000 }, { "unit":"CAD", "creditLimit":1000, "dynamicCreditFloor":true, "creditFloor":-500 } ] } ] }, "serviceBillStructure":[ { "@type":"BillStructure", "name":"BI_NAME505", "presentationMedia":[ { "name":"Post Mail" } ], "format":{ "name":"No Invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":1000 } ] } ] }, { "@type":"BillStructure", "name":"BI_NAME606", "presentationMedia":[ { "name":"Post Mail" } ], "format":{ "name":"Detailed Invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"MIN", "creditLimit":10000 } ] } ] } ], "contact":[ { "contactType":"secondary", "contactName":"Rachel Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test ind", "company":"IN", "stateOrProvince":"IN", "geoCode":"IND" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" } ] }, { "contactType":"primary", "contactName":"John", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test2 blr", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "taxExemption":[ { "certificateNumber":"1234", "issuingJurisdiction":"USA", "validFor":{ "startDateTime":"2024-07-31T11:30:00.000Z", "endDateTime":"2027-08-06T11:30:00.000Z" }, "reason":"NGO", "id":"EXEM01", "taxDefinition":[ { "percent":5, "Type":"Federal" }, { "percent":3, "Type":"State" } ] }, { "certificateNumber":"6789", "issuingJurisdiction":"USA", "validFor":{ "startDateTime":"2024-07-31T11:30:00.000Z", "endDateTime":"2027-08-06T11:30:00.000Z" }, "reason":"Embassy", "id":"EXEM02", "taxDefinition":[ { "percent":6, "Type":"Country" }, { "percent":7, "Type":"City" } ] } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Provides a BillingAccount creation request example." }, "BillingAccount_Create_withAccountRelationship_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "name":"Home Account", "description":"This billing account represents the main household billing structure.", "id":"child_id", "state":"active", "accountType":"consumer", "billStructure":{ "@type":"BillStructure", "id":"child_billunit_id_eventcreate-S9", "name":"BI_NAME405", "presentationMedia":[ { "name":"Post Mail" }, { "name":"Electronic" } ], "format":{ "id":"test3", "name":"Summary Invoice-test-id" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":3, "frequency":"yearly", "id":"test4", "name":"Annual billing-testid", "paymentDueDateOffset":3 }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":10000 } ], "isDefault":true }, { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":10000 }, { "unit":"CAD", "creditLimit":1000, "dynamicCreditFloor":true, "creditFloor":-500 } ] } ] }, "contact":[ { "contactType":"secondary", "contactName":"Rachel Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test ind", "company":"IN", "stateOrProvince":"IN", "geoCode":"IND" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" } ] }, { "contactType":"primary", "contactName":"child-billunit", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test2 blr", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "accountRelationship":[ { "relationshipType":"AR", "billStructure":{ "id":"child_billunit_id_eventcreate-S9" }, "account":{ "id":"AR_id", "billStructure":{ "id":"AR_billunit_id" } } }, { "relationshipType":"Parent", "billStructure":{ "id":"child_billunit_id" }, "account":{ "id":"parent_id", "billStructure":{ "id":"parent_billunit_id" } } } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Provides a BillingAccount creation request example." }, "BillingAccount_Create_withVatCert_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "name":"Home Account", "description":"This billing account serves as the primary billing structure for the household.", "id":"child_id", "state":"active", "accountType":"consumer", "vatCertificate":"vat", "billStructure":{ "@type":"BillStructure", "id":"child_billunit_id_eventcreate-S9", "name":"BI_NAME405", "presentationMedia":[ { "name":"Post Mail" }, { "name":"Electronic" } ], "format":{ "id":"test3", "name":"Summary Invoice-test-id" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":3, "frequency":"yearly", "id":"test4", "name":"Annual billing-testid", "paymentDueDateOffset":3 }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":10000 } ], "isDefault":true }, { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":10000 }, { "unit":"CAD", "creditLimit":1000, "dynamicCreditFloor":true, "creditFloor":-500 } ] } ] }, "contact":[ { "contactType":"secondary", "contactName":"Rachel Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test ind", "company":"IN", "stateOrProvince":"IN", "geoCode":"IND" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" } ] }, { "contactType":"primary", "contactName":"child-billunit", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test2 blr", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Example request for creating a BillingAccount." }, "BillingAccount_Create_withCreditLimit_Oracle_example_request":{ "value":{ "@type":"BillingAccount", "name":"Home Account", "description":"This billing account represents the main household billing structure.", "id":"child_id", "state":"active", "accountType":"consumer", "creditLimit":{ "unit":"YES", "value":1000 }, "billStructure":{ "@type":"BillStructure", "id":"child_billunit_id_eventcreate-S9", "name":"BI_NAME405", "presentationMedia":[ { "name":"Post Mail" }, { "name":"Electronic" } ], "format":{ "id":"test3", "name":"Summary Invoice-test-id" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":3, "frequency":"yearly", "id":"test4", "name":"Annual billing-testid", "paymentDueDateOffset":3 } }, "contact":[ { "contactType":"secondary", "contactName":"Rachel Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test ind", "company":"IN", "stateOrProvince":"IN", "geoCode":"IND" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"890128412", "phoneType":"home" } ] }, { "contactType":"primary", "contactName":"child-billunit", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "postCode":"75014", "street1":"Rue des Canards", "street2":"test2 blr", "company":"IN", "stateOrProvince":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "mediumType":"Email", "emailAddress":"test@oracle.com" }, { "@type":"PhoneContactMedium", "mediumType":"Phone", "phoneNumber":"28412" }, { "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ] } ], "relatedParty":[ { "role":"service provider", "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyId":"PartyId101", "partyName":"PartyName101" } }, { "role":"service provider2", "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2" } } ] }, "description":"Provides a BillingAccount creation request example." }, "CreateBillingAccount_example_response":{ "value":{ "@type":"BillingAccount", "id":"12345", "href":"https://host:port/tmfapi/accountManagement/v5/billingAccount/12345", "description":"This billing account is for a customer", "name":"Home Account", "state":"active", "accountType":"consumer", "billStructure":{ "id":"ID1234", "presentationMedia":[ { "@type":"BillPresentationMedia", "href":"https://host:port/tmfapi/accountManagement/v5/billPresentationMedia/9968", "name":"Post Mail" }, { "@type":"BillPresentationMedia", "href":"https://host:port/tmfapi/accountManagement/v5/billPresentationMedia/9968", "name":"Electronic" } ], "format":{ "@type":"BillFormat", "href":"https://host:port/tmfapi/accountManagement/v5/billFormat/3555", "name":"Detailed invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "dateShift":4, "frequency":"yearly", "href":"https://host:port/tmfapi/accountManagement/v5/billingCycleSpecification/3828", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"YES", "creditLimit":10000 } ], "isDefaut":"Y" }, { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":1000 }, { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicFloor":1 } ] } ] }, "serviceBillStructure":[ { "id":"5678", "presentationMedia":[ { "@type":"BillPresentationMediaRef", "href":"https://host:port/tmfapi/accountManagement/v5/billPresentationMedia/9968", "name":"Post Mail" } ], "format":{ "@type":"BillFormat", "href":"https://host:port/tmfapi/accountManagement/v5/billFormat/3555", "name":"SUMMARY invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "dateShift":4, "frequency":"yearly", "href":"https://host:port/tmfapi/accountManagement/v5/billingCycleSpecification/3828", "name":"Annual billing" }, "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":1000 } ] } ] } ], "taxExemption":[ { "@type":"TaxExemption", "id":"1", "certificateNumber":"9665432345", "issuingJurisdiction":"USA", "reason":"Embassy", "taxDefinition":[ { "@type":"TaxDefinition", "id":"96", "name":"Value Added Tax", "taxType":"federalVat" } ], "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "contact":[ { "@type":"Contact", "id":"Contact1234", "contactName":"Rachel Douglas", "contactType":"primary", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "preferred":true, "mediumType":"PostalAddress", "city":"Paris", "country":"France", "postCode":"75014", "street1":"15 Rue des Canards" } ] } ], "relatedParty":[ { "role":"service provider", "@type":"RelatedPartyRefOrRelatedPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "id":"9947" } } ] }, "description":"POST Billing Account Response Description" }, "BillingAccount_Create_withoutBillStructure_Oracle_example_response":{ "value":{ "vatCertificate":"", "name":"Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Default Bill", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"0.0.0.1+-bill_structure+221626", "@type":"BillStructure", "format":{ "name":"Detailed invoice", "id":"0.0.0.1+-config-bill_format+17445", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+17445", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"Default Cycle Specification", "id":"0.0.0.1+-config-bill_cycle_specification+13591", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+13591", "@type":"BillingCycleSpecification" }, "balanceGroup":{ "name":"", "isDefault":true }, "presentationMedia":[ { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"This billing account is created with contact and related party", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"billing-account-post-without-bill-structure", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/billing-account-post-without-bill-structure", "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-223418", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"15 Rue des Canards", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John mb jobg", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"POST Billing Account Response Description" }, "BillingAccount_Create_withTaxExemptions_Oracle_example_response":{ "value":{ "vatCertificate":"", "name":"Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"billing-account-structure-post-eventcreate-S5", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"0.0.0.1+-config-bill_format+223584", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+223584", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"test4", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":{ "name":"", "limit":[ { "unit":"CAD", "dynamicCreditFloor":true, "creditFloor":null }, { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" }, { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373", "@type":"BillPresentationMedia" } ] }, "serviceBillStructure":[ { "payType":"invoice", "name":"BI_NAME505", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"0.0.0.1+-bill_structure+224363", "@type":"BillStructure", "format":{ "name":"No Invoice", "id":"0.0.0.1+-config-bill_format+224608", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+224608", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+222048", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+222048", "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly" }, "balanceGroup":{ "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" } ] }, { "payType":"invoice", "name":"BI_NAME606", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"0.0.0.1+-bill_structure+223595", "@type":"BillStructure", "format":{ "name":"Detailed Invoice", "id":"0.0.0.1+-config-bill_format+224096", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+224096", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+222048", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+222048", "@type":"BillingCycleSpecification", "billingDateShift":4, "frequency":"yearly" }, "balanceGroup":{ "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null }, { "unit":"MIN", "dynamicCreditFloor":false, "creditFloor":null } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" } ] } ], "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"billing-account-post-with-tax-exemptions", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/billing-account-post-with-tax-exemptions", "taxExemption":[ { "issuingJurisdiction":"USA", "id":"EXEM01", "@type":"TaxExemptionCertificate", "reason":"NGO", "certificateNumber":"1234", "validFor":{ "endDateTime":"2027-08-06T11:30:00.000Z", "startDateTime":"2024-07-31T11:30:00.000Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":0.5 }, { "Type":"state", "@type":"TaxDefinition", "percent":0.3 } ] }, { "issuingJurisdiction":"USA", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"Embassy", "certificateNumber":"6789", "validFor":{ "endDateTime":"2027-08-06T11:30:00.000Z", "startDateTime":"2024-07-31T11:30:00.000Z" }, "taxDefinition":[ { "Type":"country", "@type":"TaxDefinition", "percent":0.6 }, { "Type":"city", "@type":"TaxDefinition", "percent":0.7 } ] } ], "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-222379", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"France", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John", "salutation":"" }, { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"POST Billing Account Response Description" }, "BillingAccount_Create_withAccountRelationship_Oracle_example_response":{ "value":{ "vatCertificate":"", "name":"Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"subordinate", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"child_billunit_id_eventcreate-S9", "@type":"BillStructure", "format":{ "name":"Summary Invoice-test-id", "id":"test3", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/test3", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"test4", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":{ "name":"", "limit":[ { "unit":"CAD", "dynamicCreditFloor":true, "creditFloor":null }, { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" }, { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373", "@type":"BillPresentationMedia" } ] }, "accountRelationship":[ { "@type":"AccountRelationship", "billStructure":{ "id":"child_billunit_id_eventcreate-S9" }, "relationshipType":"AR", "account":{ "id":"parent_id_eventcreate-S7", "billStructure":{ "id":"parent_billunit_id_eventcreate-S7" } } }, { "@type":"AccountRelationship", "billStructure":{ "id":"child_billunit_id_eventcreate-S9" }, "relationshipType":"Parent", "account":{ "id":"parent_id_eventcreate-S7", "billStructure":{ "id":"parent_billunit_id_eventcreate-S7" } } } ], "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"child_id", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/child_id", "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-229072", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"France", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"child-billunit", "salutation":"" }, { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Describes the BillingAccount creation response." }, "BillingAccount_Create_withCreditLimit_Oracle_example_response":{ "value":{ "vatCertificate":"", "name":"Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"subordinate", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"child_billunit_id_eventcreate-S9", "@type":"BillStructure", "format":{ "name":"Summary Invoice-test-id", "id":"test3", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/test3", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"test4", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":{ "name":"", "id":"0.0.0.1+-balance_group+312700", "isDefault":true, "limit":[ { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":1000 } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" }, { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"child_id", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/child_id", "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-229072", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"France", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"child-billunit", "salutation":"" }, { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Describes the BillingAccount creation response." }, "BillingAccount_Create_withVatCert_Oracle_example_response":{ "value":{ "vatCertificate":"vat", "name":"Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"subordinate", "name":"BI_NAME405", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"child_billunit_id_eventcreate-S9", "@type":"BillStructure", "format":{ "name":"Summary Invoice-test-id", "id":"test3", "href":"https://localhost:8089/brm/accountManagement/v5/billFormat/test3", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"", "id":"test4", "href":"https://localhost:8089/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":{ "name":"", "limit":[ { "unit":"CAD", "dynamicCreditFloor":true, "creditFloor":null }, { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null }, { "unit":"YES", "dynamicCreditFloor":false, "creditFloor":null } ] }, "presentationMedia":[ { "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150", "@type":"BillPresentationMedia" }, { "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:8089/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"This billing account represents the main household billing structure", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9947", "name":"Related Party Name", "partyName":"PartyName101", "partyId":"PartyId101" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider" }, { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"", "partyId":"" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"child_id", "href":"https://localhost:8089/brm/accountManagement/v5/billingAccount/child_id", "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-229072", "contact":[ { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"France", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN", "geoCode":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"email", "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"child-billunit", "salutation":"" }, { "contactMedium":[ { "stateOrProvince":"IN", "@type":"GeographicAddressContactMedium", "country":"France", "mediumType":"PostalAddress", "city":"Paris", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" }, { "phoneType":"home", "@type":"PhoneContactMedium", "phoneNumber":"890128412", "mediumType":"Phone" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Describes the response returned after creating a billing account." }, "BillFormat_create_example_request":{ "value":{ "@type":"BillFormat", "name":"Detailed invoice" }, "description":"Here is an example of a request for creating a BillFormat." }, "BillFormat_create_example_response":{ "value":{ "@type":"BillFormat", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" }, "description":"Here is an example of a response for creating a BillFormat." }, "CreateBillFormat_example_request":{ "value":{ "@type":"BillFormat", "id":"post-bf-id-test-001", "name":"POST Bill Format test 001", "description":"Provides a test description." }, "description":"Provides a BillFormat creation request example." }, "CreateBillFormat_example_response":{ "value":{ "id":"0.0.0.1+-bill-format+12345", "href":"https://host:port/billing/v5/billFormat/0.0.0.1+-bill-format+12345", "@type":"BillFormat", "name":"POST Bill Format test 001", "description":"Provides a test description." }, "description":"Describes the BillFormat creation response." }, "BillPresentationMedia_create_example_request":{ "value":{ "@type":"BillPresentationMedia", "name":"Electronic" }, "description":"Here is an example of a request for creating a BillPresentationMedia." }, "BillPresentationMedia_create_example_response":{ "value":{ "@type":"BillPresentationMedia", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/4506", "id":"4506", "name":"Electronic" }, "description":"Here is an example of a response for creating a BillPresentationMedia." }, "CreateBillPresentationMedia_example_request":{ "value":{ "@type":"BillPresentationMedia", "id":"post-mail-id-test-3-1", "name":"Post Mail-1-test-3-1", "description":"Provides a test description." }, "description":"Provides a BillPresentationMedia creation request example." }, "CreateBillPresentationMedia_example_response":{ "value":{ "id":"post-mail-id-test-3-1", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/post-mail-id-test-3-1", "@type":"BillPresentationMedia", "name":"Post Mail-1-test-3-1", "description":"Provides a test description." }, "description":"Describes the BillPresentationMedia creation response." }, "BillingCycleSpecification_create_example_request":{ "value":{ "@type":"BillCycleSpecification", "name":"Monthly billing" }, "description":"Here is an example of a request for creating a BillingCycleSpecification." }, "BillingCycleSpecification_create_example_response":{ "value":{ "@type":"BillCycleSpecification", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "name":"Monthly billing" }, "description":"Here is an example of a response for creating a BillingCycleSpecification." }, "CreateBillingCycleSpecification_example_request":{ "value":{ "@type":"BillingCycleSpecification", "id":"post-BCS-id-test-3-1", "name":"Post BCS-1-test-3-1", "description":"Provides a test description.", "billingDateShift":4, "frequency":"yearly", "paymentDueDateOffset":30 }, "description":"Provides a BillingCycleSpecification creation request example." }, "CreateBillingCycleSpecification_example_response":{ "value":{ "id":"post-BCS-id-test-3-1", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-3-1", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-3-1", "description":"Provides a test description.", "billingDateShift":4, "frequency":"yearly", "paymentDueDateOffset":30 }, "description":"Describes the BillingCycleSpecification creation response." }, "PartyAccount_update_example_Implied_Merge_request":{ "value":{ "@type":"PartyAccount", "creditLimit":{ "unit":"USD", "value":5000 } }, "description":"Provides an example request for updating a PartyAccount with a merge patch." }, "PartyAccount_update_example_Implied_Merge_response":{ "value":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "name":"Travel account", "creditLimit":{ "unit":"USD", "value":5000 }, "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrRelatedPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665", "name":"John Doe Ltd" } } ] }, "description":"Here is an example of a response for updating a PartyAccount." }, "PartyAccount_update_example_Patch_Merge_request":{ "value":{ "@type":"PartyAccount", "creditLimit":{ "unit":"USD", "value":5000 } }, "description":"Provides an example request for updating a PartyAccount with a merge patch." }, "PartyAccount_update_example_Patch_Merge_response":{ "value":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "name":"Travel account", "creditLimit":{ "unit":"USD", "value":5000 }, "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrRelatedPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665", "name":"John Doe Ltd" } } ] }, "description":"Here is an example of a response for updating a PartyAccount." }, "PartyAccount_update_example_JSON_Patch_request":{ "value":[ { "op":"add", "path":"/relatedParty", "value":{ "role":"contact", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Individual", "href":"https://host:port/tmf-api/partyManagement/v5/individual/6666", "id":"6666", "name":"John Doe" } } } ], "description":"Provides an example request for updating a PartyAccount with a JSON Patch." }, "PartyAccount_update_example_JSON_Patch_response":{ "value":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "name":"Travel account", "creditLimit":{ "unit":"USD", "value":5000 }, "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/organization/4665", "id":"4665", "name":"John Doe Ltd" } }, { "role":"contact", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Individual", "href":"https://host:port/tmf-api/partyManagement/v5/individual/6666", "id":"6666", "name":"John Doe" } } ] }, "description":"Here is an example of a response for updating a PartyAccount." }, "PartyAccount_update_example_JSON_Patch_Query_request":{ "value":[ { "op":"replace", "path":"/taxExemption/validFor?/taxExemption/certificateNumber=45678889876", "value":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2020-01-10T00:00:00.000Z" } } ], "description":"Provides an example request for updating a PartyAccount with a JSON Patch query." }, "PartyAccount_update_example_JSON_Patch_Query_response":{ "value":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "name":"Travel account", "taxExemption":[ { "@type":"TaxExemption", "certificateNumber":"45678889876", "issuingJurisdiction":"USA", "reason":"Embassy", "taxDefinition":[ { "@type":"TaxDefinition", "id":"96", "name":"Value Added Tax", "taxType":"federalVat" } ], "attachment":{ "@type":"Attachment", "id":"654321234334534552", "href":"https://host:port/tmf-api/document/v5/attachment/654321234334534552", "attachmentType":"taxExemptionCertificate", "name":"TaxExemptionCertificate-654321.pdf", "description":"The electronic version of the tax exemption certificate.", "mimeType":"application/pdf", "url":"http://host:port/DocumentManager/666/TaxExemptionCertificate-654321.pdf" }, "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2020-01-10T00:00:00.000Z" } } ] }, "description":"Here is an example of a response for updating a PartyAccount." }, "BillingAccount_Update_example_JSON_Patch_request":{ "value":{ "path":"/contact/contactType?/contact.contactName=Rachel Douglas", "value":"primary", "op":"replace" }, "description":"Here is an example of a request for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchAddAccountRelationshipParent_request":{ "value":[ { "op":"add", "path":"$.accountRelationship", "value":{ "relationshipType":"Parent", "billStructure":null, "id":"child_billunit_id", "account":{ "billStructure":{ "id":"parent_billunit_id" }, "id":"parent_id" } } } ] }, "BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchReplacePresentationMedia_request":{ "value":[ { "op":"replace", "path":"$.billStructure[?(@.name=='Comprehensive Bill Structure2')].presentationMedia[?(@.id=='presentationMedia-test287')]", "value":{ "name":"Fax" } } ] }, "BillingAccount_Update_example_JSON_Patch_jsonPatch_jsonPatchRemoveTaxExemption_request":{ "value":[ { "op":"remove", "path":"$.taxExemption[?(@.id=='EXEM01')]" } ] }, "BillingAccount_Update_example_JSON_Patch_jsonPatch_addNewBillStructure_request":{ "value":[ { "op":"add", "path":"$.billStructure", "value":{ "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":10000 } ], "id":"bal-grp-id" } ], "name":"BI_NAME5013", "format":{ "name":"No invoice" }, "cycleSpecification":{ "billingDateShift":22, "paymentDueDateOffset":21, "@type":"BillingCycleSpecification", "name":"Annual billing-testid", "id":"test4", "frequency":"yearly" }, "presentationMedia":[ { "name":"fax" } ] } } ], "description":"Here is an example of a request for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_response":{ "value":{ "@type":"BillingAccount", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/5430", "id":"5430", "name":"Richard Cole Account", "contact":[ { "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"primary" } ] }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_RemoveTaxExemption_response":{ "value":{ "customerSegmentList":"Business class Customers", "accountNum":"0.0.0.1-176689", "vatCertificate":"", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+179121" }, { "name":"", "limit":[ { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicCreditFloor":false }, { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+178097" } ], "name":"Comprehensive Bill Structure2", "format":{ "@type":"BillFormat", "name":"Summary Invoice789", "id":"Summary Invoice789", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/Summary Invoice789" }, "cycleSpecification":{ "billingDateShift":3, "paymentDueDateOffset":3, "@type":"BillingCycleSpecification", "name":"", "id":"cycle-spec-id-1", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/cycle-spec-id-1", "frequency":"yearly" }, "id":"comprehensive-billstructure-id2", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" }, { "@type":"BillPresentationMedia", "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373" }, { "@type":"BillPresentationMedia", "name":"presentationMedia-test287", "id":"presentationMedia-test287", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/presentationMedia-test287" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, "serviceBillStructure":[ { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+180145" } ], "name":"Service Bill Structure 178", "format":{ "@type":"BillFormat", "name":"No Invoice", "id":"0.0.0.1+-config-bill_format+182624", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+182624" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-178", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"MIN", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+176241" } ], "name":"Service Bill Structure 278", "format":{ "@type":"BillFormat", "name":"Detailed Invoice", "id":"0.0.0.1+-config-bill_format+183648", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+183648" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-278", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" } ], "accountType":"consumer", "brmAccountType":"standard", "description":"This comprehensive billing account includes all possible fields.", "glSegment":"test", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "partyName":"PartyName101", "id":"9947", "partyId":"PartyId101" }, "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "partyName":"", "id":"9948", "partyId":"" }, "role":"service provider2", "@type":"RelatedPartyRefOrPartyRoleRef" } ], "locale":"en_US", "taxExemption":[ { "reason":"Embassy", "taxDefinition":[ { "Type":"country", "@type":"TaxDefinition", "percent":6 }, { "Type":"city", "@type":"TaxDefinition", "percent":7 } ], "certificateNumber":"6789", "validFor":{ "startDateTime":"2024-07-31T11:30:00.00Z", "endDateTime":"2027-08-06T11:30:00.00Z" }, "@type":"TaxExemptionCertificate", "id":"EXEM02", "issuingJurisdiction":"USA" } ], "contact":[ { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"France", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "geoCode":"IN", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneNumber":"28412", "@type":"PhoneContactMedium", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ], "@type":"Contact", "contactName":"John", "contactType":"primary", "salutation":"" }, { "contactMedium":[ { "country":"India", "stateOrProvince":"IN", "city":"BLR", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneType":"home", "phoneNumber":"890128412", "@type":"PhoneContactMedium", "mediumType":"Phone" } ], "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"secondary", "salutation":"Mr." } ], "name":"Full Home Account", "currencySecondary":"EUR", "currency":"GRD", "state":"active", "id":"billing-account-comprehensive2", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/billing-account-comprehensive2" }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_BillStructurePresentatoinMedia_response":{ "value":{ "customerSegmentList":"Business class Customers", "accountNum":"0.0.0.1-176689", "vatCertificate":"", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+179121" }, { "name":"", "limit":[ { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicCreditFloor":false }, { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+178097" } ], "name":"Comprehensive Bill Structure2", "format":{ "@type":"BillFormat", "name":"Summary Invoice789", "id":"Summary Invoice789", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/Summary Invoice789" }, "cycleSpecification":{ "billingDateShift":3, "paymentDueDateOffset":3, "@type":"BillingCycleSpecification", "name":"", "id":"cycle-spec-id-1", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/cycle-spec-id-1", "frequency":"yearly" }, "id":"comprehensive-billstructure-id2", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" }, { "@type":"BillPresentationMedia", "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373" }, { "@type":"BillPresentationMedia", "name":"Fax", "id":"0.0.0.1+-config-bill_presentation_media+176562", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+176562" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, "serviceBillStructure":[ { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+180145" } ], "name":"Service Bill Structure 178", "format":{ "@type":"BillFormat", "name":"No Invoice", "id":"0.0.0.1+-config-bill_format+182624", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+182624" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-178", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"MIN", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+176241" } ], "name":"Service Bill Structure 278", "format":{ "@type":"BillFormat", "name":"Detailed Invoice", "id":"0.0.0.1+-config-bill_format+183648", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+183648" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-278", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" } ], "accountType":"consumer", "brmAccountType":"standard", "description":"This comprehensive billing account includes all possible fields.", "glSegment":"test", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "partyName":"PartyName101", "id":"9947", "partyId":"PartyId101" }, "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "partyName":"", "id":"9948", "partyId":"" }, "role":"service provider2", "@type":"RelatedPartyRefOrPartyRoleRef" } ], "locale":"en_US", "taxExemption":[ { "reason":"Embassy", "taxDefinition":[ { "Type":"country", "@type":"TaxDefinition", "percent":6 }, { "Type":"city", "@type":"TaxDefinition", "percent":7 } ], "certificateNumber":"6789", "validFor":{ "startDateTime":"2024-07-31T11:30:00.00Z", "endDateTime":"2028-08-06T11:30:00.00Z" }, "@type":"TaxExemptionCertificate", "id":"EXEM02", "issuingJurisdiction":"USA" } ], "contact":[ { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"France", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "geoCode":"IN", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneNumber":"28412", "@type":"PhoneContactMedium", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ], "@type":"Contact", "contactName":"John", "contactType":"primary", "salutation":"" }, { "contactMedium":[ { "country":"India", "stateOrProvince":"IN", "city":"BLR", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneType":"home", "phoneNumber":"890128412", "@type":"PhoneContactMedium", "mediumType":"Phone" } ], "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"secondary", "salutation":"Mr." } ], "name":"Full Home Account", "currencySecondary":"EUR", "currency":"GRD", "state":"active", "id":"billing-account-comprehensive2", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/billing-account-comprehensive2" }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_Add_Account_RelationShip_response":{ "value":{ "customerSegmentList":"", "accountNum":"0.0.0.1-183458", "vatCertificate":"", "@type":"BillingAccount", "billStructure":{ "payType":"subordinate", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+181154" }, { "name":"", "limit":[ { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicCreditFloor":false }, { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+183202" } ], "name":"BI_NAME405", "format":{ "@type":"BillFormat", "name":"Summary Invoice-test-id", "id":"test3", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/test3" }, "cycleSpecification":{ "billingDateShift":3, "paymentDueDateOffset":3, "@type":"BillingCycleSpecification", "name":"", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "frequency":"yearly" }, "id":"child_billunit_id", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" }, { "@type":"BillPresentationMedia", "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, "accountType":"consumer", "brmAccountType":"standard", "accountRelationship":[ { "relationshipType":"AR", "@type":"AccountRelationship", "billStructure":{ "id":"child_billunit_id" }, "account":{ "billStructure":{ "id":"AR_billunit_id" }, "id":"AR_id" } }, { "relationshipType":"Parent", "@type":"AccountRelationship", "billStructure":{ "id":"child_billunit_id" }, "account":{ "billStructure":{ "id":"parent_billunit_id" }, "id":"parent_id" } } ], "description":"This billing account represents the main household billing structure", "glSegment":".", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "partyName":"PartyName101", "id":"9947", "partyId":"PartyId101" }, "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "partyName":"", "id":"9948", "partyId":"" }, "role":"service provider2", "@type":"RelatedPartyRefOrPartyRoleRef" } ], "locale":"en_US", "contact":[ { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"France", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "geoCode":"IN", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneNumber":"28412", "@type":"PhoneContactMedium", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ], "@type":"Contact", "contactName":"child-billunit", "contactType":"primary", "salutation":"" }, { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"Paris", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneType":"home", "phoneNumber":"890128412", "@type":"PhoneContactMedium", "mediumType":"Phone" }, { "phoneType":"home", "phoneNumber":"890128412", "@type":"PhoneContactMedium", "mediumType":"Phone" } ], "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"secondary", "salutation":"" } ], "name":"Home Account", "currencySecondary":"", "currency":"USD", "state":"active", "id":"child_id", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/child_id" }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillingAccount_Update_example_JSON_Patch_AddBillStructure_response":{ "value":{ "customerSegmentList":"Business class Customers", "accountNum":"0.0.0.1-176689", "vatCertificate":"", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+179121" }, { "name":"", "limit":[ { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicCreditFloor":false }, { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+178097" } ], "name":"Comprehensive Bill Structure2", "format":{ "@type":"BillFormat", "name":"Summary Invoice789", "id":"Summary Invoice789", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/Summary Invoice789" }, "cycleSpecification":{ "billingDateShift":3, "paymentDueDateOffset":3, "@type":"BillingCycleSpecification", "name":"", "id":"cycle-spec-id-1", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/cycle-spec-id-1", "frequency":"yearly" }, "id":"comprehensive-billstructure-id2", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" }, { "@type":"BillPresentationMedia", "name":"Electronic", "id":"0.0.0.1+-config-bill_presentation_media+12373", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+12373" }, { "@type":"BillPresentationMedia", "name":"presentationMedia-test287", "id":"presentationMedia-test287", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/presentationMedia-test287" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, "serviceBillStructure":[ { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+180145" } ], "name":"Service Bill Structure 178", "format":{ "@type":"BillFormat", "name":"No Invoice", "id":"0.0.0.1+-config-bill_format+182624", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+182624" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-178", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"MIN", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+176241" } ], "name":"Service Bill Structure 278", "format":{ "@type":"BillFormat", "name":"Detailed Invoice", "id":"0.0.0.1+-config-bill_format+183648", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+183648" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"", "id":"0.0.0.1+-config-bill_cycle_specification+181600", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181600", "frequency":"yearly" }, "id":"service-bill-278", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" } ], "accountType":"consumer", "brmAccountType":"standard", "description":"This comprehensive billing account includes all possible fields.", "glSegment":"test", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name", "partyName":"PartyName101", "id":"9947", "partyId":"PartyId101" }, "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef" }, { "partyOrPartyRole":{ "name":"Related Party Name2", "partyName":"", "id":"9948", "partyId":"" }, "role":"service provider2", "@type":"RelatedPartyRefOrPartyRoleRef" } ], "locale":"en_US", "taxExemption":[ { "reason":"Embassy", "taxDefinition":[ { "Type":"country", "@type":"TaxDefinition", "percent":6 }, { "Type":"city", "@type":"TaxDefinition", "percent":7 } ], "certificateNumber":"6789", "validFor":{ "startDateTime":"2024-07-31T11:30:00.00Z", "endDateTime":"2027-08-06T11:30:00.00Z" }, "@type":"TaxExemptionCertificate", "id":"EXEM02", "issuingJurisdiction":"USA" } ], "contact":[ { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"France", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "geoCode":"IN", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneNumber":"28412", "@type":"PhoneContactMedium", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "mediumType":"Fax", "faxNumber":"141231112" } ], "@type":"Contact", "contactName":"John", "contactType":"primary", "salutation":"" }, { "contactMedium":[ { "country":"India", "stateOrProvince":"IN", "city":"BLR", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "street1":"Rue des Canards test ind", "postCode":"75014", "company":"IN" }, { "emailAddress":"test@oracle.com", "@type":"EmailContactMedium", "mediumType":"Email" }, { "phoneType":"home", "phoneNumber":"890128412", "@type":"PhoneContactMedium", "mediumType":"Phone" } ], "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"secondary", "salutation":"Mr." } ], "name":"Full Home Account", "currencySecondary":"EUR", "currency":"GRD", "state":"active", "id":"billing-account-comprehensive2", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/billing-account-comprehensive2" }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillingAccount_Update_example_Implied_Merge_request":{ "value":{ "@type":"BillingAccount", "name":"Richard Cole Account" }, "description":"Here is an example of a request for updating a BillingAccount." }, "PatchStateForDeletingAccount":{ "value":{ "@type":"BillingAccount", "state":"closed" }, "description":"Example request for updating BillingAccount state to closed." }, "PatchAccountType":{ "value":{ "@type":"BillingAccount", "accountType":"business", "state":"active" }, "description":"Example request for updating BillingAccount accountType and state." }, "PatchAdditionalFields":{ "value":{ "@type":"BillingAccount", "brmAccountType":"brand", "glSegment":"test-patch", "currency":"USD", "currencySecondary":"EUR", "locale":"en_CA" }, "description":"Example request for updating additional BillingAccount attributes." }, "PatchVatCert":{ "value":{ "@type":"BillingAccount", "vatCertificate":"vat-updated" }, "description":"Example request for updating BillingAccount vatCertificate." }, "PatchBillStructure":{ "value":{ "serviceBillStructure":[ { "@type":"BillStructure", "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"YES", "creditLimit":1000 } ] } ], "name":"BI_NAME505", "format":{ "name":"No Invoice" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"Annual billing", "frequency":"yearly" }, "presentationMedia":[ { "name":"Post Mail" } ] }, { "@type":"BillStructure", "balanceGroup":[ { "limit":[ { "unit":"USD", "creditLimit":1000 }, { "unit":"MIN", "creditLimit":10000 } ] } ], "name":"BI_NAME606", "format":{ "name":"Detailed Invoice" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"Annual billing", "frequency":"yearly" }, "presentationMedia":[ { "name":"Post Mail" } ] } ] }, "description":"Example request for updating additional BillingAccount attributes." }, "PatchContactNameAndContactMedium":{ "value":{ "@type":"BillingAccount", "contact":[ { "contactType":"secondary", "contactName":"Rachel MB Douglas", "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "city":"BLR", "country":"India", "postCode":"75013", "street1":"Rue des Canards-patched", "street2":"test ind-patched", "company":"INI", "stateOrProvince":"IND", "geoCode":"INDI" } ] } ] }, "description":"Example request for updating contact name and geographic contact medium." }, "BillingAccount_Update_example_Implied_Merge_response":{ "value":{ "name":"Richard Cole Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"Billing Account", "accountType":"consumer", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-only-mandatory-fields", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/account-with-only-mandatory-fields", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "street1":"Rue des Canards", "postCode":"75014" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Implied_Merge_State_Closed_response":{ "value":{ "name":"Full Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"Billing Account", "accountType":"consumer", "state":"closed", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-only-mandatory-fields", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/account-with-only-mandatory-fields", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "street1":"Rue des Canards", "postCode":"75014" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Implied_Merge_AccountType_business_response":{ "value":{ "name":"Full Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":".", "description":"Billing Account", "accountType":"business", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-only-mandatory-fields", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/account-with-only-mandatory-fields", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"standard", "currencySecondary":"", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "street1":"Rue des Canards", "postCode":"75014" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Implied_Merge_Extended_Fields_response":{ "value":{ "name":"Full Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":"testPatch", "description":"Billing Account", "accountType":"business", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-only-mandatory-fields", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/account-with-only-mandatory-fields", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"brand", "currencySecondary":"EUR", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"France", "city":"France", "street1":"Rue des Canards", "postCode":"75014" }, { "@type":"EmailContactMedium", "emailAddress":"test@oracle.com", "mediumType":"Email" }, { "@type":"PhoneContactMedium", "phoneNumber":"28412", "mediumType":"Phone" }, { "phoneType":"fax", "@type":"FaxContactMedium", "faxNumber":"141231112", "mediumType":"Fax" } ], "@type":"Contact", "contactType":"primary", "contactName":"John MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_CA", "currency":"USD" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Implied_BillStructure_Fields_response":{ "value":{ "customerSegmentList":"", "accountNum":"0.0.0.1-176592", "vatCertificate":"", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "isDefault":true, "name":"", "limit":[ { "unit":"USD", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+178224" }, { "name":"", "limit":[ { "unit":"CAD", "creditLimit":1000, "creditFloor":-500, "dynamicCreditFloor":false }, { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+177200" } ], "name":"BI_NAME405", "format":{ "@type":"BillFormat", "name":"Summary Invoice-test-id", "id":"test3", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/test3" }, "cycleSpecification":{ "billingDateShift":3, "paymentDueDateOffset":3, "@type":"BillingCycleSpecification", "name":"", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "frequency":"yearly" }, "id":"billing-account-strucuture-post-1", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail-1", "id":"0.0.0.1+-config-bill_presentation_media+176848", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+176848" }, { "@type":"BillPresentationMedia", "name":"Electronic-1", "id":"0.0.0.1+-config-bill_presentation_media+178896", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+178896" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, "serviceBillStructure":[ { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"MIN", "creditLimit":10000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+181042" } ], "name":"BI_NAME606", "format":{ "@type":"BillFormat", "name":"Detailed Invoice", "id":"0.0.0.1+-config-bill_format+183648", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+183648" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"Annual billing", "id":"0.0.0.1+-config-bill_cycle_specification+181202", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181202", "frequency":"yearly" }, "id":"0.0.0.1+-bill_structure+180786", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" }, { "payType":"invoice", "@type":"BillStructure", "billingSegment":"0", "balanceGroup":[ { "name":"", "limit":[ { "unit":"USD", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false }, { "unit":"YES", "creditLimit":1000, "creditFloor":null, "dynamicCreditFloor":false } ], "id":"0.0.0.1+-balance_group+184114" }, { "name":"Default Balance Group", "id":"0.0.0.1+-balance_group+181426" }, { "isDefault":true, "name":"Default Balance Group", "id":"0.0.0.1+-balance_group+183474" } ], "name":"BI_NAME505", "format":{ "@type":"BillFormat", "name":"No Invoice", "id":"0.0.0.1+-config-bill_format+182624", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+182624" }, "cycleSpecification":{ "billingDateShift":4, "@type":"BillingCycleSpecification", "name":"Annual billing", "id":"0.0.0.1+-config-bill_cycle_specification+181202", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/0.0.0.1+-config-bill_cycle_specification+181202", "frequency":"yearly" }, "id":"0.0.0.1+-bill_structure+181554", "presentationMedia":[ { "@type":"BillPresentationMedia", "name":"Post Mail", "id":"0.0.0.1+-config-bill_presentation_media+11150", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/0.0.0.1+-config-bill_presentation_media+11150" } ], "acctSuppressed":false, "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward" } ], "accountType":"business", "brmAccountType":"standard", "description":"This billing account represents the main household billing structure-patched", "glSegment":"test-patch", "relatedParty":[ { "partyOrPartyRole":{ "name":"Related Party Name-patched", "partyName":"PartyName101-patched", "id":"9947", "partyId":"PartyId101" }, "role":"service provider-patched", "@type":"RelatedPartyRefOrPartyRoleRef" } ], "locale":"en_CA", "taxExemption":[ { "reason":"NGO", "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":6 }, { "Type":"state", "@type":"TaxDefinition", "percent":4 } ], "certificateNumber":"12345", "validFor":{ "startDateTime":"2024-08-31T11:30:00.00Z", "endDateTime":"2027-09-06T11:30:00.00Z" }, "@type":"TaxExemptionCertificate", "id":"EXEM01", "issuingJurisdiction":"IND" } ], "contact":[ { "contactMedium":[ { "country":"France", "stateOrProvince":"IN", "city":"France", "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "street1":"Rue des Canards test2 blr", "postCode":"75014", "company":"IN" } ], "@type":"Contact", "contactName":"New nameinfo", "contactType":"secondary", "salutation":"" } ], "name":"Home Account", "currencySecondary":"", "currency":"USD", "state":"active", "id":"billing-account-post-1", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/billing-account-post-1" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Patch_Contact_response":{ "value":{ "name":"Full Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":"testPatch", "description":"Billing Account", "accountType":"business", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"account-with-only-mandatory-fields", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/account-with-only-mandatory-fields", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"brand", "currencySecondary":"EUR", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"India", "city":"BLR", "company":"INI", "stateOrProvince":"IND", "geoCode":"INDI", "street1":"Rue des Canards-patched test ind-patched", "postCode":"75013" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Here is an expanded example of a response for updating a BillingAccount with all common fields." }, "BillingAccount_Update_example_Patch_VatCert_response":{ "value":{ "vatCertificate":"vat-updated", "name":"Full Home Account", "@type":"BillingAccount", "billStructure":{ "payType":"invoice", "name":"Comprehensive Bill Structure", "businessProfileId":"0.0.0.0++0", "actgType":"balance_forward", "billingSegment":"0", "id":"Comprehensice-Bill-Structure", "@type":"BillStructure", "format":{ "name":"Summary Invoice", "id":"summary-invoice", "href":"https://localhost:9998/brm/accountManagement/v5/billFormat/summary-invoice", "@type":"BillFormat" }, "acctSuppressed":false, "cycleSpecification":{ "name":"test4", "id":"test4", "href":"https://localhost:9998/brm/accountManagement/v5/billingCycleSpecification/test4", "@type":"BillingCycleSpecification", "billingDateShift":3, "paymentDueDateOffset":3, "frequency":"yearly" }, "balanceGroup":[ { "id":"0.0.0.1+-balance_group+195759", "name":"", "isDefault":true, "limit":[ { "unit":"USD", "dynamicCreditFloor":false, "creditFloor":null, "creditLimit":10000 } ] } ], "presentationMedia":[ { "name":"Post Mail", "id":"post-mail", "href":"https://localhost:9998/brm/accountManagement/v5/billPresentationMedia/post-mail", "@type":"BillPresentationMedia" } ] }, "glSegment":"testPatch", "description":"Refers to the billing account.", "accountType":"business", "state":"active", "relatedParty":[ { "partyOrPartyRole":{ "id":"9948", "name":"Related Party Name2", "partyName":"partyName-004", "partyId":"partyId-004" }, "@type":"RelatedPartyRefOrPartyRoleRef", "role":"service provider2" } ], "id":"child-id", "href":"https://localhost:9998/brm/accountManagement/v5/billingAccount/child-id", "taxExemption":[ { "issuingJurisdiction":"", "id":"EXEM02", "@type":"TaxExemptionCertificate", "reason":"", "certificateNumber":"1234", "validFor":{ "endDateTime":"1970-01-01T00:00:00.00Z", "startDateTime":"2024-07-31T11:30:00.00Z" }, "taxDefinition":[ { "Type":"federal", "@type":"TaxDefinition", "percent":5 }, { "Type":"state", "@type":"TaxDefinition", "percent":3 } ] } ], "brmAccountType":"brand", "currencySecondary":"EUR", "accountNum":"0.0.0.1-193839", "contact":[ { "contactMedium":[ { "@type":"GeographicAddressContactMedium", "mediumType":"PostalAddress", "country":"India", "city":"BLR", "company":"INI", "stateOrProvince":"IND", "geoCode":"INDI", "street1":"Rue des Canards-patched test ind-patched", "postCode":"75013" } ], "@type":"Contact", "contactType":"secondary", "contactName":"Rachel MB Douglas", "salutation":"" } ], "customerSegmentList":"", "locale":"en_US", "currency":"USD" }, "description":"Contains an expanded example response for updating a BillingAccount, including all common fields." }, "BillingAccount_Update_example_Patch_Merge_request":{ "value":{ "@type":"BillingAccount", "name":"Richard Cole Account" }, "description":"Here is an example of a request for updating a BillingAccount." }, "BillingAccount_Update_example_Patch_Merge_response":{ "value":{ "@type":"BillingAccount", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/5430", "id":"5430", "name":"Richard Cole Account", "relatedParty":[ { "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "id":"6838", "href":"https://host:port/tmf-api/partyManagement/v5/organization/6838", "name":"Richard Cole" } } ] }, "description":"Here is an example of a response for updating a BillingAccount." }, "BillFormat_update_example_Patch_Merge_request":{ "value":{ "@type":"BillFormat", "description":"Detailed billing that contains full phone numbers for calls." }, "description":"Provides an example request for updating a BillFormat with a merge patch." }, "BillFormat_update_example_Patch_Merge_response":{ "value":{ "description":"Detailed billing that contains full phone numbers for calls.", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" }, "description":"Here is an example of a response for updating a BillFormat." }, "BillFormat_update_example_Implied_Merge_request":{ "value":{ "@type":"BillFormat", "description":"Detailed billing that contains full phone numbers for calls." }, "description":"Provides an example request for updating a BillFormat with a merge patch." }, "BillFormat_update_example_Implied_Merge_response":{ "value":{ "description":"Detailed billing that contains full phone numbers for calls.", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" }, "description":"Here is an example of a response for updating a BillFormat." }, "BillFormat_update_example_JSON_Patch_request":{ "value":{ "path":"/description", "value":"Detailed billing containing full phone numbers of calls", "op":"replace" }, "description":"Provides an example request for updating a BillFormat with a JSON Patch." }, "BillFormat_update_example_JSON_Patch_response":{ "value":{ "description":"Detailed billing that contains full phone numbers for calls.", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" }, "description":"Here is an example of a response for updating a BillFormat." }, "PatchBillFormat_update_example_JSON_request":{ "value":{ "description":"Provides a patching example." }, "description":"Provides a BillFormat patch request example." }, "PatchBillFormat_update_example_JSON_response":{ "value":{ "id":"post-mail-id-test-3-1", "href":"https://host:port/brm/accountManagement/v5/billFormat/post-mail-id-test-3-1", "@type":"BillFormat", "name":"Post Mail-1-test-3-1", "description":"Provides a patching example." }, "description":"Describes the BillFormat patch response." }, "BillPresentationMedia_update_example_Patch_Merge_request":{ "value":{ "@type":"BillPresentationMedia", "description":"This bill presentation media is electronic." }, "description":"Provides an example request for updating a BillPresentationMedia with a merge patch." }, "BillPresentationMedia_update_example_Patch_Merge_response":{ "value":{ "description":"This bill presentation media is electronic.", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/4506", "id":"4506", "name":"Electronic" }, "description":"Here is an example of a response for updating a BillPresentationMedia." }, "BillPresentationMedia_update_example_Implied_Merge_request":{ "value":{ "@type":"BillPresentationMedia", "description":"This bill presentation media is electronic." }, "description":"Provides an example request for updating a BillPresentationMedia with a merge patch." }, "BillPresentationMedia_update_example_Implied_Merge_response":{ "value":{ "description":"This bill presentation media is electronic.", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/4506", "id":"4506", "name":"Electronic" }, "description":"Here is an example of a response for updating a BillPresentationMedia." }, "BillPresentationMedia_update_example_JSON_Patch_request":{ "value":{ "path":"/description", "value":"This bill presentation media is electronic.", "op":"replace" }, "description":"Provides an example request for updating a BillPresentationMedia with a JSON Patch." }, "BillPresentationMedia_update_example_JSON_Patch_response":{ "value":{ "description":"This bill presentation media is electronic.", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/4506", "id":"4506", "name":"Electronic" }, "description":"Here is an example of a response for updating a BillPresentationMedia." }, "PatchBillPresentationMedia_update_example_JSON_request":{ "value":{ "description":"Provides a patching example." }, "description":"Provides a BillPresentationMedia patch request example." }, "PatchBillPresentationMedia_update_example_JSON_response":{ "value":{ "id":"post-mail-id-test-3-1", "href":"https://host:port/brm/accountManagement/v5/billPresentationMedia/post-mail-id-test-3-1", "@type":"BillPresentationMedia", "name":"Post Mail-1-test-3-1", "description":"Provides a patching example." }, "description":"Describes the BillPresentationMedia patch response." }, "BillingCycleSpecification_update_example_Patch_Merge_request":{ "value":{ "@type":"BillingCycleSpecification", "mailingDateOffset":30 }, "description":"Provides an example request for updating a BillingCycleSpecification with a merge patch." }, "BillingCycleSpecification_update_example_Patch_Merge_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":20, "billingPeriod":"monthly", "chargeDateOffset":10, "creditDateOffset":15, "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":30, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2025-01-10T00:00:00.000Z" } }, "description":"Here is an example of a response for updating a BillingCycleSpecification." }, "BillingCycleSpecification_update_example_Implied_Merge_request":{ "value":{ "@type":"BillingCycleSpecification", "mailingDateOffset":30 }, "description":"Provides an example request for updating a BillingCycleSpecification with a merge patch." }, "BillingCycleSpecification_update_example_Implied_Merge_Oracle_request":{ "value":{ "@type":"BillingCycleSpecification", "billingDateShift":30 }, "description":"Provides an example request for updating a BillingCycleSpecification with a patch." }, "BillingCycleSpecification_update_example_Implied_Merge_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":20, "billingPeriod":"monthly", "chargeDateOffset":10, "creditDateOffset":15, "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":30, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2025-01-10T00:00:00.000Z" } }, "description":"Here is an example of a response for updating a BillingCycleSpecification." }, "BillingCycleSpecification_update_example_Implied_Merge_Oracle_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":20, "billingPeriod":"monthly", "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "name":"Monthly billing", "paymentDueDateOffset":30 }, "description":"Here is an example of a response for updating a BillingCycleSpecification." }, "BillingCycleSpecification_update_example_JSON_Patch_Query_request":{ "value":{ "path":"/mailingDateOffset", "value":30, "op":"replace" }, "description":"Provides an example request for updating a BillingCycleSpecification with a JSON Patch." }, "BillingCycleSpecification_update_example_JSON_Patch_Query_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":20, "billingPeriod":"monthly", "chargeDateOffset":10, "creditDateOffset":15, "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":30, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2025-01-10T00:00:00.000Z" } }, "description":"Here is an example of a response for updating a BillingCycleSpecification." }, "BillingCycleSpecification_update_example_JSON_Patch_request":{ "value":{ "op":"replace", "path":"/billingDateShift?/billingDateShift=20", "value":30 }, "description":"Provides an example request for updating a BillingCycleSpecification with a JSON Patch query." }, "BillingCycleSpecification_update_example_JSON_Patch_response":{ "value":{ "@type":"BillCycleSpecification", "billingDateShift":30, "billingPeriod":"monthly", "chargeDateOffset":10, "creditDateOffset":15, "description":"This billing cycle specification describes the cycle for 20th of the month.", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":30, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2025-01-10T00:00:00.000Z" } }, "description":"Here is an example of a response for updating a BillingCycleSpecification." }, "PatchBillingCycleSpecification_update_example_JSON_request":{ "value":{ "description":"Provides a patching example." }, "description":"Provides a BillingCycleSpecification patch request example." }, "PatchBillingCycleSpecification_update_example_JSON_response":{ "value":{ "id":"post-BCS-id-test-3-1", "href":"https://host:port/brm/accountManagement/v5/billingCycleSpecification/post-BCS-id-test-3-1", "@type":"BillingCycleSpecification", "name":"Post BCS-1-test-3-1", "description":"Provides a patching example.", "billingDateShift":4, "frequency":"yearly", "paymentDueDateOffset":30 }, "description":"Describes the BillingCycleSpecification patch response." }, "CreatePartyAccountEvent_request":{ "value":{ "correlationId":"0510f131-c102", "description":"Illustrates the PartyAccountCreateEvent event.", "domain":"Commercial", "eventId":"46a2-b923-aa337ca92912", "eventTime":"2022-08-25T12:23:44.181Z", "eventType":"PartyAccountCreateEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:37.884Z", "title":"PartyAccountCreateEvent", "event":{ "partyAccount":{ "@type":"PartyAccount", "creditLimit":{ "unit":"USD", "value":20000 }, "description":"This party account ...", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458", "lastModified":"2018-06-14T00:00:00.000Z", "name":"Travel account", "state":"Suspended", "accountType":"Business", "paymentStatus":"In Arrears", "billStructure":{ "@type":"BillStructure", "presentationMedia":[ { "@type":"BillPresentationMedia", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/8800", "id":"8800", "name":"Electronic" } ], "format":{ "@type":"BillFormat", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/4824", "id":"4824", "name":"Summary invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "dateShift":8, "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/1309", "id":"1309", "name":"Monthly billing" } }, "paymentPlan":[ { "@type":"PaymentPlan", "numberOfPayments":12, "paymentFrequency":"monthly", "priority":2, "status":"Ineffective", "totalAmount":{ "unit":"USD", "value":100 }, "planType":"regular", "validFor":{ "startDateTime":"2018-06-17T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "paymentMethod":{ "@type":"PaymentMethodRef", "href":"https://host:port/tmf-api/paymentMethods/v5/paymentMethod/6895", "id":"6895", "name":"family payment" } } ], "relatedParty":[ { "role":"owner", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/party/4665", "id":"4665", "name":"John Doe Ltd" } } ], "taxExemption":[ { "@type":"TaxExemption", "certificateNumber":"45678889876", "issuingJurisdiction":"USA", "reason":"Embassy", "taxDefinition":[ { "@type":"TaxDefinition", "id":"96", "name":"Value Added Tax", "taxType":"federalVat" } ], "attachment":{ "@type":"Attachment", "id":"654321234334534552", "href":"https://host:port/tmf-api/document/v5/attachment/654321234334534552", "attachmentType":"taxExemptionCertificate", "name":"TaxExemptionCertificate-654321.pdf", "description":"Electronic version of the tax exemption certificate", "mimeType":"application/pdf", "url":"http://host:port/DocumentManager/666/TaxExemptionCertificate-654321.pdf" }, "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "contact":[ { "@type":"Contact", "contactName":"Anna Cristal", "contactType":"primary", "partyRoleType":"Publisher", "validFor":{ "startDateTime":"2018-06-11T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "contactMedium":[ { "@type":"GeographicAddressContactMedium", "preferred":false, "mediumType":"PostalAddress", "validFor":{ "startDateTime":"2018-06-14T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "city":"Paris", "country":"France", "postCode":"75014", "street1":"15 Rue des Canards" } ], "relatedParty":{ "role":"owner", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@referredType":"Individual", "@type":"PartyRefOrPartyRoleRef", "href":"https://host:port/tmf-api/partyManagement/v5/party/2186", "id":"2186", "name":"Gustave Flaubert" } } } ], "accountBalance":[ { "@type":"AccountBalance", "amount":{ "unit":"USD", "value":53.29 }, "balanceType":"DepositBalance", "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "accountRelationship":[ { "@type":"AccountRelationship", "relationshipType":"contains", "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "account":{ "@referredType":"BillingAccount", "@type":"AccountRef", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/9522", "id":"9522", "name":"Travel Account" } } ] } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"PartyAccountCreateEvent" }, "description":"Provides a message example for the PartyAccountCreateEvent event." }, "PartyAccountAttributeValueChangeEvent_request":{ "value":{ "correlationId":"95731510-e85e", "description":"Illustrates the PartyAccountAttributeValueChangeEvent event.", "domain":"Commercial", "eventId":"421f-ba83-b5ed387f1100", "eventTime":"2022-08-25T12:23:44.191Z", "eventType":"PartyAccountAttributeValueChangeEvent", "priority":"2", "timeOcurred":"2022-08-25T12:23:40.440Z", "title":"PartyAccountAttributeValueChangeEvent", "event":{ "partyAccount":{ "href":"http://servername/PartyAccount/1041", "id":"1041", "@type":"PartyAccount", "accountBalance":[ { "@type":"AccountBalance", "amount":{ "unit":"USD", "value":50.58 }, "balanceType":"ReceivableBalance", "validFor":{ "startDateTime":"2018-06-15T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ] } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"PartyAccountAttributeValueChangeEvent" }, "description":"Provides a message example for the PartyAccountAttributeValueChangeEvent event." }, "PartyAccountStateChangeEvent_request":{ "value":{ "correlationId":"fe01e099-6931", "description":"Illustrates the PartyAccountStateChangeEvent event.", "domain":"Commercial", "eventId":"463e-90fc-7f2accb4b802", "eventTime":"2022-08-25T12:23:44.202Z", "eventType":"PartyAccountStateChangeEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:40.247Z", "title":"PartyAccountStateChangeEvent", "event":{ "partyAccount":{ "href":"http://servername/PartyAccount/1041", "id":"1041", "@type":"PartyAccount", "state":"Active" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"PartyAccountStateChangeEvent" }, "description":"Provides a message example for the PartyAccountStateChangeEvent event." }, "PartyAccountDeleteEvent_request":{ "value":{ "correlationId":"14094289-0a38", "description":"Illustrates the PartyAccountDeleteEvent event.", "domain":"Commercial", "eventId":"48cb-a41e-943478b26d15", "eventTime":"2022-08-25T12:23:44.212Z", "eventType":"PartyAccountDeleteEvent", "priority":"1", "timeOcurred":"2022-08-25T12:23:35.327Z", "title":"PartyAccountDeleteEvent", "event":{ "partyAccount":{ "@type":"PartyAccount", "href":"https://host:port/tmf-api/accountManagement/v5/partyAccount/4458", "id":"4458" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"PartyAccountDeleteEvent" }, "description":"Provides a message example for the PartyAccountDeleteEvent event." }, "BillingAccountCreateEvent_request":{ "value":{ "correlationId":"0510f131-c102", "description":"Illustrates the BillingAccountCreateEvent event.", "domain":"Commercial", "eventId":"46a2-b923-aa337ca92912", "eventTime":"2022-08-25T12:23:44.181Z", "eventType":"BillingAccountCreateEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:37.884Z", "title":"BillingAccountCreateEvent", "event":{ "billingAccount":{ "@type":"BillingAccount", "paymentStatus":"In Arrears", "creditLimit":{ "unit":"USD", "value":10000 }, "description":"This billing account ...", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/5430", "id":"5430", "lastModified":"2018-06-14T00:00:00.000Z", "name":"Home Account", "state":"Inactive", "accountType":"Business", "billStructure":{ "@type":"BillStructure", "presentationMedia":[ { "@type":"BillPresentationMedia", "href":"https://host:port/tmf-api/accountManagement/v5/billPresentationMedia/9968", "id":"9968", "name":"Post Mail" } ], "format":{ "@type":"BillFormat", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/3555", "id":"3555", "name":"Detailed invoice" }, "cycleSpecification":{ "@type":"BillingCycleSpecification", "dateShift":54, "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/3828", "id":"3828", "name":"Annual billing" } }, "paymentPlan":[ { "@type":"PaymentPlan", "numberOfPayments":4, "paymentFrequency":"monthly", "priority":1, "status":"Effective", "totalAmount":{ "unit":"USD", "value":100 }, "paymentType":"regular", "validFor":{ "startDateTime":"2018-06-11T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "paymentMethod":{ "@type":"PaymentMethodRef", "href":"https://host:port/tmf-api/paymentMethods/v5/paymentMethod/2452", "id":"2452", "name":"professional payment" } } ], "relatedParty":[ { "role":"service provider", "@type":"RelatedPartyRefOrPartyRoleRef", "partyOrPartyRole":{ "@type":"PartyRefOrPartyRoleRef", "@referredType":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/party/6838", "id":"6838", "name":"Richard Cole" } } ], "taxExemption":[ { "@type":"TaxExemption", "id":"1", "certificateNumber":"9665432345", "issuingJurisdiction":"USA", "reason":"Embassy", "taxDefinition":[ { "@type":"TaxDefinition", "id":"96", "name":"Value Added Tax", "taxType":"federalVat" } ], "attachment":{ "@type":"Attachment", "id":"88888834534552", "href":"https://host:port/tmf-api/document/v5/attachment/88888834534552", "attachmentType":"taxExemptionCertificate", "name":"TaxExemptionCertificate-888.pdf", "description":"Electronic version of the tax exemption certificate", "mimeType":"application/pdf", "url":"http://host:port/DocumentManager/666/TaxExemptionCertificate-888.pdf" }, "validFor":{ "startDateTime":"2018-06-17T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "contact":[ { "@type":"Contact", "contactName":"Rachel Douglas", "contactType":"secondary", "partyRoleType":"Vendor", "validFor":{ "startDateTime":"2018-06-17T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "contactMedium":[ { "@type":"GeographicAddressContactMedium", "preferred":true, "mediumType":"PostalAddress", "validFor":{ "startDateTime":"2018-06-14T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "city":"Paris", "country":"France", "postCode":"75014", "street1":"15 Rue des Canards" } ], "relatedParty":{ "@type":"Organization", "href":"https://host:port/tmf-api/partyManagement/v5/party/9947", "id":"9947", "name":"Richard Cole", "role":"owner" } } ], "accountBalance":[ { "@type":"AccountBalance", "amount":{ "unit":"USD", "value":58.33 }, "balanceType":"ReceivableBalance", "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ], "accountRelationship":[ { "@type":"AccountRelationship", "relationshipType":"contains", "validFor":{ "startDateTime":"2018-06-13T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" }, "account":{ "@referredType":"BillingAccount", "@type":"AccountRef", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/9327", "id":"9327", "name":"Paradise Account" } } ] } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingAccountCreateEvent" }, "description":"Provides a message example for the BillingAccountCreateEvent event." }, "BillingAccountAttributeValueChangeEvent_request":{ "value":{ "correlationId":"95731510-e85e", "description":"Illustrates the BillingAccountAttributeValueChangeEvent event.", "domain":"Commercial", "eventId":"421f-ba83-b5ed387f1100", "eventTime":"2022-08-25T12:23:44.191Z", "eventType":"BillingAccountAttributeValueChangeEvent", "priority":"2", "timeOcurred":"2022-08-25T12:23:40.440Z", "title":"BillingAccountAttributeValueChangeEvent", "event":{ "billingAccount":{ "href":"http://servername/BillingAccount/1041", "id":"1041", "@type":"BillingAccount", "accountBalance":[ { "@type":"AccountBalance", "amount":{ "unit":"USD", "value":50.58 }, "balanceType":"ReceivableBalance", "validFor":{ "startDateTime":"2018-06-15T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } ] } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingAccountAttributeValueChangeEvent" }, "description":"Provides a message example for the BillingAccountAttributeValueChangeEvent event." }, "BillingAccountStateChangeEvent_request":{ "value":{ "correlationId":"fe01e099-6931", "description":"Illustrates the BillingAccountStateChangeEvent event.", "domain":"Commercial", "eventId":"463e-90fc-7f2accb4b802", "eventTime":"2022-08-25T12:23:44.202Z", "eventType":"BillingAccountStateChangeEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:40.247Z", "title":"BillingAccountStateChangeEvent", "event":{ "billingAccount":{ "href":"http://servername/BillingAccount/1041", "id":"1041", "@type":"BillingAccount", "state":"Active" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingAccountStateChangeEvent" }, "description":"Provides a message example for the BillingAccountStateChangeEvent event." }, "BillingAccountDeleteEvent_request":{ "value":{ "correlationId":"14094289-0a38", "description":"Illustrates the BillingAccountDeleteEvent event.", "domain":"Commercial", "eventId":"48cb-a41e-943478b26d15", "eventTime":"2022-08-25T12:23:44.212Z", "eventType":"BillingAccountDeleteEvent", "priority":"1", "timeOcurred":"2022-08-25T12:23:35.327Z", "title":"BillingAccountDeleteEvent", "event":{ "billingAccount":{ "@type":"BillingAccount", "href":"https://host:port/tmf-api/accountManagement/v5/billingAccount/5430", "id":"5430" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingAccountDeleteEvent" }, "description":"Provides a message example for the BillingAccountDeleteEvent event." }, "CreateBillFormatEvent_request":{ "value":{ "correlationId":"0510f131-c102", "description":"Illustrates the BillFormatCreateEvent event.", "domain":"Commercial", "eventId":"46a2-b923-aa337ca92912", "eventTime":"2022-08-25T12:23:44.181Z", "eventType":"BillFormatCreateEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:37.884Z", "title":"billFormatCreateEvent", "event":{ "billFormat":{ "@type":"BillFormat", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillFormatCreateEvent" }, "description":"Provides a message example for the BillFormatCreateEvent event." }, "BillFormatAttributeValueChangeEvent_request":{ "value":{ "correlationId":"95731510-e85e", "description":"Illustrates the BillFormatAttributeValueChangeEvent event.", "domain":"Commercial", "eventId":"421f-ba83-b5ed387f1100", "eventTime":"2022-08-25T12:23:44.191Z", "eventType":"BillFormatAttributeValueChangeEvent", "priority":"2", "timeOcurred":"2022-08-25T12:23:40.440Z", "title":"BillFormatAttributeValueChangeEvent", "event":{ "billFormat":{ "@type":"BillFormat", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillFormatAttributeValueChangeEvent" }, "description":"Provides a message example for the BillFormatAttributeValueChangeEvent event." }, "BillFormatStateChangeEvent_request":{ "value":{ "correlationId":"fe01e099-6931", "description":"Illustrates the BillFormatStateChangeEvent event.", "domain":"Commercial", "eventId":"463e-90fc-7f2accb4b802", "eventTime":"2022-08-25T12:23:44.202Z", "eventType":"BillFormatStateChangeEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:40.247Z", "title":"BillFormatStateChangeEvent", "event":{ "billFormat":{ "@type":"BillFormat", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillFormatStateChangeEvent" }, "description":"Provides a message example for the BillFormatStateChangeEvent event." }, "BillFormatDeleteEvent_request":{ "value":{ "correlationId":"14094289-0a38", "description":"Illustrates the BillFormatDeleteEvent event.", "domain":"Commercial", "eventId":"48cb-a41e-943478b26d15", "eventTime":"2022-08-25T12:23:44.212Z", "eventType":"BillFormatDeleteEvent", "priority":"1", "timeOcurred":"2022-08-25T12:23:35.327Z", "title":"BillFormatDeleteEvent", "event":{ "billFormat":{ "@type":"BillFormat", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/billFormat/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillFormatDeleteEvent" }, "description":"Provides a message example for the BillFormatDeleteEvent event." }, "CreateBillPresentationMediaEvent_request":{ "value":{ "correlationId":"0510f131-c102", "description":"Illustrates the BillPresentationMediaCreateEvent event.", "domain":"Commercial", "eventId":"46a2-b923-aa337ca92912", "eventTime":"2022-08-25T12:23:44.181Z", "eventType":"BillPresentationMediaCreateEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:37.884Z", "title":"BillPresentationMediaCreateEvent", "event":{ "billPresentationMedia":{ "@type":"BillPresentationMedia", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/BillPresentationMedia/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillPresentationMediaCreateEvent" }, "description":"Provides a message example for the BillPresentationMediaCreateEvent event." }, "BillPresentationMediaAttributeValueChangeEvent_request":{ "value":{ "correlationId":"95731510-e85e", "description":"Illustrates the BillPresentationMediaAttributeValueChangeEvent event.", "domain":"Commercial", "eventId":"421f-ba83-b5ed387f1100", "eventTime":"2022-08-25T12:23:44.191Z", "eventType":"BillPresentationMediaAttributeValueChangeEvent", "priority":"2", "timeOcurred":"2022-08-25T12:23:40.440Z", "title":"BillPresentationMediaAttributeValueChangeEvent", "event":{ "billPresentationMedia":{ "@type":"BillPresentationMedia", "href":"https://host:port/tmf-api/accountManagement/v5/BillPresentationMedia/8718", "id":"8718", "name":"Formatted e-paper" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillPresentationMediaAttributeValueChangeEvent" }, "description":"Provides a message example for the BillPresentationMediaAttributeValueChangeEvent event." }, "BillPresentationMediaStateChangeEvent_request":{ "value":{ "correlationId":"fe01e099-6931", "description":"Illustrates the BillPresentationMediaStateChangeEvent event.", "domain":"Commercial", "eventId":"463e-90fc-7f2accb4b802", "eventTime":"2022-08-25T12:23:44.202Z", "eventType":"BillPresentationMediaStateChangeEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:40.247Z", "title":"BillPresentationMediaStateChangeEvent", "event":{ "billPresentationMedia":{ "@type":"BillPresentationMedia", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/BillPresentationMedia/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillPresentationMediaStateChangeEvent" }, "description":"Provides a message example for the BillPresentationMediaStateChangeEvent event." }, "BillPresentationMediaDeleteEvent_request":{ "value":{ "correlationId":"14094289-0a38", "description":"Illustrates the BillPresentationMediaDeleteEvent event.", "domain":"Commercial", "eventId":"48cb-a41e-943478b26d15", "eventTime":"2022-08-25T12:23:44.212Z", "eventType":"BillPresentationMediaDeleteEvent", "priority":"1", "timeOcurred":"2022-08-25T12:23:35.327Z", "title":"BillPresentationMediaDeleteEvent", "event":{ "billPresentationMedia":{ "@type":"BillPresentationMedia", "description":"This bill format ...", "href":"https://host:port/tmf-api/accountManagement/v5/BillPresentationMedia/8718", "id":"8718", "name":"Detailed invoice" } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillPresentationMediaDeleteEvent" }, "description":"Provides a message example for the BillPresentationMediaDeleteEvent event." }, "CreateBillingCycleSpecificationEvent_request":{ "value":{ "correlationId":"0510f131-c102", "description":"Illustrates the BillingCycleSpecificationCreateEvent event.", "domain":"Commercial", "eventId":"46a2-b923-aa337ca92912", "eventTime":"2022-08-25T12:23:44.181Z", "eventType":"BillingCycleSpecificationCreateEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:37.884Z", "title":"BillingCycleSpecificationCreateEvent", "event":{ "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":20, "chargeDateOffset":5, "creditDateOffset":5, "description":"This billing cycle specification ...", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":25, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingCycleSpecificationCreateEvent" }, "description":"Provides a message example for the BillingCycleSpecificationCreateEvent event." }, "BillingCycleSpecificationAttributeValueChangeEvent_request":{ "value":{ "correlationId":"95731510-e85e", "description":"Illustrates the BillingCycleSpecificationAttributeValueChangeEvent event.", "domain":"Commercial", "eventId":"421f-ba83-b5ed387f1100", "eventTime":"2022-08-25T12:23:44.191Z", "eventType":"BillingCycleSpecificationAttributeValueChangeEvent", "priority":"2", "timeOcurred":"2022-08-25T12:23:40.440Z", "title":"BillingCycleSpecificationAttributeValueChangeEvent", "event":{ "billingCycleSpecification":{ "href":"http://servername/BillingCycleSpecification/1041", "id":"1041", "@type":"BillingCycleSpecification", "chargeDateOffset":5 } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingCycleSpecificationAttributeValueChangeEvent" }, "description":"Provides a message example for the BillingCycleSpecificationAttributeValueChangeEvent event." }, "BillingCycleSpecificationStateChangeEvent_request":{ "value":{ "correlationId":"fe01e099-6931", "description":"Illustrates the BillingCycleSpecificationStateChangeEvent event.", "domain":"Commercial", "eventId":"463e-90fc-7f2accb4b802", "eventTime":"2022-08-25T12:23:44.202Z", "eventType":"BillingCycleSpecificationStateChangeEvent", "priority":"5", "timeOcurred":"2022-08-25T12:23:40.247Z", "title":"BillingCycleSpecificationStateChangeEvent", "event":{ "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":20, "chargeDateOffset":5, "creditDateOffset":5, "description":"This billing cycle specification ...", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":25, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingCycleSpecificationStateChangeEvent" }, "description":"Provides a message example for the BillingCycleSpecificationStateChangeEvent event." }, "BillingCycleSpecificationDeleteEvent_request":{ "value":{ "correlationId":"14094289-0a38", "description":"Illustrates the BillingCycleSpecificationDeleteEvent event.", "domain":"Commercial", "eventId":"48cb-a41e-943478b26d15", "eventTime":"2022-08-25T12:23:44.212Z", "eventType":"BillingCycleSpecificationDeleteEvent", "priority":"1", "timeOcurred":"2022-08-25T12:23:35.327Z", "title":"BillingCycleSpecificationDeleteEvent", "event":{ "billingCycleSpecification":{ "@type":"BillingCycleSpecification", "billingDateShift":20, "chargeDateOffset":5, "creditDateOffset":5, "description":"This billing cycle specification ...", "frequency":"monthly", "href":"https://host:port/tmf-api/accountManagement/v5/billingCycleSpecification/4556", "id":"4556", "mailingDateOffset":25, "name":"Monthly billing", "paymentDueDateOffset":30, "validFor":{ "startDateTime":"2018-06-10T00:00:00.000Z", "endDateTime":"2019-01-10T00:00:00.000Z" } } }, "reportingSystem":{ "id":"855", "name":"APP-400", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"92", "name":"APP-105", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"BillingCycleSpecificationDeleteEvent" }, "description":"Provides a message example for the BillingCycleSpecificationDeleteEvent event." }, "RetrieveProduct1_response":{ "value":{ "isBundle":false, "name":"Voice Over IP ", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+43282", "name":"Product 1a - Internet Access", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginBase1", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"99689356471", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"serviceIpFlatIMEI", "@type":"StringCharacteristic" } ], "gracePeriod":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+180643", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+180643", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+180899", "@type":"RealizingService" } ], "cycleStartDate":"2018-01-01T08:00:00.00Z", "usageStartDate":"2018-01-01T08:00:00.00Z", "purchaseStartDate":"2018-01-01T08:00:00.00Z", "cycleEndDate":"2020-01-01T08:00:00.00Z", "usageEndDate":"2020-01-01T08:00:00.00Z", "purchaseEndDate":"2020-01-01T08:00:00.00Z", "startDate":"2018-01-01T08:00:00.00Z" }, "description":"GET Product By Id." }, "RetrieveProductSpecialRating_response":{ "value":{ "isBundle":false, "name":"Voice Over IP ", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "gracePeriod":{ "unit":"days", "amount":1 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "specialRatingProfile":{ "id":"0.0.0.1+-profile-serv_extrating+738476", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy", "value":"0039335873473632", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z", "endDateTime":"2026-05-01T00:00:00Z" } } ] }, "cycleStartDate":"2018-01-01T08:00:00.00Z", "usageStartDate":"2018-01-01T08:00:00.00Z", "purchaseStartDate":"2018-01-01T08:00:00.00Z", "cycleEndDate":"2020-01-01T08:00:00.00Z", "usageEndDate":"2020-01-01T08:00:00.00Z", "purchaseEndDate":"2020-01-01T08:00:00.00Z", "startDate":"2018-01-01T08:00:00.00Z" }, "description":"GET Product By Id with special rating profile." }, "RetrieveProductByList_response":{ "value":[ { "isBundle":false, "name":"Voice Over IP ", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+43282", "name":"Product 1a - Internet Access", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginBase_009oke", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"99689356471", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"serviceIpFlatIMEI", "@type":"StringCharacteristic" } ], "gracePeriod":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+180643", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+180643", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+180899", "@type":"RealizingService" } ], "cycleStartDate":"2018-01-01T08:00:00.00Z", "usageStartDate":"2018-01-01T08:00:00.00Z", "purchaseStartDate":"2018-01-01T08:00:00.00Z", "cycleEndDate":"2020-01-01T08:00:00.00Z", "usageEndDate":"2020-01-01T08:00:00.00Z", "purchaseEndDate":"2020-01-01T08:00:00.00Z", "startDate":"2018-01-01T08:00:00.00Z" }, { "isBundle":true, "name":"Voice Over IP", "@type":"Product", "product":[ { "isBundle":false, "name":"Voice Over IP", "@type":"Product", "description":"DBE Product Specification instance", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+181375", "name":"Teen Telephony C4B", "@type":"ProductOffering" }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+183811", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+183811", "status":"cancelled", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+186624", "@type":"RealizingService" } ], "cycleStartDate":"2018-01-01T08:00:00.00Z", "usageStartDate":"2018-01-01T08:00:00.00Z", "purchaseStartDate":"2018-01-01T08:00:00.00Z", "cycleEndDate":"2020-01-01T08:00:00.00Z", "usageEndDate":"2020-01-01T08:00:00.00Z", "purchaseEndDate":"2020-01-01T08:00:00.00Z", "startDate":"2018-01-01T08:00:00.00Z" } ], "description":"DBE Product Specification instance", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+181375", "name":"Teen Telephony C4B", "@type":"ProductOffering" }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+180739", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+180739", "status":"cancelled", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+186624", "@type":"RealizingService" } ], "cycleStartDate":"2018-01-01T08:00:00.00Z", "usageStartDate":"2018-01-01T08:00:00.00Z", "purchaseStartDate":"2018-01-01T08:00:00.00Z", "cycleEndDate":"2020-01-01T08:00:00.00Z", "usageEndDate":"2020-01-01T08:00:00.00Z", "purchaseEndDate":"2020-01-01T08:00:00.00Z", "startDate":"2018-01-01T08:00:00.00Z" } ], "description":"A collection of Product representation retrieved using GET API." }, "RetrieveProductByListwithFieldsSelection_response":{ "value":[ { "isBundle":false, "id":"0.0.0.1+-purchased_product+180643", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+180643", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+180899", "@type":"RealizingService" } ] }, { "isBundle":true, "id":"0.0.0.1+-purchased_product+180739", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+180739", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+185566", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+186624", "@type":"RealizingService" } ] } ], "description":"A collection of Product representation with filter selection" }, "CreateProductNonTelco_request":{ "value":{ "isBundle":false, "name":"Voice Over IP12", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "name":"Product 1a - Internet Access", "id":"0.0.0.1+-product+43224", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"ServiceLoginIp_0001", "@type":"StringCharacteristic" } ], "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+234210", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+0", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Basic non telco product creation payload." }, "CreateProductNonTelco_response":{ "value":{ "isBundle":false, "name":"Voice Over IP12", "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+43224", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"ServiceLoginIp_0001", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "status":"active", "quantity":1, "id":"0.0.0.1+-purchased_product+321901", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+321901", "billingAccount":{ "id":"0.0.0.1+-account+234210", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+181092", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"absolute", "amount":0 } }, "description":"Basic non telco product creation response payload." }, "CreateProductTelco_request":{ "value":{ "isBundle":true, "name":"Voice Over IP12", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "name":"Teen Telephony C4B0", "id":"0.0.0.1+-product+193461", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "name":"MSISDN", "valueType":"string", "value":"ServiceAliasMSISDNProductPrice_0001sm", "@type":"StringCharacteristic" }, { "name":"IMEI", "valueType":"string", "value":"ServiceAliasIMEIProductPrice_0001si", "@type":"StringCharacteristic" } ], "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+0", "@type":"RealizingService" } ], "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":29.99, "unit":"USD" } } }, { "@type":"PriceAlteration", "priceType":"DiscountPercentageOverride", "price":{ "@type":"Price", "percentage":60 } } ] } ], "productRelationship":{ "id":"0.0.0.1+-purchased_product+236687", "relationshipType":"bundles" }, "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Telco product creation payload with productPrice and productRelationship." }, "CreateProductTelco_response":{ "value":{ "isBundle":true, "name":"Voice Over IP12", "productRelationship":{ "id":"0.0.0.1+-purchased_product+236687", "relationshipType":"bundles" }, "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "product":[ { "isBundle":false, "name":"Voice Over IP12", "productRelationship":{ "id":"0.0.0.1+-purchased_product+237749", "relationshipType":"bundledBy" }, "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+48958", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"ServiceLoginIp_0001s", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+236687", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+236687", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+237327", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"absolute", "amount":0 } } ], "purchaseStart":{ "unit":"absolute", "amount":0 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+193461", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"ServiceAliasMSISDNProductPrice_0001sm", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"ServiceAliasIMEIProductPrice_0001si", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "dutyFreeAmount":{ "unit":"USD", "value":"29.99" }, "@type":"Price" } }, { "@type":"PriceAlteration", "priceType":"DiscountPercentageOverride", "price":{ "percentage":"60.0" } } ] } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+237749", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+237749", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+238389", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"absolute", "amount":0 } }, "description":"Telco product creation response payload with productPrice and productRelationship." }, "CreateProductBundle_request":{ "value":{ "isBundle":true, "name":"Voice Over IP", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "name":"Product 1a - Internet Access", "id":"0.0.0.1+-product+48958", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"BaseServiceLoginIp_0001s", "@type":"StringCharacteristic" } ], "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+0", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "product":[ { "isBundle":false, "name":"Voice Over IP12", "@type":"Product", "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "name":"Teen Telephony C4B0", "id":"0.0.0.1+-product+193461", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "name":"MSISDN", "valueType":"string", "value":"ServiceAliasMSISDN_0001sm", "@type":"StringCharacteristic" }, { "name":"IMEI", "valueType":"string", "value":"BundledServiceAliasIMEI_0001si", "@type":"StringCharacteristic" } ], "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+0", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z" } ] }, "description":"Product creation with bundled request payload." }, "CreateProductBundle_response":{ "value":{ "isBundle":true, "name":"Voice Over IP", "productRelationship":{ "id":"0.0.0.1+-purchased_product+240599", "relationshipType":"bundles" }, "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "product":[ { "isBundle":false, "name":"Voice Over IP12", "productRelationship":{ "id":"0.0.0.1+-purchased_product+238039", "relationshipType":"bundledBy" }, "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+193461", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"ServiceAliasMSISDN_0001sm", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"BundledServiceAliasIMEI_0001si", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+240599", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+240599", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+238295", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"absolute", "amount":0 } } ], "purchaseStart":{ "unit":"absolute", "amount":0 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "id":"0.0.0.1+-product+48958", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"BaseServiceLoginIp_0001s", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+238039", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+238039", "status":"active", "quantity":1, "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+241495", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"absolute", "amount":0 } }, "description":"Product creation with bundled fields response payload." }, "CreateProduct_ProductOracle_request_With_ERA":{ "value":{ "isBundle":false, "name":"Voice Over IP ", "@type":"Product", "description":"Test description", "id":"Product_GSM_Telephony", "terminationDate":"2020-01-01T08:00:00.00Z", "productOffering":{ "name":"Standard GSM Telephony", "id":"Product_GSM", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI", "@type":"StringCharacteristic" } ], "quantity":1, "cycleStart":{ "amount":5, "unit":"days" }, "usageStart":{ "amount":5, "unit":"days" }, "purchaseStart":{ "amount":5, "unit":"days" }, "cycleEnd":{ "amount":1, "unit":"months" }, "usageEnd":{ "amount":1, "unit":"months" }, "purchaseEnd":{ "amount":1, "unit":"months" }, "gracePeriod":{ "amount":1, "unit":"days" }, "status":"active", "billingAccount":{ "name":"Junior Walter", "id":"Account01", "@type":"BillingAccount" }, "specialRatingProfile":{ "id":"88-1ZVHQ4", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy", "value":"0039335873473632", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z", "endDateTime":"2026-05-01T00:00:00Z" } } ] }, "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Product creation with extended fields request payload." }, "CreateProduct_ProductOracle_response_With_ERA":{ "value":{ "isBundle":false, "name":"Voice Over IP ", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"Product_GSM", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "id":"Product_GSM_Telephony", "href":"https://host:port/brm/productInventory/v5/product/Product_GSM_Telephony", "status":"active", "billingAccount":{ "id":"Account01", "name":"Junior Walter", "@type":"BillingAccount" }, "specialRatingProfile":{ "id":"88-1ZVHQ4", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy", "value":"0039335873473632", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z", "endDateTime":"2026-05-01T00:00:00Z" } } ] }, "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Product creation with extended fields response payload." }, "Product_partialupdate_example_application_json_request":{ "value":{ "name":"Patched Name", "@type":"Product", "description":"Patched Test description", "status":"cancelled", "terminationDate":"2020-01-01T08:00:00.00Z" }, "description":"Partial update patch example." }, "Product_partialupdate_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Partial update patch example response." }, "Product_flattenedServiceAliasUpdate_example_application_json_request":{ "value":{ "productCharacteristic":[ { "id":"", "name":"MSISDN", "valueType":"string", "value":"90121391292", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"IMEI_FlatTelco_2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ] }, "description":"Flattened service update example request." }, "Product_flattenedServiceAliasUpdate_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"90121391292", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"IMEI_FlatTelco_2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":2 }, "cycleEnd":{ "unit":"months", "amount":2 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":2 } }, "description":"Flattened service update example response." }, "Product_nonFlattenedServiceAliasUpdate_example_application_json_request":{ "value":{ "productCharacteristic":[ { "id":"ProductCharacteristicServiceAliasId1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"MSISDNAlias1" } ], "@type":"ArrayCharacteristic" }, { "id":"ProductCharacteristicServiceId1", "name":"Service", "valueType":"object", "value":{ "password":"Cgbu_1234#", "serviceType":"/service/telco/gsm/telephony" }, "@type":"ObjectCharacteristic" } ] }, "description":"Non flattened service example request." }, "Product_nonFlattenedServiceAliasUpdate_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"ProductCharacteristicServiceAliasId1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"MSISDNAlias1" } ], "@type":"ArrayCharacteristic" }, { "id":"ProductCharacteristicServiceId1", "name":"Service", "valueType":"object", "value":{ "password":"Cgbu_1234#", "serviceType":"/service/telco/gsm/telephony" }, "@type":"ObjectCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Non flattened service alias patch example response." }, "Product_productPriceUpdate_example_application_json_request":{ "value":{ "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "dutyFreeAmount":{ "unit":"USD", "value":"15.99" }, "@type":"Price" } }, { "@type":"PriceAlteration", "priceType":"DiscountPercentageOverride", "price":{ "percentage":"70" } } ] } ] }, "description":"Product price patch example request." }, "Product_productPriceUpdate_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "dutyFreeAmount":{ "unit":"USD", "value":"15.99" }, "@type":"Price" } }, { "@type":"PriceAlteration", "priceType":"DiscountPercentageOverride", "price":{ "percentage":"70" } } ] } ], "productCharacteristic":[ { "id":"ProductCharacteristicServiceAliasId_001", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"MSISDNAlias_001" } ], "@type":"ArrayCharacteristic" }, { "id":"ProductCharacteristicServiceId_001", "name":"Service", "valueType":"object", "value":{ "password":"Cgbu_1234#", "serviceType":"/service/telco/gsm/telephony" }, "@type":"ObjectCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Product price patch example response." }, "Product_productRelationshipPatch_example_application_json_request":{ "value":{ "productRelationship":{ "id":"0.0.0.1+-purchased_discount+231021", "relationshipType":"tiedDiscount" } }, "description":"Patch for product relationship." }, "Product_productRelationshipPatch_example_application_json_response":{ "value":{ "productRelationship":{ "id":"0.0.0.1+-purchased_discount+231021", "relationshipType":"tiedDiscount" }, "@type":"Product", "terminationDate":"2020-01-01T08:00:00.00Z", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "status":"active", "id":"0.0.0.1+-purchased_product+231201", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+231201", "billingAccount":{ "id":"0.0.0.1+-account+231921", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+182102", "@type":"RealizingService" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Voice Over IP12", "description":"Test description", "productOffering":{ "name":"Teen Telephony C4B0", "id":"0.0.0.1+-product+43224", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"BaseServiceAliasMSISDNTiedProductwithId_0002", "@type":"StringCharacteristic" }, { "id":"", "name":"IMEI", "valueType":"string", "value":"BaseServiceAliasIMEITiedProductwithId_0002", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-03T08:00:00.00Z" }, "description":"Patch for product relationship." }, "ProductOracle_specialRatingProfileAdd_example_application_json_request":{ "value":{ "specialRatingProfile":{ "id":"SRP_ERA_PREFERRED_CONTACTS_004", "@type":"SpecialRatingProfile", "name":"PREFERRED_CONTACTS", "label":"Preferred contacts for discounted calling", "status":"noop", "referenceCount":1, "data":[ { "name":"preferredNumber", "value":"919845000401", "validFor":{ "startDateTime":"2033-01-01T00:00:00.00Z", "endDateTime":"2033-06-30T23:59:59.00Z" } } ] } }, "description":"Adding a special rating profile with an identifier." }, "ProductOracle_specialRatingProfileAdd_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceId", "valueType":"string", "value":"90121391292", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":2 }, "cycleEnd":{ "unit":"months", "amount":2 }, "id":"ERA_PATCH_ID_001", "href":"https://host:port/brm/productInventory/v5/product/ERA_PATCH_ID_001", "status":"cancelled", "billingAccount":{ "id":"billingAccount001", "name":"Junior Walter", "@type":"BillingAccount" }, "startDate":"2018-01-01T08:00:00.00Z", "specialRatingProfile":{ "id":"SRP_ERA_PREFERRED_CONTACTS_004", "@type":"SpecialRatingProfile", "name":"PREFERRED_CONTACTS", "label":"Preferred contacts for discounted calling", "status":"noop", "referenceCount":1, "data":[ { "name":"preferredNumber", "value":"919845000401", "validFor":{ "startDateTime":"2033-01-01T00:00:00.00Z", "endDateTime":"2033-06-30T23:59:59.00Z" } } ] }, "usageEnd":{ "unit":"months", "amount":2 } }, "description":"Product response after adding a special rating profile with an identifier." }, "ProductOracle_partialupdate_example_application_json_request":{ "value":{ "tieId":"newTieId_001", "cycleStart":{ "amount":10, "unit":"days" }, "usageStart":{ "amount":10, "unit":"days" }, "purchaseStart":{ "amount":10, "unit":"days" }, "cycleEnd":{ "amount":2, "unit":"months" }, "usageEnd":{ "amount":2, "unit":"months" }, "purchaseEnd":{ "amount":2, "unit":"months" } }, "description":"Updating CPU extension dates." }, "ProductOracle_partialupdate_example_application_json_response":{ "value":{ "isBundle":false, "name":"Patched Name", "@type":"Product", "cycleStart":{ "unit":"days", "amount":10 }, "purchaseStart":{ "unit":"days", "amount":10 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":10 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":2 }, "cycleEnd":{ "unit":"months", "amount":2 }, "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "status":"cancelled", "tieId":"newTieId_001", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+230191", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":2 } }, "description":"Partial update CPU Extension response." }, "Product_partialupdate_example_application_merge_patch_json_request":{ "value":{ "name":"Discount Object", "@type":"Product", "description":"Patched Test description", "status":"cancelled", "terminationDate":"2020-01-01T08:00:00.00Z", "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":29.99, "unit":"USD" } } }, { "@type":"PriceAlteration", "name":"Discount Percentage Override", "priceType":"DiscountPercentageOverride", "price":{ "@type":"Price", "percentage":0.6 } } ] } ] }, "description":"Partial update patch example with merge_patch_json." }, "Product_partialupdate_example_application_merge_patch_json_response":{ "value":{ "isBundle":false, "name":"Discount Object", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Patched Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI1", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn1", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice1", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":29.99, "unit":"USD" } } }, { "@type":"PriceAlteration", "name":"Discount Percentage Override", "priceType":"DiscountPercentageOverride", "price":{ "@type":"Price", "percentage":0.6 } } ] } ], "id":"0.0.0.1+-purchased_product+228120", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+228120", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+180912", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Partial update patch example with merge_patch_json response." }, "Product_partialupdate_example_application_json_patch_json_request":{ "value":[ { "op":"add", "path":"$.productPrice", "value":{ "@type":"ProductPrice", "priceType":"recurring", "price":{ "@type":"Price", "dutyFreeAmount":{ "unit":"USD", "value":29.99 } }, "priceAlteration":[ { "@type":"PriceAlteration", "name":"Purchase Override", "priceType":"recurring", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":10, "unit":"USD" } } } ] } } ], "description":"Partial update patch example with json_patch_json." }, "Product_partialupdate_example_application_json_patch_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI2", "@type":"StringCharacteristic" }, { "id":"", "name":"MSISDN", "valueType":"string", "value":"aliasMsisdn2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":29.99, "unit":"USD" } } }, { "@type":"PriceAlteration", "name":"Discount Percentage Override", "priceType":"DiscountPercentageOverride", "price":{ "@type":"Price", "percentage":0.6 } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Partial update patch example with json_patch_json response." }, "Product_partialupdate_productPriceAdd_example_application_json_patch_query_json_request":{ "value":[ { "op":"add", "path":"$.productPrice[?(@.priceType=='recurring')]", "value":{ "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "dutyFreeAmount":null, "unit":"USD", "value":"15.99", "@type":"Price" } } ] } } ], "description":"Addition of product price patch example with json_patch_query_json." }, "Product_partialupdate_productPriceAdd_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":15.99, "unit":"USD" } } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Addition of product price patch example with json_patch_query_json response." }, "Product_partialupdate_productPriceReplace_example_application_json_patch_query_json_request":{ "value":[ { "op":"replace", "path":"$.productPrice[?(@.priceType=='recurring')]", "value":{ "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "priceType":"AmountOverride", "price":{ "dutyFreeAmount":null, "unit":"USD", "value":"20.99", "@type":"Price" } } ] } } ], "description":"Replace of product price patch example with json_patch_query_json." }, "Product_partialupdate_productPriceReplace_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":20.99, "unit":"USD" } } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Replace of product price patch example with json_patch_query_json response." }, "Product_partialupdate_productPriceRemove_example_application_json_patch_query_json_request":{ "value":[ { "op":"remove", "path":"$.productPrice[?(@.priceType=='recurring')]" } ], "description":"Removal of product price patch example with json_patch_query_json." }, "Product_partialupdate_productPriceRemove_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"IMEI", "valueType":"string", "value":"aliasIMEI2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Removal of product price patch example with json_patch_query_json response." }, "Product_partialupdate_productCharacteristicServiceAliasAdd_example_application_json_patch_query_json_request":{ "value":[ { "op":"add", "path":"$.productCharacteristic[?(@.id=='ProductCharArray1' && @.valueType=='array')].value", "value":{ "name":"NewServiceAlias" } } ], "description":"Add of product characteristic service alias patch example with json_patch_query_json." }, "Product_partialupdate_productCharacteristicServiceAliasAdd_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"ProductCharArray1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"productCharAlias1" }, { "name":"productCharAlias1s" }, { "name":"NewServiceAlias" } ], "@type":"ArrayCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":20.99, "unit":"USD" } } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Add of product characteristic service alias patch example with json_patch_query_json." }, "Product_partialupdate_productCharacteristicServiceAliasReplace_example_application_json_patch_query_json_request":{ "value":[ { "op":"replace", "path":"$.productCharacteristic[?(@.name=='ServiceAlias' && @.id=='ProductCharArray1' && @.valueType=='array')].value[?(@.name=='productCharAlias1s')].name", "value":"newServiceAlias_001jpatch" } ], "description":"Replace of product characteristic service alias patch example with json_patch_query_json." }, "Product_partialupdate_productCharacteristicServiceAliasReplace_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"ProductCharArray1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"productCharAlias1" }, { "name":"newServiceAlias_001jpatch" }, { "name":"NewServiceAlias" } ], "@type":"ArrayCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":20.99, "unit":"USD" } } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Replace of product characteristic service alias patch example with json_patch_query_json." }, "Product_partialupdate_productCharacteristicServiceAliasRemove_example_application_json_patch_query_json_request":{ "value":[ { "op":"remove", "path":"$.productCharacteristic[?(@.name=='ServiceAlias' && @.id=='ProductCharacteristicArray1' && @.valueType=='array')].value[?(@.name=='productCharAlias1')].name" } ], "description":"Removal of product characteristic service alias patch example with json_patch_query_json." }, "Product_partialupdate_productCharacteristicServiceAliasRemove_example_application_json_patch_query_json_response":{ "value":{ "isBundle":false, "name":"Voice Over IP", "@type":"Product", "cycleStart":{ "unit":"days", "amount":5 }, "purchaseStart":{ "unit":"days", "amount":5 }, "description":"Test description", "terminationDate":"2020-01-01T08:00:00.00Z", "quantity":1, "productOffering":{ "id":"0.0.0.1+-product+44576", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"ProductCharacteristicArray1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"newServiceAlias_001jpatch" }, { "name":"NewServiceAlias" } ], "@type":"ArrayCharacteristic" }, { "id":"", "name":"ServiceLogin", "valueType":"string", "value":"newLoginCPUProductPrice2", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"Cgbu1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/ip", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"days", "amount":5 }, "gracePeriod":{ "unit":"days", "amount":1 }, "purchaseEnd":{ "unit":"months", "amount":1 }, "cycleEnd":{ "unit":"months", "amount":1 }, "productPrice":[ { "@type":"ProductPrice", "priceType":"recurring", "priceAlteration":[ { "@type":"PriceAlteration", "name":"Amount Override", "priceType":"AmountOverride", "price":{ "@type":"Price", "dutyFreeAmount":{ "value":20.99, "unit":"USD" } } } ] } ], "id":"0.0.0.1+-purchased_product+232108", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+232108", "status":"cancelled", "billingAccount":{ "id":"0.0.0.1+-account+171083", "name":"Junior Walter", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-ip+192012", "@type":"RealizingService" } ], "startDate":"2018-01-01T08:00:00.00Z", "usageEnd":{ "unit":"months", "amount":1 } }, "description":"Removal of product characteristc service alias patch example with json_patch_query_json." }, "Product_partialupdate_productRelationshipAdd_example_application_json_patch_query_json_request":{ "value":[ { "op":"add", "path":"$.productRelationship", "value":{ "id":"0.0.0.1+-purchased_product+245670", "relationshipType":"tiedProduct" } } ], "description":"Addition of product relationship" }, "Product_partialupdate_productRelationshipAdd_example_application_json_patch_query_json_response":{ "value":{ "productRelationship":{ "id":"0.0.0.1+-purchased_product+245670", "relationshipType":"tiedProduct" }, "@type":"Product", "terminationDate":"2020-01-01T08:00:00.00Z", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+245476", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+245476", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+244964", "@type":"RealizingService" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Voice Over IP12", "description":"Test description", "productOffering":{ "id":"0.0.0.1+-discount+197972", "name":"Discount-Product-Id", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Response for addition of product relationship." }, "Product_partialupdate_productRelationshipReplace_example_application_json_patch_query_json_request":{ "value":[ { "op":"replace", "path":"$.productRelationship[?(@.id=='0.0.0.1+-purchased_product+245670' && @.relationshipType=='tiedProduct')]", "value":{ "id":"0.0.0.1+-purchased_product+248838", "relationshipType":"tiedProduct" } } ], "description":"Request for replace of product relationship tiedProduct/tiedDiscount." }, "Product_partialupdate_productRelationshipReplace_example_application_json_patch_query_json_response":{ "value":{ "productRelationship":{ "id":"0.0.0.1+-purchased_product+248838", "relationshipType":"tiedProduct" }, "@type":"Product", "terminationDate":"2020-01-01T08:00:00.00Z", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+245476", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+245476", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+244964", "@type":"RealizingService" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Voice Over IP12", "description":"Test description", "productOffering":{ "id":"0.0.0.1+-discount+197972", "name":"Discount-Product-Id", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Response for replace of product relationship tiedProduct/tiedDiscount." }, "Product_partialupdate_productRelationshipRemove_example_application_json_patch_query_json_request":{ "value":[ { "op":"remove", "path":"$.productRelationship[?(@.id=='0.0.0.1+-purchased_product+248838' && @.relationshipType=='tiedProduct')]" } ], "description":"Request for removal product relationship tiedProduct/tiedDiscount." }, "Product_partialupdate_productRelationshipRemove_example_application_json_patch_query_json_response":{ "value":{ "@type":"Product", "terminationDate":"2020-01-01T08:00:00.00Z", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+245476", "href":"http://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+245476", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+219307", "name":"John ", "@type":"BillingAccount" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+244964", "@type":"RealizingService" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Voice Over IP12", "description":"Test description", "productOffering":{ "id":"0.0.0.1+-discount+197972", "name":"Discount-Product-Id", "@type":"ProductOffering" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" }, "description":"Response for removal product relationship tiedProduct/tiedDiscount." }, "Product_partialupdate_specialRatingDataAdd_example_application_json_patch_query_json_request":{ "value":[ { "op":"add", "path":"$.specialRatingProfile.data", "value":{ "name":"dummy3", "value":"120842301897233", "validFor":{ "startDateTime":"2026-04-02T18:23:39.00Z", "endDateTime":"2026-07-27T12:10:19.00Z" } } } ], "description":"Request to add a special rating profile data entry with json_patch_query_json." }, "Product_partialupdate_specialRatingDataAdd_example_application_json_patch_query_json_response":{ "value":{ "@type":"Product", "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "specialRatingProfile":{ "id":"0.0.0.1+-profile-serv_extrating+738476", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy", "value":"0039335873473632", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z", "endDateTime":"2026-05-01T00:00:00Z" } }, { "name":"dummy3", "value":"120842301897233", "validFor":{ "startDateTime":"2026-04-02T18:23:39.00Z", "endDateTime":"2026-07-27T12:10:19.00Z" } } ] } }, "description":"Response after adding a special rating profile data entry with json_patch_query_json." }, "Product_partialupdate_specialRatingDataReplace_example_application_json_patch_query_json_request":{ "value":[ { "op":"replace", "path":"$.specialRatingProfile.data[?(@.name=='dummy3' && @.value=='120842301897233')]", "value":{ "name":"dummy1", "value":"120842301897231" } } ], "description":"Request to replace a special rating profile data entry with json_patch_query_json." }, "Product_partialupdate_specialRatingDataReplace_example_application_json_patch_query_json_response":{ "value":{ "@type":"Product", "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "specialRatingProfile":{ "id":"0.0.0.1+-profile-serv_extrating+738476", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy", "value":"0039335873473632", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z", "endDateTime":"2026-05-01T00:00:00Z" } }, { "name":"dummy1", "value":"120842301897231" } ] } }, "description":"Response after replacing a special rating profile data entry with json_patch_query_json." }, "Product_partialupdate_specialRatingDataRemove_example_application_json_patch_query_json_request":{ "value":[ { "op":"remove", "path":"$.specialRatingProfile.data[?(@.value=='0039335873473632')]" } ], "description":"Request to remove a special rating profile data entry with json_patch_query_json." }, "Product_partialupdate_specialRatingDataRemove_example_application_json_patch_query_json_response":{ "value":{ "@type":"Product", "id":"0.0.0.1+-purchased_product+229551", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+229551", "specialRatingProfile":{ "id":"0.0.0.1+-profile-serv_extrating+738476", "@type":"SpecialRatingProfile", "name":"FRIENDS_FAMILY", "label":"Smart Calling up to 5 Numbers", "status":"noop", "referenceCount":1, "data":[ { "name":"dummy", "value":"0039335686849545", "validFor":{ "startDateTime":"2026-04-02T18:23:39Z" } }, { "name":"dummy1", "value":"120842301897231" } ] } }, "description":"Response after removing a special rating profile data entry with json_patch_query_json." }, "ProductCreateEvent_request":{ "value":{ "correlationId":"8a1d7f00-245b", "description":"ProductCreateEvent illustration", "domain":"Commercial", "eventId":"467c-937d-9afe827e85k1", "eventTime":"2022-09-14T12:14:28.774Z", "eventType":"ProductCreateEvent", "priority":"3", "timeOcurred":"2022-09-14T12:14:23.473Z", "title":"ProductCreateEvent", "event":{ "product":{ "description":"This Purchased Product is purchased using ProductCreateEvent", "isBundle":false, "name":"Voice Over Ip", "status":"active", "@type":"Product", "id":"Product_Id0", "startDate":"2018-01-01T08:00:00.00Z", "terminationDate":"2020-01-01T08:00:00.00Z", "realizingService":[ { "id":"RealizingServiceId1" } ], "productCharacteristic":[ { "@type":"@ObjectCharacteristic", "id":"ProductObjectCharacteristcId1", "name":"Service", "valueType":"object", "value":{ "password":"C1g2b3u", "serviceType":"/service/telco/gsm/telephony" } }, { "@type":"ArrayCharacteristic", "id":"ProductArrayCharacteristicId1", "name":"ServiceAlias", "valueType":"array", "value":[ { "name":"ServiceAliasName1", "valueType":"MSISDN" }, { "name":"ServiceAliasName1s", "valueType":"MSISDN" } ] } ], "quantity":1, "billingAccount":{ "id":"BillingAccountId1" }, "productOffering":{ "id":"Standard GSM Product" } } } }, "description":"Example payload for product create event." }, "ProductAttributeValueChangeEvent_request":{ "value":{ "correlationId":"8a1d7f00-245b", "description":"ProductAttributeValueChangeEvent illustration", "domain":"Commercial", "eventId":"467c-937d-9afe827e85k2", "eventTime":"2022-09-14T12:14:28.774Z", "eventType":"ProductAttributeValueChangeEvent", "priority":"3", "timeOcurred":"2022-09-14T12:14:23.473Z", "title":"ProductAttributeValueChangeEvent", "event":{ "product":{ "description":"updated description", "@type":"Product", "id":"PurchasedProductId1" } }, "reportingSystem":{ "id":"533", "name":"APP-963", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "source":{ "id":"200", "name":"APP-893", "@type":"ReportingResource", "@referredType":"LogicalResource" }, "@baseType":"Event", "@type":"Event" }, "description":"Example for ProductAttributeValueChange event." }, "ProductStateChangeEvent_request":{ "value":{ "eventType":"ProductStateChangeEvent", "eventId":"467c-937d-9afe827e85k3", "eventTime":"2022-09-14T12:14:28.00Z", "event":{ "product":{ "@type":"Product", "status":"cancelled", "id":"PurchasedProductId1" } } }, "description":"An example for ProductStateChangeEvent" }, "ProductDeleteEvent_request":{ "value":{ "eventType":"ProductDeleteEvent", "eventId":"467c-937d-9afe827e85k4", "eventTime":"2022-09-14T12:14:28.00Z", "event":{ "product":{ "@type":"Product", "id":"0.0.0.1+-purchased_product+192022" } } }, "description":"Example of ProductDeleteEvent" }, "CreateProductSharingGroupOwner_request":{ "value":{ "isBundle":true, "name":"Sharing Group Owner Service", "description":"Creates an automatic sharing-group owner", "status":"active", "productOffering":{ "id":"0.0.0.1+-product+64390" }, "billingAccount":{ "id":"0.0.0.1+-account+241527" }, "realizingService":[ { "id":"0.0.0.1+-service+0" } ], "productCharacteristic":[ { "id":"SG-OWNER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-owner-service" }, { "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#" }, { "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony" }, { "name":"Service Grouping", "valueType":"string", "value":"Y" }, { "name":"CommunityMember", "valueType":"string", "value":"Y" } ] } }, "CreateProductSharingGroupMember_request":{ "value":{ "isBundle":true, "name":"Sharing Group Member Service", "description":"AR-child service that automatically joins the owner DSG", "status":"active", "productOffering":{ "id":"0.0.0.1+-product+64390" }, "billingAccount":{ "id":"0.0.0.1+-account+243884" }, "realizingService":[ { "id":"0.0.0.1+-service+0" } ], "productCharacteristic":[ { "id":"SG-MEMBER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-member-service" }, { "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#" }, { "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony" }, { "name":"Service Grouping", "valueType":"string", "value":"Y" }, { "name":"CommunityMember", "valueType":"string", "value":"Y" } ] } }, "CreateProductSharingGroupExplicit_request":{ "value":{ "isBundle":true, "name":"Explicit Sharing Group Owner Service", "description":"Creates a named sharing group and applies an explicit offer", "status":"active", "productOffering":{ "id":"0.0.0.1+-product+64390" }, "billingAccount":{ "id":"0.0.0.1+-account+257993" }, "realizingService":[ { "id":"0.0.0.1+-service+0" } ], "productCharacteristic":[ { "id":"SG-EXPLICIT-OWNER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-explicit-owner-service" }, { "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#" }, { "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony" }, { "name":"Service Grouping", "valueType":"string", "value":"Y" }, { "name":"CommunityMember", "valueType":"string", "value":"Family-DSG-Example" } ], "product":[ { "id":"SG_EXAMPLE_EXPLICIT_DISCOUNT_PP", "isBundle":false, "name":"Explicit Sharing Group Discount", "status":"active", "productOffering":{ "id":"0.0.0.1+-discount+61766" }, "billingAccount":{ "id":"0.0.0.1+-account+257993" }, "productCharacteristic":[ { "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony" }, { "name":"CommunityOffer", "valueType":"string", "value":"Family-DSG-Example" } ] } ] } }, "CreateProductSharingGroupOffer_request":{ "value":{ "isBundle":false, "name":"Automatic Sharing Group Discount", "description":"Adds a discount to the owner DSG using automatic lookup", "status":"active", "productOffering":{ "id":"0.0.0.1+-discount+61766" }, "productRelationship":[ { "id":"0.0.0.1+-purchased_product+244366", "relationshipType":"bundledBy" } ], "billingAccount":{ "id":"0.0.0.1+-account+241527" }, "realizingService":[ { "id":"0.0.0.1+-service+0" } ], "productCharacteristic":[ { "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony" }, { "name":"CommunityOffer", "valueType":"string", "value":"Y" } ] } }, "ProductSharingGroupRemoval_request":{ "value":{ "productCharacteristic":[ { "id":"SG-MEMBER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-member-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"N", "@type":"StringCharacteristic" } ] } }, "ProductSharingGroupEnable_request":{ "value":{ "productCharacteristic":[ { "id":"SG-MEMBER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-member-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"N", "@type":"StringCharacteristic" } ] } }, "ProductSharingDiscountGroupRemoval_request":{ "value":{ "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityOffer", "valueType":"string", "value":"N", "@type":"StringCharacteristic" } ] } }, "ProductEnableCommunityMemberJsonPatch_request":{ "value":[ { "op":"replace", "path":"$.productCharacteristic[?(@.name=='CommunityMember' && @.value=='N' && @.valueType=='string')]", "value":{ "name":"CommunityMember", "valueType":"string", "value":"Y" } } ] }, "ProductRemoveCommunityMember_request":{ "value":[ { "op":"replace", "path":"$.productCharacteristic[?(@.name=='CommunityMember' && @.value=='N' && @.valueType=='string')]", "value":{ "name":"CommunityMember", "valueType":"string", "value":"Y" } } ] }, "ProductCommunityOfferEnable_request":{ "value":[ { "op":"replace", "path":"$.productCharacteristic[?(@.name=='CommunityOffer' && @.value=='N' && @.valueType=='string')]", "value":{ "name":"CommunityOffer", "valueType":"string", "value":"Family-DSG-Example" } } ] }, "CreateProductSharingGroupOwner_response":{ "value":{ "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "terminationDate":"", "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+243726", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+243726", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+241527", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+245238", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Owner Service", "description":"Creates an automatic sharing-group owner", "productOffering":{ "id":"0.0.0.1+-product+64390", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-OWNER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-owner-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "quantity":1, "startDate":"2018-01-01T08:00:00.00Z" } }, "CreateProductSharingGroupMember_response":{ "value":{ "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "terminationDate":"", "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+242285", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+242285", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+243884", "name":"child-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+243629", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Member Service", "description":"AR-child service that automatically joins the owner DSG", "productOffering":{ "id":"0.0.0.1+-product+64390", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-MEMBER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-member-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "quantity":1, "startDate":"2018-01-01T08:00:00.00Z" } }, "CreateProductSharingGroupExplicit_response":{ "value":{ "productRelationship":[ { "id":"0.0.0.1+-purchased_discount+262480", "relationshipType":"bundles", "@type":"ProductRelationship" } ], "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "product":[ { "productRelationship":[ { "id":"0.0.0.1+-purchased_product+264784", "relationshipType":"bundledBy", "@type":"ProductRelationship" } ], "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "terminationDate":"", "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+262480", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+262480", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+257993", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+264080", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Explicit Sharing Group Discount", "description":"", "productOffering":{ "id":"0.0.0.1+-discount+61766", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityOffer", "valueType":"string", "value":"Family-DSG-Example", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "quantity":1, "startDate":"2018-01-01T08:00:00.00Z" } ], "purchaseStart":{ "unit":"absolute", "amount":0 }, "terminationDate":"", "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+264784", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+264784", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+257993", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+264080", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Explicit Sharing Group Owner Service", "description":"Creates a named sharing group and applies an explicit offer", "productOffering":{ "id":"0.0.0.1+-product+64390", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-EXPLICIT-OWNER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-explicit-owner-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"Family-DSG-Example", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "quantity":1, "startDate":"2018-01-01T08:00:00.00Z" } }, "CreateProductSharingGroupOffer_response":{ "value":{ "productRelationship":[ { "id":"0.0.0.1+-purchased_product+264784", "relationshipType":"bundledBy", "@type":"ProductRelationship" } ], "@type":"Product", "cycleStart":{ "unit":"absolute", "amount":0 }, "purchaseStart":{ "unit":"absolute", "amount":0 }, "terminationDate":"", "gracePeriod":{ "unit":"absolute", "amount":0 }, "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+262896", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+262896", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+257993", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+264048", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Automatic Sharing Group Discount", "description":"Adds a discount to the owner DSG using automatic lookup", "productOffering":{ "id":"0.0.0.1+-discount+61766", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityOffer", "valueType":"string", "value":"Family-DSG-Example", "@type":"StringCharacteristic" } ], "usageStart":{ "unit":"absolute", "amount":0 }, "cycleEnd":{ "unit":"absolute", "amount":0 }, "quantity":1, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductSharingGroupRemoval_response":{ "value":{ "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+242285", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+242285", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+243884", "name":"child-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+243629", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Member Service", "description":"AR-child service that automatically joins the owner DSG", "productOffering":{ "id":"0.0.0.1+-product+64390", "name":"Standard GSM Telephony", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-MEMBER-SERVICE-ID", "name":"ServiceId", "valueType":"string", "value":"sg-example-member-service", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"N", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductSharingGroupEnable_response":{ "value":{ "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+260594", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+260594", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+241527", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+261362", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Owner Service", "description":"Creates an automatic sharing-group owner", "productOffering":{ "id":"0.0.0.1+-product+64390", "name":"Standard GSM Telephony", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-NODSG-SERVICE-ID-02", "name":"ServiceId", "valueType":"string", "value":"sg-example-nodsg-service-02", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductSharingDiscountGroupRemoval_response":{ "value":{ "productRelationship":[ { "id":"0.0.0.1+-purchased_product+244366", "relationshipType":"bundledBy", "@type":"ProductRelationship" } ], "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+242062", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+242062", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+241527", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+243470", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Explicit Sharing Group Discount", "description":"", "productOffering":{ "id":"0.0.0.1+-discount+61766", "name":"Standard GSM Discount", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityOffer", "valueType":"string", "value":"N", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductEnableCommunityMemberJsonPatch_response":{ "value":{ "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+260529", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+260529", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+241527", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+261297", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Owner Service", "description":"Creates an automatic sharing-group owner", "productOffering":{ "id":"0.0.0.1+-product+64390", "name":"Standard GSM Telephony", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-NODSG-SERVICE-ID-01", "name":"ServiceId", "valueType":"string", "value":"sg-example-nodsg-service-01", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityMember", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductRemoveCommunityMember_response":{ "value":{ "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_product+260529", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_product+260529", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+241527", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+261297", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":true, "name":"Sharing Group Owner Service", "description":"Creates an automatic sharing-group owner", "productOffering":{ "id":"0.0.0.1+-product+64390", "name":"Standard GSM Telephony", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"SG-NODSG-SERVICE-ID-01", "name":"ServiceId", "valueType":"string", "value":"sg-example-nodsg-service-01", "@type":"StringCharacteristic" }, { "id":"", "name":"ServicePassword", "valueType":"string", "value":"CGbu_1234#", "@type":"StringCharacteristic" }, { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"Service Grouping", "valueType":"string", "value":"Y", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } }, "ProductCommunityOfferEnable_response":{ "value":{ "productRelationship":[ { "id":"0.0.0.1+-purchased_product+264784", "relationshipType":"bundledBy", "@type":"ProductRelationship" } ], "@type":"Product", "terminationDate":"", "purchaseEnd":{ "unit":"absolute", "amount":0 }, "id":"0.0.0.1+-purchased_discount+262768", "href":"https://host:port/brm/productInventory/v5/product/0.0.0.1+-purchased_discount+262768", "status":"active", "billingAccount":{ "id":"0.0.0.1+-account+257993", "name":"parent-billunit ", "@type":"BillingAccountRef" }, "realizingService":[ { "id":"0.0.0.1+-service-telco-gsm-telephony+264112", "@type":"ServiceRef" } ], "usageEnd":{ "unit":"absolute", "amount":0 }, "isBundle":false, "name":"Automatic Sharing Group Discount", "description":"Adds a discount to the owner DSG using automatic lookup", "productOffering":{ "id":"0.0.0.1+-discount+61766", "name":"Standard GSM Discount", "@type":"ProductOfferingRef" }, "productCharacteristic":[ { "id":"", "name":"ServiceType", "valueType":"string", "value":"/service/telco/gsm/telephony", "@type":"StringCharacteristic" }, { "id":"", "name":"CommunityOffer", "valueType":"string", "value":"Family-DSG-Example", "@type":"StringCharacteristic" } ], "cycleEnd":{ "unit":"absolute", "amount":0 }, "startDate":"2018-01-01T08:00:00.00Z" } } } } }