POST jobs/all_scopes/calculate_rates
- Former user (Deleted)
- Joseph Ioannou (Unlicensed)
Owned by Former user (Deleted)
Available from CRM.COM R10.0.0
This method is used to calculate the rates that will be applied while processing a job and before submitting the actual request. The rates calculation can be applied on a single job of any fulfillment scope per each call. The method can only be used for calculating the rates of jobs whose job type defines them as billable.
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
job_identifier (semi-optional) | Job Identifier | The identifier of the existing job that should be rated. The allowed job identifier fields are the following:
| ||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The identifier of the accounts receivable of the job that should be rated. Applicable only if the account owner of the job already exists. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
(mandatory and applicable on conditions) | Accounts Receivable Object | Information related with the accounts receivable for which the new job is created for. Applicable only when the rates are calculated for new jobs and for new account owners. | ||||||||||||
(mandatory and applicable on conditions) | Job Object | Information related with the job that will be rated. Note that this information is applicable and mandatory only when a new job is to be rated. | ||||||||||||
(optional) | Set of Job Requested Physical Goods | Information with new physical goods that will be added on the job that was specified as requested physical goods Note that this information is applicable and mandatory only when an existing job is to be rated. | ||||||||||||
requested_activity_services_set (optional) | Set of Job Requested Activity Services | Information with new activity services that will be added on the job that was specified as requested activity services Note that this information is applicable and mandatory only when an existing job is to be rated. | ||||||||||||
(optional) | Set of Requested Job Expenses | Information with new expenses that will be added on the job that was specified as requested expenses Note that this information is applicable and mandatory only when an existing job is to be rated. | ||||||||||||
requested_subscription_physical_goods_set (optional) | Set of Requested Subscription Physical Goods | Information with new subscription service products that will be added on the subscription through the job. This is applicable only for jobs with fulfillment scopes NEW_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES and SWAP_SUBSCRIPTION_INSTALLED_ITEMS Note that this information is applicable and mandatory only when an existing job is to be rated. | ||||||||||||
requested_subscription_services_set (optional) | Set of Requested Subscription Services | Information with new subscription service products that will be added on the subscription through the job. This is applicable only for jobs with fulfillment scopes NEW_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES and SWAP_SUBSCRIPTION_SERVICES Note that this information is applicable and mandatory only when an existing job is to be rated. | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. More than one of those parameters are allowed to be specified.
Referred Parameters Objects Data
Response Data
Name | Type | Description |
|---|---|---|
| job_rates | Calculated Job Rates Object | The job rates are the rates that will be charged based on the job's requested physical goods, activity services and expenses. |
| upcoming_subscription_rates | Calculated Upcoming Subscription Rates Object | The upcoming subscription rates are the rates that the job's related subscription will be charged for the next (upcoming) billing period, which in some cases might be prorated. Applicable only for jobs with one of the following fulfillment scopes:
|
| Set of Calculated Subscription Additional Period Rates Object | The rates for the additional billing periods of the job's related subscription that will occur after the upcoming billing period. Applicable only for jobs with one of the following fulfillment scopes:
|
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "637583768",
"accounts_receivable_identifier": {
"number": "ACR001143"
},
"job": {
"type_identifier": {
"name": "Installation Job"
},
"owned_by_group_identifier": {
"name": "Main Group"
},
"billing_terms": {
"billing_term_scheme_identifier": {
"code": "PJBTS"
},
"price_plan_identifier": {
"code": "BPP0614"
},
"agreement_date": "2016-07-04T17:11:00"
},
"requested_physical_goods_set": [
{
"product_identifier": {
"code": "Antenna 1"
},
"quantity": 31
},
{
"product_identifier": {
"code": "Smartcard 1"
}
}
],
"requested_expenses_set": [
{
"product_identifier": {
"code": "Expence 1"
}
},
{
"product_identifier": {
"code": "Expence 2"
}
}
]
}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"job_rates": {
"total_amount": 264.6,
"amount_to_be_paid": 999.3,
"total_discount_amount": 491.4,
"service_rates_set": [
{
"total_amount": 7.7,
"service": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
"description": "Expence 1",
"code": "Expence 1",
"alternative_code": "exp1"
},
"total_discount_amount": 14.3
},
{
"total_amount": 3.5,
"service": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
},
"total_discount_amount": 6.5
},
{
"total_amount": 20.3,
"service": {
"product_type": {
"service_type": null,
"physical_good_type": "NONTRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "0F94B51F175F06A475EB2948B4030074",
"name": "Accessories",
"description": "A type which is used for accessories physical goods",
"alternative_code": "005"
},
"id": "70FFDF2B2A74466DD7D0D5246ED1DD2D",
"description": "Antenna v1",
"code": "Antenna 1",
"alternative_code": "ANT1"
},
"total_discount_amount": 37.7
},
{
"total_amount": 233.1,
"service": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "81D5550CF6004CE0B206A371F9F3A18A",
"description": "Expence 2",
"code": "Expence 2",
"alternative_code": "exp2"
},
"total_discount_amount": 432.9
}
]
}
}
}
HTTP Method: POST
Request:
Body:
{
"token":"1110930787",
"accounts_receivable_identifier":{"number":"ACR001181"},
"job":
{
"type_identifier": {
"name": "New Subscription MA"
},
"requested_subscription_billing_terms":
{
"price_plan_identifier":
{
"code": "BPP0614"
},
"agreement_date": "2016-07-25T11:00:00",
"concurrent_usage_based_pricing":
{
"concurrent_usage":1,
"rate_percentage":100
}
},
"requested_physical_goods_set":
[
{
"product_identifier": {
"code": "Smartcard 1"
},
"quantity": 3
},
{
"product_identifier": {
"code": "Smartcard 2"
}
}
],
"requested_subscription_services_set":
[
{
"service_identifier":
{
"code":"Gold"
}
},
{
"service_identifier":
{
"code":"Movies 1"
}
}
],
"requested_expenses_set": [
{
"product_identifier": {
"code": "Expence 1"
}
},
{
"product_identifier": {
"code": "Expence 2"
}
}
]
}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"upcoming_rates": {
"total_amount": 10.49,
"as_of_date": "Tue Jul 26 00:00:00 EEST 2016",
"amount_to_be_paid": 10.49,
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Thu Aug 04 00:00:00 EEST 2016",
"from_date": "Mon Jul 25 00:00:00 EEST 2016",
"total_amount": 0.81,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
},
{
"to_date": "Wed Aug 24 00:00:00 EEST 2016",
"from_date": "Mon Jul 25 00:00:00 EEST 2016",
"total_amount": 9.68,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "BC954969D3172372D498D3BB2BA590A0",
"name": "Subscription Packages",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"description": "Gold Premium Package",
"code": "Gold",
"alternative_code": "GPP"
},
"total_discount_amount": 0
}
]
},
"additional_period_rates_set": [
{
"total_amount": 0.81,
"period_number": 1,
"as_of_date": "Fri Aug 05 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Sun Aug 14 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Thu Aug 04 00:00:00 EEST 2016",
"total_amount": 0.81,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
}
]
},
{
"total_amount": 0.81,
"period_number": 2,
"as_of_date": "Mon Aug 15 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Wed Aug 24 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Sun Aug 14 00:00:00 EEST 2016",
"total_amount": 0.81,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
}
]
},
{
"total_amount": 10.72,
"period_number": 3,
"as_of_date": "Thu Aug 25 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Fri Sep 23 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Wed Aug 24 00:00:00 EEST 2016",
"total_amount": 9.91,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "BC954969D3172372D498D3BB2BA590A0",
"name": "Subscription Packages",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"description": "Gold Premium Package",
"code": "Gold",
"alternative_code": "GPP"
},
"total_discount_amount": 0
},
{
"to_date": "Sat Sep 03 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Wed Aug 24 00:00:00 EEST 2016",
"total_amount": 0.81,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
}
]
},
{
"total_amount": 0.83,
"period_number": 4,
"as_of_date": "Sun Sep 04 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Tue Sep 13 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Sat Sep 03 00:00:00 EEST 2016",
"total_amount": 0.83,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
}
]
},
{
"total_amount": 0.83,
"period_number": 5,
"as_of_date": "Wed Sep 14 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Fri Sep 23 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Tue Sep 13 00:00:00 EEST 2016",
"total_amount": 0.83,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
}
]
},
{
"total_amount": 10.83,
"period_number": 6,
"as_of_date": "Sat Sep 24 00:00:00 EEST 2016",
"total_discount_amount": 0,
"service_rates_set": [
{
"to_date": "Mon Oct 03 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Fri Sep 23 00:00:00 EEST 2016",
"total_amount": 0.83,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "600438B64B0F05AB3D020C902674949F",
"name": "Subscription services",
"description": "Subscription services",
"alternative_code": "SS"
},
"id": "5B3841D63F6CAE5973366EEAFF3444E3",
"description": "Movies 1",
"code": "Movies 1",
"alternative_code": "M1"
},
"total_discount_amount": 0
},
{
"to_date": "Sun Oct 23 00:00:00 EEST 2016",
"time_period": {
"time_period_value": null,
"time_period_uot": null
},
"from_date": "Fri Sep 23 00:00:00 EEST 2016",
"total_amount": 10,
"service": {
"product_type": {
"service_type": "TERMED",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "BC954969D3172372D498D3BB2BA590A0",
"name": "Subscription Packages",
"description": "Subscription main packages",
"alternative_code": "SP"
},
"id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
"description": "Gold Premium Package",
"code": "Gold",
"alternative_code": "GPP"
},
"total_discount_amount": 0
}
]
}
],
"job_rates": {
"total_amount": 713,
"amount_to_be_paid": 930,
"total_discount_amount": 0,
"service_rates_set": [
{
"total_amount": 666,
"service": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "81D5550CF6004CE0B206A371F9F3A18A",
"description": "Expence 2",
"code": "Expence 2",
"alternative_code": "exp2"
},
"total_discount_amount": 0
},
{
"total_amount": 5,
"service": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "80EEE8F6F46767AE32E6ABE68603E9F2",
"description": "SmartCards 2",
"code": "Smartcard 2",
"alternative_code": "SC2"
},
"total_discount_amount": 0
},
{
"total_amount": 20,
"service": {
"product_type": {
"service_type": null,
"physical_good_type": "TRACEABLE",
"used_for_provisioning": false,
"classification": "PHYSICALGOODS",
"composition_method": "FLAT",
"id": "6173FC99331504AD1ACB5D697D54DA8C",
"name": "Smartcards",
"description": "Smartcards",
"alternative_code": "SC"
},
"id": "EAC7A30429364176616CFEF5DF709941",
"description": "Smartcard 1",
"code": "Smartcard 1",
"alternative_code": "SC1"
},
"total_discount_amount": 0
},
{
"total_amount": 22,
"service": {
"product_type": {
"service_type": "EXPENSE",
"physical_good_type": null,
"used_for_provisioning": false,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "67FA013211E348C58F7CD27F8399AADE",
"name": "Expense Type",
"description": null,
"alternative_code": "ET"
},
"id": "2855ACFCB7D94ED69A5FC3B9557EB6D6",
"description": "Expence 1",
"code": "Expence 1",
"alternative_code": "exp1"
},
"total_discount_amount": 0
}
]
}
}
}