| Tip |
|---|
Starting from CRM.COM R10.0.0 the specified Web API methods will be deprecated, and although they will still be available in CRM.COM R10.0.0 they will not be maintained furthermore. |
| Table of Contents | ||
|---|---|---|
|
GET jobs/show
This method returns information related with a job. Single job is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Job identifier
The identifier of the job that should be returned as a result. 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/list
This method returns information related with jobs. Multiple jobs are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
The identifier of the account related with the job that should be returned as a result. The allowed account identifier fields are the following:
...
type_identifier
(semi-optional)
...
The identifier of the job type related with the jobs that should be returned as a result. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_close_to_estimated_completion_time
This method returns information related with jobs that are close to estimated completion time.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
period
(mandatory)
...
uot
(mandatory)
...
MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_overdue
This method returns information related with jobs that are overdue.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_draft
This method returns information related with jobs that are draft
...
Available from CRM.COM R6.0.0
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_pending
This method returns information related with jobs that are pending.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_in_progress
This method returns information related with jobs that are in progress.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_completed
This method returns information related with jobs that are completed.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET jobs/get_cancelled
This method returns information related with jobs that are cancelled
| Tip |
|---|
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(optional)
...
The identifier of the accounts receivable in which the jobs that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
...
type_identifier
(optional)
...
The identifier of the type of the retrieved job. The allowed job type 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
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST jobs/create
This method creates a job. Single job can be created by each call. Only customer jobs can be created through this method.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
type_identifier
(mandatory)
...
The identifier of the type of the new job. The allowed job type identifier fields are the following:
...
status_identifier
(optional)
...
The identifier of the status of the new job. If not specified then the default one will be used. The allowed job status identifier fields are the following:
...
category_identifier
(optional)
...
The identifier of the category of the new job. The allowed job category identifier fields are the following:
...
(mandatory)
...
The identifier of the new job accounts receivable. The allowed accounts receivable identifier fields are the following:
...
subscription_identifier
(mandatory on conditions)
...
The identifier of the subscription that will be maintained through the new job. This information is applicable and mandatory only if the specified job type has fulfillment scope equal to ACTIVATE_SUBSCRIPTION, DEACTIVATE_SUBSCRIPTION, CANCEL_SUBSCRIPTION, ADD_SUBSCRIPTION_SERVICES, CANCEL_SUBSCRIPTION_SERVICES, CHANGE_SUBSCRIPTION_LOCATION, SWAP_SUBSCRIPTION_INSTALLED_ITEMS, SWAP_SUBSCRIPTION_SERVICES. The allowed subscription identifier fields are the following:
...
| Tip |
|---|
| Tip |
|---|
...
contact_email
(optional)
...
The email of the customer related with the job, which will be used in order to communicate the job
| Tip |
|---|
...
contact_phone
(optional)
...
The phone of the customer related with the job, which will be used in order to communicate the job
| Tip |
|---|
...
description
(optional)
...
notes
(optional)
...
start_date
(optional)
...
location_identifier
(mandatory)
...
The identifier of the location of the new job. The allowed job location identifier fields are the following:
...
owned_by_group_identifier
(optional)
...
The owned by group information of the job. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the job. The allowed privacy level identifier fields are the following:
...
The service request related with the job. The allowed service request identifier fields are the following:
...
| Tip |
|---|
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
expected_completion_date
(semi-optional)
...
estimated_completion_time
(semi-optional)
...
The billing terms of the job to be created. This information is applicable and mandatory if the job type fulfillment method is set to Generic Purpose
...
For Releases previous to CRM.COM R6.0.0 this information is mandatory only if the job is billable
...
requested_subscription_billing_terms
(optional)
...
The billing terms of the subscription that will be provided as part of the job. This information is applicable and mandatory if the job type fulfillment method is set to New Subscription
| Tip |
|---|
...
The physical goods that will be provided as part of the job
| Tip |
|---|
...
A list of one time services which are applied on the job as expenses
| Tip |
|---|
...
A set of activities which are planned for the specific job
| Tip |
|---|
...
requested_subscription_services_set
(mandatory on conditions)
...
A list of services that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services. The subscription services are filtered based on the specified subscription type and billing term scheme. All the subscription related rules and restrictions are applicable on the requested subscription services as well
| Tip |
|---|
| Tip |
|---|
...
(mandatory on conditions)
...
A list of physical goods (products only) that are requested by the customer, and should be delivered as part of fulfilling the ordered job. The requested physical goods are filtered based on the selected job type. Mandatory physical goods are added automatically.
| Tip |
|---|
...
requested_subscription_physical_goods_set
(mandatory on conditions)
...
A list of physical goods (products only) that were requested by the customer and should be provided as part of the subscription that will be delivered. This information is applicable and mandatory only if the job type fulfillment method is set to New Subscription, Add Subscription Services and Swap Subscription Installed Items. The subscription physical goods are filtered based on the specified subscription type. All the subscription related rules and restrictions are applicable on the requested subscription physical goods as well
| Tip |
|---|
| Tip |
|---|
...
(mandatory on conditions)
...
A list of requested expenses that are requested by the customer and should be delivered as part of fulfilling the ordered job. The requested expenses are filtered based on the selected job type. Mandatory expenses are added automatically
| Tip |
|---|
...
requested_activity_services_set
(mandatory on conditions)
...
A list of one time services that are requested by the customer and should be delivered by a scheduling and performing a specific activity. The requested activity services are defined by specifying the type of the activity and the activity services that should be performed. The activity types are filtered based on the selected job type. The activity services are filtered based on the selected activity type. Mandatory activity types and services are added automatically.
| Tip |
|---|
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST jobs/update
This method updates jobs. Single job can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
The identifier of the job. The allowed job identifier fields are the following:
...
status_identifier
(optional)
...
The identifier of the status of the new job. The allowed job status identifier fields are the following:
...
category_identifier
(optional)
...
The identifier of the category of the new job. The allowed job category identifier fields are the following:
...
notes
(optional)
...
contact_email
(optional)
...
The email of the customer related with the job, which will be used in order to communicate the job
...
contact_phone
(optional)
...
The phone of the customer related with the job, which will be used in order to communicate the job
...
start_date
(optional)
...
location_identifier
(optional)
...
The identifier of the location of the new job. The allowed job location identifier fields are the following:
...
owned_by_group_identifier
(optional)
...
The owned by group information of the job. The allowed group identifier fields are the following:
...
privacy_level_identifier
(optional)
...
The privacy level of the job. The allowed privacy level identifier fields are the following:
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
expected_completion_date
(optional)
...
estimated_completion_time
(optional)
...
The billing terms of the retrieved job.This information is applicable if the job type fulfillment method is set to Generic Purpose and if the job is still draft or pending
| Tip |
|---|
For Releases previous to CRM.COM R6.0.0 this information is applicable for any type of billable jobs |
...
requested_subscription_billing_terms
(optional)
...
The billing terms of the subscription that will be provided as part of the job. This information is applicable if the job type fulfillment method is set to New Subscription and if the job is still draft or pending
| Tip |
|---|
Available from CRM.COM R6.0.0 |
...
requested_subscription_services_set
(optional)
...
The requested subscription services. This information is applicable only if the job type fulfillment scope is set to New Subscription, Add Subscription Services, Cancel Subscription Services or Swap Subscription Services and if the job is draft or pending
...
| Tip |
|---|
Available from CRM.COM R6.0.0 |
| Tip |
|---|
The information is also available for Swap Subscription Service jobs from CRM.COM R9.0.0 |
...
(optional)
...
The requested physical goods. This information is applicable only if the job is draft or pending
...
| Tip |
|---|
Available from CRM.COM R6.0.0 |
...
requested_subscription_physical_goods_set
(optional)
...
The requested subscription physical goods. This information is applicable only if the job type fulfillment scope is set to New Subscription or Add Subscription Services or Swap Subscription Installed Items and if the job is draft or pending
...
| Tip |
|---|
Available from CRM.COM R6.0.0 |
| Tip |
|---|
The information is also available for Swap Subscription Installed Item jobs from CRM.COM R9.0.0 |
...
(optional)
...
The requested expenses. This information is applicable only if the job is draft or pending
...
| Tip |
|---|
Available from CRM.COM R6.0.0 |
...
requested_activity_services_set
(optional)
...
The requested activity services. This information is applicable only if the job is draft or pending
...
| Tip |
|---|
Available from CRM.COM R6.0.0 |
...
The physical goods that will be provided as part of the retrieved job. This information is applicable only if the job is in progress
...
| Tip |
|---|
In releases previous to CRM.COM R6.0.0, physical_goods_set is available as physical_goods_to_be_provided_set. This object is deprecated in CRM.COM R6.0.0 |
...
A list of one time services which are applied on the retrieved job as expenses. This information is applicable only if the job is in progress
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST jobs/bill
It bills one job based on a specific as of date
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Job identifier
The identifier of the job that should be billed. The allowed jobs identifier fields are the following:
...
as_of_date
(mandatory)
...
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 | Bill object | The bill that will be created |
...
| title | bill object response data |
|---|
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST jobs/preview_bill
It previews the bill of one job based on a specific as of date
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Job identifier
The identifier of the job that should be previewed. The allowed jobs identifier fields are the following:
...
as_of_date
(mandatory)
...
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 |
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token" : "DCB6E9C6A3CE16CF529083B9020EC92F",
"job_identifier" : { "number" : "82" },
"as_of_date" : "2014-07-28T00:00:00"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": {
"message": null,
"description": null,
"code": "OK"
},
"data": {
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": null,
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"previous_bill_total_due_amount": 985,
"udf_string_4": null,
"udf_string_5": null,
"total_amount_to_be_paid": 1182,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Ioannou27",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "C86CFAAEC4D482D26C2E8C525C38E4A5",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"industry_sector": null,
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "200",
"name": "mar27",
"id": "A61127D0DB2D192FCA80787D4D258A36"
},
"total_billed_amount": 197,
"number_of_invoices": null,
"due_date": null,
"id": "6B3B4BCBF0A24C375D37C83A1A5AD882",
"outstanding_amount": null,
"total_credit_amount": null,
"from_date": null,
"classification": "MAX_CREDIT_AMT_REACHED",
"total_debit_amount": null,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"bill_items_set": [
{
"type": "NORMAL",
"id": "9B19E9FD39E08E6773914FAF4611AC58",
"invoice": {
"udf_float_1": null,
"udf_float_2": null,
"invoice_item_set": [
{
"vat_percentage": 0,
"sub_total": 15,
"discount_amount": 0,
"vat_rate": null,
"discount_percentage": 0,
"net_amount": 15,
"id": "E676459186448E4B7DF875B42F6CADE4",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "One Time Services",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"description": "A type which is used for one time services",
"alternative_code": "OTS"
},
"id": "891E24F7F1C8C79A1E179B670680E611",
"description": null,
"code": "OTP001",
"alternative_code": "OTP001"
}
},
{
"vat_percentage": 0,
"sub_total": 60,
"discount_amount": 0,
"vat_rate": null,
"discount_percentage": 0,
"net_amount": 60,
"id": "3D6B169A16BEE648166CC2B36BBE75CE",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product": {
"product_type": {
"physical_good_type": "NONTRACEABLE",
"service_type": null,
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Accessories",
"id": "0F94B51F175F06A475EB2948B4030074",
"description": "A type which is used for accessories physical goods",
"alternative_code": "005"
},
"id": "58DB60D0C959E2154B14CFA6EB90F88D",
"description": null,
"code": "SSTV0000453",
"alternative_code": "SSTV453"
}
},
{
"vat_percentage": 0,
"sub_total": 92,
"discount_amount": 0,
"vat_rate": null,
"discount_percentage": 0,
"net_amount": 92,
"id": "063E39CDBD3DBE0881FF3C3BB1C96491",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product": {
"product_type": {
"physical_good_type": null,
"service_type": "ONETIME",
"used_for_provisioning": false,
"composition_method": "FLAT",
"classification": "SERVICES",
"name": "One Time Services",
"id": "7EDF537A938DECAB1352E6EEAD54A5D0",
"description": "A type which is used for one time services",
"alternative_code": "OTS"
},
"id": "9485FC0F5C75279E4E8E1FF3B7B247AE",
"description": null,
"code": "OTP002",
"alternative_code": "OTP002"
}
},
{
"vat_percentage": 0,
"sub_total": 30,
"discount_amount": 0,
"vat_rate": null,
"discount_percentage": 0,
"net_amount": 30,
"id": "B06ED4B5AC91F5FC88A1F93D885E9731",
"quantity": 0,
"cost": 0,
"vat_amount": 0,
"product": {
"product_type": {
"physical_good_type": "TRACEABLE",
"service_type": null,
"used_for_provisioning": true,
"composition_method": "FLAT",
"classification": "PHYSICALGOODS",
"name": "Decoders",
"id": "B4A1396AE3D1384B304A0FEB22F7BA50",
"description": "Decoders",
"alternative_code": "D"
},
"id": "1CF94E44CA737F761BFAE1C18D25CE82",
"description": "Set Top Box",
"code": "Set Top Box 001",
"alternative_code": "STB001"
}
}
],
"udf_float_3": null,
"number": null,
"udf_float_4": null,
"due_on": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable": {
"account_owner": {
"last_name": "Ioannou27",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Marios",
"name": null,
"id": "C86CFAAEC4D482D26C2E8C525C38E4A5",
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": null,
"social_security_number": null,
"industry_sector": null,
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"id_issued_by_country": null,
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "200",
"name": "mar27",
"id": "A61127D0DB2D192FCA80787D4D258A36"
},
"discount_amount": 0,
"id": "58DFF6472F5E90534ADA4AF2DF4BDF63",
"outstanding_amount": null,
"posted_on": null,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"vat_amount": 0,
"log_information": {
"created_by_unit": {
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-28T17:35:25",
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"issued_on": "2014-07-29T00:00:00",
"total_amount": 197,
"life_cycle_state": "DRAFT",
"net_amount": 197,
"type": {
"classification": "INVOICE",
"name": "Invoice 1",
"id": "D75737F9C4EDF822BBC1024ADE086695",
"description": "Invoice 1",
"alternative_code": "I1"
},
"rejection_reason": null,
"reference_number": null,
"category": null
}
}
],
"number_of_credit_notes": null,
"normal_billing_run": {
"log_information": {
"created_by_unit": {
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-28T17:35:20",
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"bill_as_of_date": "2014-07-28T00:00:00",
"life_cycle_state": "DRAFT",
"number": null,
"id": "F6960A57C610843F0FBEDA8EED9B3C0E"
},
"total_credit_amount_posted_between_bills": 0,
"log_information": {
"created_by_unit": {
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-28T17:35:25",
"created_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1",
"email": null
}
},
"status": null,
"to_date": null,
"life_cycle_state": "POSTED",
"type": null
}
} |
POST jobs/cancel
This method cancels a job, which is not already completed or cancelled.
| Tip |
|---|
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
job_identifier
(mandatory)
...
The identifier of the job to be cancelled. The allowed job identifier fields are the following:
...
status_identifier
(optional)
...
The status that will be set on the job, after the cancellation. If not specified the the default status for cancelling jobs of that type will be used. The allowed job status identifiers are the following:
...
cancellation_reason_identifier
(mandatory)
...
The reason for cancelling the job. The allowed job cancellation reason identifiers are the following:
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST jobs/start_progress
This method sets a job in progress. This method can be applied only on pending jobs
| Tip |
|---|
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
job_identifier
(mandatory)
...
The identifier of the job that will be started. The allowed job identifier fields are the following:
...
status_identifier
(optional)
...
The status that will be set on the job, after starting the progress. If not specified the the default status for starting jobs of that type will be used. The allowed job status identifiers are the following:
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST jobs/complete
This method completes a job, which is already in progress
| Tip |
|---|
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
job_identifier
(mandatory)
...
The identifier of the job that will be completed. The allowed job identifier fields are the following:
...
status_identifier
(optional)
...
The status that will be set on completing the job. If not specified the the default status for completing jobs of that type will be used. The allowed job status identifiers are the following:
...
performed_by_user_identifier
(optional)
...
The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
| Tip |
|---|
Available from CRM.COM R10.0.0 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||
|---|---|---|---|---|---|---|
|
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"job_identifier" : { "number" : "JOB000592" },
"job_statuses":{"name":"Closed"},
"fields_set":"billing_term_scheme,price_plan,life_cycle_state,type,accounts_receivable"
} |
Response:
| theme | Confluence |
|---|---|
| language | javascript |
| linenumbers | true |
| name | blue |
|---|
| Child pages (Children Display) | ||
|---|---|---|
|