Available from CRM.COM R10.0.0
It previews the bill of one job of any fulfillment scope
Resource URL
Parameters
Name | Type | Description | |||||||||
token | String | The token retrieved from the login method | |||||||||
| job_identifier (mandatory) | Job identifier | The identifier of the job that should be previewed. The allowed jobs identifier fields are the following:
| |||||||||
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. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
| bill_preview | Bill preview object | The bill preview results |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"99638021",
"job_identifier":{"number":"JOB000654"}
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"total_amount_to_be_paid": 1267.5,
"product_set": [
{
"to_date": null,
"total_amount": 532.8,
"from_date": null,
"applied_additive_discounts_set": [
{
"ad_hoc_discount": {
"life_cycle_state": "APPROVED",
"discount_amount": null,
"effective_date": null,
"discount_percentage": 20,
"number": "61",
"id": "E4D882EC92E0400DA51E44A607D888AA",
"expiration_date": null
},
"applied_additive_discount_definition": {
"life_cycle_state": "EFFECTIVE",
"classification": "JOBS",
"type": "AD_HOC",
"id": "36336142D45F4735B44554A42FA7E070",
"name": "5 % Discount",
"alternative_code": "5%D"
},
"to_date": null,
"from_date": null,
"discount_amount": 133.2,
"number": null,
"id": "F271270842134EB48DD85671070673B1",
"product": {
"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"
}
}
],
"product": {
"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"
}
}
],
"to_date": null,
"from_date": "2016-07-19T17:51:20",
"total_billed_amount": 532.8
}
}