GET bills/show

This method returns information related with a bill.  A single bill is returned by each call

Resource URL

http://host_name/crmapi/rest/$version/bills/show

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be returned as a result. The allowed bill 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

Response Data

Examples

 

HTTP Method: GET

 

Request:

 http://host_name/crmapi/rest/v2/bills/show?token=5CA676AE5104988B9C0BD500B562A46D&bill_identifier=number=123

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_float_3": null,
        "number": "123",
        "udf_float_4": null,
        "udf_string_1": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "previous_bill_total_due_amount": 0,
        "udf_string_4": null,
        "udf_string_5": null,
        "total_amount_to_be_paid": 58.55,
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null,
        "accounts_receivable":
        {
            "account_owner":
            {
                "last_name": "Rowland",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "company_profile": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Jenr",
                "name": "Jenr Rowland",
                "id": "637FBB8D3C83D537C144D2B969597160",
                "company_name": null,
                "demographics":
                {
                    "gender": "FEMALE",
                    "passport_issued_by_country": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "country_of_residence":
                    {
                        "name": "UNITED KINGDOM",
                        "id": "126"
                    },
                    "industry_sector": null,
                    "date_of_birth":
                    {
                        "month": null,
                        "day": null,
                        "year": null
                    },
                    "name_day":
                    {
                        "month": null,
                        "day": null
                    },
                    "id_number": "11111",
                    "id_issued_by_country": null,
                    "industry": null
                }
            },
            "life_cycle_state": "ACTIVE",
            "number": "187",
            "name": "Jen Rownland",
            "id": "2348855A3DEFE25F4B8EAD5ABB987898"
        },
        "total_billed_amount": 58.55,
        "number_of_invoices": 1,
        "due_date": "2014-08-17T16:20:18",
        "id": "1AEB88A11EE89377302F7C10BC16DA17",
        "outstanding_amount": 58.55,
        "total_credit_amount": 0,
        "from_date": null,
        "classification": "MAX_CREDIT_AMT_REACHED",
        "total_debit_amount": 58.55,
        "udf_date_1": null,
        "udf_date_2": null,
        "udf_date_3": null,
        "udf_date_4": null,
        "bill_items_set":
        [
            {
                "type": "NORMAL",
                "id": "CE3CC12F18E744863E0BCC12548218A8",
                "job": null,
                "subscription":
                {
                    "accounts_receivable":
                    {
                        "account_owner":
                        {
                            "last_name": "Rowland",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": null,
                            "company_profile": null,
                            "title": null,
                            "type": "PERSON",
                            "first_name": "Jenr",
                            "name": "Jenr Rowland",
                            "id": "637FBB8D3C83D537C144D2B969597160",
                            "company_name": null,
                            "demographics":
                            {
                                "gender": "FEMALE",
                                "passport_issued_by_country": null,
                                "passport_number": null,
                                "social_security_number": null,
                                "country_of_residence":
                                {
                                    "name": "UNITED KINGDOM",
                                    "id": "126"
                                },
                                "industry_sector": null,
                                "date_of_birth":
                                {
                                    "month": null,
                                    "day": null,
                                    "year": null
                                },
                                "name_day":
                                {
                                    "month": null,
                                    "day": null
                                },
                                "id_number": "11111",
                                "id_issued_by_country": null,
                                "industry": null
                            }
                        },
                        "life_cycle_state": "ACTIVE",
                        "number": "187",
                        "name": "Jen Rownland",
                        "id": "2348855A3DEFE25F4B8EAD5ABB987898"
                    },
                    "life_cycle_state": null,
                    "number": "S60132",
                    "type":
                    {
                        "name": "United Kingdom",
                        "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                        "description": "For subscribers residing in United Kingdom",
                        "alternative_code": "UK"
                    },
                    "id": "0A7313D2F5DA3790190C29278807A406"
                },
                "invoice":
                {
                    "notes": null,
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "invoice_item_set":
                    [
                        {
                            "vat_percentage": 10,
                            "sub_total": 58.55,
                            "discount_amount": 0,
                            "vat_rate":
                            {
                                "name": "Standard 10%",
                                "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                "description": null,
                                "alternative_code": "S10"
                            },
                            "discount_percentage": 0,
                            "net_amount": 53.23,
                            "id": "6B8FF48E9EA00CC9FB3283DBA6C04FEC",
                            "quantity": 0,
                            "cost": 0,
                            "vat_amount": 5.32,
                            "product":
                            {
                                "product_type":
                                {
                                    "physical_good_type": null,
                                    "service_type": "TERMED",
                                    "used_for_provisioning": true,
                                    "composition_method": "FIXEDBUNDLE",
                                    "classification": "SERVICES",
                                    "name": "Subscription Packages",
                                    "id": "BC954969D3172372D498D3BB2BA590A0",
                                    "description": "Subscription main packages",
                                    "alternative_code": "SP"
                                },
                                "id": "6DF884D00A643D9E5E3E95A5ABCCFDF8",
                                "description": "Gold Premium Package",
                                "code": "Gold",
                                "alternative_code": "GPP"
                            }
                        }
                    ],
                    "udf_float_3": null,
                    "number": "I00000276",
                    "udf_float_4": null,
                    "due_on": "2014-08-17T16:20:18",
                    "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": "Rowland",
                            "life_cycle_state": "FINANCIAL",
                            "middle_name": null,
                            "company_profile": null,
                            "title": null,
                            "type": "PERSON",
                            "first_name": "Jenr",
                            "name": "Jenr Rowland",
                            "id": "637FBB8D3C83D537C144D2B969597160",
                            "company_name": null,
                            "demographics":
                            {
                                "gender": "FEMALE",
                                "passport_issued_by_country": null,
                                "passport_number": null,
                                "social_security_number": null,
                                "country_of_residence":
                                {
                                    "name": "UNITED KINGDOM",
                                    "id": "126"
                                },
                                "industry_sector": null,
                                "date_of_birth":
                                {
                                    "month": null,
                                    "day": null,
                                    "year": null
                                },
                                "name_day":
                                {
                                    "month": null,
                                    "day": null
                                },
                                "id_number": "11111",
                                "id_issued_by_country": null,
                                "industry": null
                            }
                        },
                        "life_cycle_state": "ACTIVE",
                        "number": "187",
                        "name": "Jen Rownland",
                        "id": "2348855A3DEFE25F4B8EAD5ABB987898"
                    },
                    "discount_amount": 0,
                    "id": "9F0239136C75DBDA33C714569AB8E523",
                    "outstanding_amount": 58.55,
                    "posted_on": "2014-07-04T16:20:18",
                    "udf_date_1": null,
                    "udf_date_2": null,
                    "udf_date_3": null,
                    "udf_date_4": null,
                    "vat_amount": 5.32,
                    "log_information":
                    {
                        "updated_date": "2014-07-04T16:20:18",
                        "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-04T16:20:18",
                        "updated_by_unit":
                        {
                            "community_name": "Main Community",
                            "group_name": "Main Group",
                            "name": "Admin Unit",
                            "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                            "description": "r1",
                            "alternative_code": "MG"
                        },
                        "created_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1",
                            "email": "mp@ministrator.com"
                        },
                        "updated_by_user":
                        {
                            "person_name": "MPAdministrator",
                            "username": "MPAdministrator",
                            "id": "1",
                            "email": "mp@ministrator.com"
                        }
                    },
                    "issued_on": "2014-07-05T00:00:00",
                    "total_amount": 58.55,
                    "life_cycle_state": "POSTED",
                    "unsettled_amount": 58.55,
                    "rejection_reason": null,
                    "net_amount": 53.23,
                    "type":
                    {
                        "classification": "INVOICE",
                        "name": "Invoice 1",
                        "id": "D75737F9C4EDF822BBC1024ADE086695",
                        "description": "Invoice 1",
                        "alternative_code": "I1"
                    },
                    "reference_number": "302",
                    "category": null
                }
            }
        ],
        "number_of_credit_notes": 0,
        "usage_data_records_set":
        [
        ],
        "normal_billing_run":
        {
            "log_information":
            {
                "updated_date": "2014-07-04T16:20:19",
                "created_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_date": "2014-07-04T16:16:34",
                "updated_by_unit":
                {
                    "group_name": null,
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": null
                }
            },
            "bill_as_of_date": "2014-10-01T00:00:00",
            "life_cycle_state": "COMPLETED",
            "number": "152",
            "id": "FCBDFB894788827B83083166293DE2FD"
        },
        "total_credit_amount_posted_between_bills": 0,
        "log_information":
        {
            "updated_date": "2014-07-04T16:20:18",
            "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-04T16:20:18",
            "updated_by_unit":
            {
                "community_name": "Main Community",
                "group_name": "Main Group",
                "name": "Admin Unit",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            },
            "updated_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "mp@ministrator.com"
            }
        },
        "status": "UNSETTLED",
        "to_date": null,
        "life_cycle_state": "POSTED",
        "unsettled_amount": 58.55,
        "type": "NORMAL"
    }
}

 

HTTP Method: GET

 

Request:

 http://host_name/crmapi/rest/v2/bills/show?token={{token}}&bill_identifier=number=113

Response:

{
  "data": {
    "log_information": {
      "created_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "updated_by_unit": {
        "alternative_code": "adminunit",
        "group_name": "Main Group",
        "community_name": "Community",
        "name": "Admin Unit",
        "description": "admin unit",
        "id": "1"
      },
      "created_date": "2016-03-17T17:07:51",
      "updated_date": "2016-03-17T17:07:51",
      "updated_by_user": {
        "person_name": "p_kestora",
        "id": "3BF7083426A7443CA7960041E5846F1E",
        "email": "p_kestora@crm.com",
        "username": "p_kestora"
      },
      "created_by_user": {
        "person_name": "p_kestora",
        "id": "3BF7083426A7443CA7960041E5846F1E",
        "email": "p_kestora@crm.com",
        "username": "p_kestora"
      }
    },
    "total_debit_amount": 750,
    "type": "NORMAL",
    "udf_date_2": null,
    "udf_date_1": null,
    "udf_date_4": null,
    "udf_date_3": null,
    "number": "113",
    "udf_float_3": null,
    "udf_float_4": null,
    "to_date": "2018-07-01T00:00:00",
    "normal_billing_run": {
      "number": "58",
      "log_information": {
        "created_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "updated_by_unit": {
          "alternative_code": "adminunit",
          "name": "Admin Unit",
          "description": "admin unit",
          "id": "1"
        },
        "created_date": "2016-03-17T17:07:50",
        "updated_date": "2016-03-17T17:07:51",
        "updated_by_user": {
          "person_name": "p_kestora",
          "id": "3BF7083426A7443CA7960041E5846F1E",
          "username": "p_kestora"
        },
        "created_by_user": {
          "person_name": "p_kestora",
          "id": "3BF7083426A7443CA7960041E5846F1E",
          "username": "p_kestora"
        }
      },
      "id": "2CBEA707957549DF8C4558F966B98820",
      "life_cycle_state": "ASSEMBLING_POSTING",
      "bill_as_of_date": "2017-07-30T15:00:00"
    },
    "currency": {
      "suffix_symbol": null,
      "prefix_symbol": "€",
      "decimal_part_name": null,
      "code": "EUR",
      "integer_part_name": null,
      "id": "2"
    },
    "id": "6FA16540B513487995A07BA2AF659A6A",
    "udf_float_1": null,
    "udf_float_2": null,
    "udf_string_2": null,
    "udf_string_3": null,
    "total_credit_amount_posted_between_bills": 0,
    "udf_string_4": null,
    "udf_string_5": null,
    "from_date": "2017-04-01T00:00:00",
    "total_credit_amount": 0,
    "udf_string_1": null,
    "due_date": "2016-04-18T17:07:51",
    "bill_items_set": [
      {
        "usage_detail_records_set": [],
        "id": "931087D9078E436CB7CC75C515AD4F99",
        "invoice": {
          "notes": null,
          "log_information": {
            "created_by_unit": {
              "alternative_code": "adminunit",
              "group_name": "Main Group",
              "community_name": "Community",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "updated_by_unit": {
              "alternative_code": "adminunit",
              "group_name": "Main Group",
              "community_name": "Community",
              "name": "Admin Unit",
              "description": "admin unit",
              "id": "1"
            },
            "created_date": "2016-03-17T17:07:51",
            "updated_date": "2016-03-22T07:57:16",
            "updated_by_user": {
              "person_name": "p_kestora",
              "id": "3BF7083426A7443CA7960041E5846F1E",
              "email": "p_kestora@crm.com",
              "username": "p_kestora"
            },
            "created_by_user": {
              "person_name": "p_kestora",
              "id": "3BF7083426A7443CA7960041E5846F1E",
              "email": "p_kestora@crm.com",
              "username": "p_kestora"
            }
          },
          "discount_amount": 0,
          "currency_rate_period": null,
          "udf_date_2": null,
          "type": {
            "alternative_code": "INV",
            "name": "Invoice",
            "description": null,
            "id": "INVOICE",
            "classification": "INVOICE"
          },
          "udf_date_1": null,
          "due_on": "2016-04-18T17:07:51",
          "udf_date_4": null,
          "udf_date_3": null,
          "invoice_item_set": [
            {
              "product": {
                "code": "Gold",
                "product_type": {
                  "service_type": "TERMED",
                  "used_for_provisioning": true,
                  "alternative_code": "Main Packages",
                  "composition_method": "FLAT",
                  "name": "Main Packages",
                  "description": null,
                  "id": "E186E293AAAB49EE86A729540A4287FE",
                  "classification": "SERVICES",
                  "physical_good_type": null
                },
                "alternative_code": "G",
                "description": null,
                "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
              },
              "quantity": 1,
              "cost": 688.07,
              "vat_amount": 61.93,
              "discount_amount": 0,
              "sub_total": 750,
              "id": "CCFF19241AC44757A660791A048C29B8",
              "net_amount": 688.07,
              "discount_percentage": 0,
              "vat_percentage": 9,
              "vat_rate": {
                "alternative_code": "VAT 9%",
                "name": "VAT 9%",
                "description": null,
                "id": "48ADFA77916048328685049A3B7E3F64"
              }
            }
          ],
          "number": "334",
          "udf_float_3": null,
          "udf_float_4": null,
          "vat_amount": 61.93,
          "rejection_reason": null,
          "id": "0BC91A2D5FCC486580C895EEBE379EB7",
          "udf_float_1": null,
          "udf_float_2": null,
          "udf_string_2": null,
          "udf_string_3": null,
          "accounting_period_information": null,
          "udf_string_4": null,
          "udf_string_5": null,
          "udf_string_1": null,
          "accounts_receivable": {
            "number": "ACR0000000069",
            "name": "ACR0000000069 Polina Kestora",
            "id": "8C1E866074D743EE834E910A28C1E582",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": "Polina Kestora",
              "last_name": "Kestora",
              "id": "F038161F36C845B98CEE7361A8C92157",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Polina",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "112233",
                "gender": "FEMALE",
                "country_of_residence": {
                  "alternative_code": "IRN",
                  "three_character_code": null,
                  "name": "IRAN (ISLAMIC REPUBLIC OF)",
                  "id": "231",
                  "two_character_code": null
                },
                "date_of_birth": {
                  "month": 3,
                  "year": 1988,
                  "day": 4
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
              }
            }
          },
          "life_cycle_state": "POSTED",
          "reference_number": "333",
          "posted_on": "2016-03-17T17:07:51",
          "total_amount": 750,
          "unsettled_amount": 0,
          "issued_on": "2016-03-18T00:00:00",
          "net_amount": 688.07,
          "outstanding_amount": 0,
          "udf_string_6": null,
          "category": null,
          "udf_string_7": null,
          "udf_string_8": null,
          "back_office_code": null
        },
        "subscription": {
          "number": "S0000000101",
          "first_activated_date": "2016-03-20T15:00:00",
          "rating_state": "PENDING",
          "accounts_receivable": {
            "number": "ACR0000000069",
            "name": "ACR0000000069 Polina Kestora",
            "id": "8C1E866074D743EE834E910A28C1E582",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
              "company_profile": null,
              "company_name": null,
              "name": "Polina Kestora",
              "last_name": "Kestora",
              "id": "F038161F36C845B98CEE7361A8C92157",
              "life_cycle_state": "FINANCIAL",
              "middle_name": null,
              "title": null,
              "type": "PERSON",
              "first_name": "Polina",
              "demographics": {
                "name_day": {
                  "month": null,
                  "day": null
                },
                "id_number": "112233",
                "gender": "FEMALE",
                "country_of_residence": {
                  "alternative_code": "IRN",
                  "three_character_code": null,
                  "name": "IRAN (ISLAMIC REPUBLIC OF)",
                  "id": "231",
                  "two_character_code": null
                },
                "date_of_birth": {
                  "month": 3,
                  "year": 1988,
                  "day": 4
                },
                "industry_sector": null,
                "passport_number": null,
                "industry": null,
                "social_security_number": null,
                "id_issued_by_country": null,
                "passport_issued_by_country": null
              }
            }
          },
          "id": "C49FC7CF5F754ED2BACDF729994703BF",
          "life_cycle_state": "EFFECTIVE",
          "type": {
            "alternative_code": "normalsub",
            "name": "Normal",
            "description": null,
            "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
          }
        },
        "type": "NORMAL",
        "job": null,
        "applied_additive_discounts_set": []
      }
    ],
    "accounts_receivable": {
      "number": "ACR0000000069",
      "name": "ACR0000000069 Polina Kestora",
      "id": "8C1E866074D743EE834E910A28C1E582",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": "Polina Kestora",
        "last_name": "Kestora",
        "id": "F038161F36C845B98CEE7361A8C92157",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "Polina",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": "112233",
          "gender": "FEMALE",
          "country_of_residence": {
            "alternative_code": "IRN",
            "three_character_code": null,
            "name": "IRAN (ISLAMIC REPUBLIC OF)",
            "id": "231",
            "two_character_code": null
          },
          "date_of_birth": {
            "month": 3,
            "year": 1988,
            "day": 4
          },
          "industry_sector": null,
          "passport_number": null,
          "industry": null,
          "social_security_number": null,
          "id_issued_by_country": null,
          "passport_issued_by_country": null
        }
      }
    },
    "life_cycle_state": "POSTED",
    "classification": "NORMAL",
    "number_of_credit_notes": 0,
    "number_of_invoices": 1,
    "unsettled_amount": 0,
    "previous_bill_total_due_amount": 0,
    "balance_brought_forward": 0,
    "total_billed_amount": 750,
    "outstanding_amount": 0,
    "total_amount_to_be_paid": 750,
    "udf_string_6": null,
    "udf_string_7": null,
    "udf_string_8": null,
    "status": "SETTLED"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET bills/list

This method returns information related with bills allocated in a specific accounts receivable. Multiple bills are returned by each call

Resource URL

http://host_name/crmapi/rest/$version/bills/list

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable 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

Response Data

Examples

 

HTTP Method: GET

 

Request:

 http://host_name/crmapi/rest/v2/bills/list?token=21B932089D63DBB4D90B4DBF4817AC68&accounts_receivable_identifier=number=183&fields_set=id,number,status

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "status": "UNSETTLED",
            "number": "103",
            "id": "F834AD5494C82586235DC28A2337D487"
        },
        {
            "status": "UNSETTLED",
            "number": "104",
            "id": "8F1EB6D457406417D1BE51A225DB2D3D"
        },
        {
            "status": "UNSETTLED",
            "number": "105",
            "id": "515DFDA7BBA6A46AD5C19467A69139D2"
        },
        {
            "status": "UNSETTLED",
            "number": "106",
            "id": "FFE6BC247B06A49E86B6E2121624F06F"
        },
        {
            "status": "SETTLED",
            "number": "107",
            "id": "ACCE0F005C93CBF2296D2E40E3C61283"
        },
        {
            "status": "UNSETTLED",
            "number": "117",
            "id": "CCB6B32B153D09456286EE91B88AF9E1"
        }
    ]
}

 

HTTP Method: GET

 

Request:

 http://host_name/crmapi/rest/v2/bills/list?token={{token}}&accounts_receivable_identifier=number=ACR0000000069&fields_set=id,number,currency

Response:

{
  "data": [
    {
      "number": "168",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "71A7BF9BA6CB4CE2A39516A432F6B5BF"
    },
    {
      "number": "133",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "89498604D4C4442DBD119843EFB68C99"
    },
    {
      "number": "134",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "2FCB201784E64B41B81F1EA539F28F55"
    },
    {
      "number": "135",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "C24091ACB6724CCBB27715331D9C1912"
    },
    {
      "number": "136",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "796E1BCA8EEB44F4B9B539D50A94553C"
    },
    {
      "number": "141",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "126F52EDFC8544348A9F79B49D45F9B7"
    },
    {
      "number": "112",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "E4E7ADFDB0974017811991E5A5EEF404"
    },
    {
      "number": "115",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "F6ED0266A9974167A1E409EFAABFC562"
    },
    {
      "number": "113",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "6FA16540B513487995A07BA2AF659A6A"
    },
    {
      "number": "116",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "51744741A2CE4FFA8AE24A6213F41D16"
    },
    {
      "number": "111",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "A192073D4C784F549183E421D29C3D36"
    },
    {
      "number": "117",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "5FC07EF848404A1DA205F102FF09588B"
    },
    {
      "number": "157",
      "currency": {
        "suffix_symbol": null,
        "prefix_symbol": "€",
        "decimal_part_name": null,
        "code": "EUR",
        "integer_part_name": null,
        "id": "2"
      },
      "id": "9B70A9D1CA91489EA8D6ADF273A2C2DA"
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

GET bills/get_latest

This method is used to get the latest bills allocated against a specific accounts receivable

Resource URL

http://host_name/crmapi/rest/$version/bills/get_latest

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:

number

(mandatory)

 Number

The number of bills to be retrieved, starting from the latest one

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

Response Data

Examples

 

HTTP Method: GET

 

Request:

 http://host_name/crmapi/rest/v2/bills/get_latest?token=21B932089D63DBB4D90B4DBF4817AC68&accounts_receivable_identifier=number=183&number=2&fields_set=id,number,status

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "status": "UNSETTLED",
            "number": "117",
            "id": "CCB6B32B153D09456286EE91B88AF9E1"
        },
        {
            "status": "SETTLED",
            "number": "107",
            "id": "ACCE0F005C93CBF2296D2E40E3C61283"
        }
    ]
}

GET bills/get_unsettled

This method is used to get the unsettled bills allocated against a specific accounts receivable

Resource URL

http://host_name/crmapi/rest/$version/bills/get_unsettled

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable 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

Response Data

Examples

 

HTTP Method: GET

 

Request:

http://host_name/crmapi/rest/v2/bills/get_unsettled?token=21B932089D63DBB4D90B4DBF4817AC68&accounts_receivable_identifier=number=183&fields_set=id,number,status

Response:

      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "status": "UNSETTLED",
            "number": "103",
            "id": "F834AD5494C82586235DC28A2337D487"
        },
        {
            "status": "UNSETTLED",
            "number": "104",
            "id": "8F1EB6D457406417D1BE51A225DB2D3D"
        },
        {
            "status": "UNSETTLED",
            "number": "105",
            "id": "515DFDA7BBA6A46AD5C19467A69139D2"
        },
        {
            "status": "UNSETTLED",
            "number": "106",
            "id": "FFE6BC247B06A49E86B6E2121624F06F"
        },
        {
            "status": "UNSETTLED",
            "number": "117",
            "id": "CCB6B32B153D09456286EE91B88AF9E1"
        }
    ]
}

GET bills/get_partially_settled

This method is used to get the partially settled bills allocated against a specific accounts receivable

Resource URL

http://host_name/crmapi/rest/$version/bills/get_partially_settled

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable 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

Response Data

Examples

 

HTTP Method: GET

 

Request:

http://host_name/crmapi/rest/v2/bills/get_partially_settled?token=21B932089D63DBB4D90B4DBF4817AC68&accounts_receivable_identifier=number=182

Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "131",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "previous_bill_total_due_amount": 266.51,
            "udf_string_4": null,
            "udf_string_5": null,
            "total_amount_to_be_paid": 570.78,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou22",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": "Marios Ioannou22",
                    "id": "EE604F2A863168629720ED1AAAF4D282",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "983649",
                        "social_security_number": "9302",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 9,
                            "day": 9,
                            "year": 1995
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "9872632",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "182",
                "name": "mar22",
                "id": "CB0E67B80E7ED9D81455757807B191F0"
            },
            "total_billed_amount": 304.27,
            "number_of_invoices": 1,
            "due_date": "2014-08-16T16:34:04",
            "id": "199ECE08A89B1ADFE7A2B205EB5A17FF",
            "outstanding_amount": 51.78,
            "total_credit_amount": 0,
            "from_date": null,
            "classification": "NORMAL",
            "total_debit_amount": 304.27,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "bill_items_set":
            [
                {
                    "type": "NORMAL",
                    "id": "BFA99757BEB7CA09FB3E9949714821DB",
                    "job": null,
                    "subscription":
                    {
                        "accounts_receivable":
                        {
                            "account_owner":
                            {
                                "last_name": "Ioannou22",
                                "life_cycle_state": "FINANCIAL",
                                "middle_name": null,
                                "company_profile": null,
                                "title": null,
                                "type": "PERSON",
                                "first_name": "Marios",
                                "name": "Marios Ioannou22",
                                "id": "EE604F2A863168629720ED1AAAF4D282",
                                "company_name": null,
                                "demographics":
                                {
                                    "gender": "MALE",
                                    "passport_issued_by_country": null,
                                    "passport_number": "983649",
                                    "social_security_number": "9302",
                                    "country_of_residence":
                                    {
                                        "name": "UNITED KINGDOM",
                                        "id": "126"
                                    },
                                    "industry_sector": null,
                                    "date_of_birth":
                                    {
                                        "month": 9,
                                        "day": 9,
                                        "year": 1995
                                    },
                                    "name_day":
                                    {
                                        "month": null,
                                        "day": null
                                    },
                                    "id_number": "9872632",
                                    "id_issued_by_country": null,
                                    "industry": null
                                }
                            },
                            "life_cycle_state": "ACTIVE",
                            "number": "182",
                            "name": "mar22",
                            "id": "CB0E67B80E7ED9D81455757807B191F0"
                        },
                        "life_cycle_state": null,
                        "number": "S60126",
                        "type":
                        {
                            "name": "London",
                            "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                            "description": "For Subscribers residing in London
",
                            "alternative_code": "LND"
                        },
                        "id": "ABF172A7F5654F4F3D404F544DE63170"
                    },
                    "invoice":
                    {
                        "notes": null,
                        "udf_float_1": null,
                        "udf_float_2": null,
                        "invoice_item_set":
                        [
                            {
                                "vat_percentage": 10,
                                "sub_total": 84.52,
                                "discount_amount": 0,
                                "vat_rate":
                                {
                                    "name": "Standard 10%",
                                    "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                    "description": null,
                                    "alternative_code": "S10"
                                },
                                "discount_percentage": 0,
                                "net_amount": 76.84,
                                "id": "F410F89E039B0839EC418AF149AF827F",
                                "quantity": 0,
                                "cost": 0,
                                "vat_amount": 7.68,
                                "product":
                                {
                                    "product_type":
                                    {
                                        "physical_good_type": null,
                                        "service_type": "TERMED",
                                        "used_for_provisioning": true,
                                        "composition_method": "FLAT",
                                        "classification": "SERVICES",
                                        "name": "Subscription services",
                                        "id": "600438B64B0F05AB3D020C902674949F",
                                        "description": "Subscription services",
                                        "alternative_code": "SS"
                                    },
                                    "id": "4D55A6EC2FF25A44B9945B88940AF1A0",
                                    "description": "Sports 2 Packages",
                                    "code": "Sports 2",
                                    "alternative_code": "S2"
                                }
                            },
                            {
                                "vat_percentage": 10,
                                "sub_total": 135.23,
                                "discount_amount": 0,
                                "vat_rate":
                                {
                                    "name": "Standard 10%",
                                    "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                    "description": null,
                                    "alternative_code": "S10"
                                },
                                "discount_percentage": 0,
                                "net_amount": 122.94,
                                "id": "46B47097DF75EE3928A0E2D105835948",
                                "quantity": 0,
                                "cost": 0,
                                "vat_amount": 12.29,
                                "product":
                                {
                                    "product_type":
                                    {
                                        "physical_good_type": null,
                                        "service_type": "TERMED",
                                        "used_for_provisioning": true,
                                        "composition_method": "FIXEDBUNDLE",
                                        "classification": "SERVICES",
                                        "name": "Subscription Packages",
                                        "id": "BC954969D3172372D498D3BB2BA590A0",
                                        "description": "Subscription main packages",
                                        "alternative_code": "SP"
                                    },
                                    "id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
                                    "description": "Bronze Package",
                                    "code": "Bronze",
                                    "alternative_code": "BP"
                                }
                            },
                            {
                                "vat_percentage": 10,
                                "sub_total": 84.52,
                                "discount_amount": 0,
                                "vat_rate":
                                {
                                    "name": "Standard 10%",
                                    "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                    "description": null,
                                    "alternative_code": "S10"
                                },
                                "discount_percentage": 0,
                                "net_amount": 76.84,
                                "id": "7F1BF75C207C703BF6D5E22AFF5EB5A1",
                                "quantity": 0,
                                "cost": 0,
                                "vat_amount": 7.68,
                                "product":
                                {
                                    "product_type":
                                    {
                                        "physical_good_type": null,
                                        "service_type": "TERMED",
                                        "used_for_provisioning": true,
                                        "composition_method": "FLAT",
                                        "classification": "SERVICES",
                                        "name": "Subscription services",
                                        "id": "600438B64B0F05AB3D020C902674949F",
                                        "description": "Subscription services",
                                        "alternative_code": "SS"
                                    },
                                    "id": "CA3ACA47666F6CB6EECB3C15D1F0221A",
                                    "description": " Package",
                                    "code": "Cartoons 1 ",
                                    "alternative_code": "C1"
                                }
                            }
                        ],
                        "udf_float_3": null,
                        "number": "I00000284",
                        "udf_float_4": null,
                        "due_on": "2014-08-16T16:34:04",
                        "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": "Ioannou22",
                                "life_cycle_state": "FINANCIAL",
                                "middle_name": null,
                                "company_profile": null,
                                "title": null,
                                "type": "PERSON",
                                "first_name": "Marios",
                                "name": "Marios Ioannou22",
                                "id": "EE604F2A863168629720ED1AAAF4D282",
                                "company_name": null,
                                "demographics":
                                {
                                    "gender": "MALE",
                                    "passport_issued_by_country": null,
                                    "passport_number": "983649",
                                    "social_security_number": "9302",
                                    "country_of_residence":
                                    {
                                        "name": "UNITED KINGDOM",
                                        "id": "126"
                                    },
                                    "industry_sector": null,
                                    "date_of_birth":
                                    {
                                        "month": 9,
                                        "day": 9,
                                        "year": 1995
                                    },
                                    "name_day":
                                    {
                                        "month": null,
                                        "day": null
                                    },
                                    "id_number": "9872632",
                                    "id_issued_by_country": null,
                                    "industry": null
                                }
                            },
                            "life_cycle_state": "ACTIVE",
                            "number": "182",
                            "name": "mar22",
                            "id": "CB0E67B80E7ED9D81455757807B191F0"
                        },
                        "discount_amount": 0,
                        "id": "AE1022E3FA612874F2D6ACD0E8755A7C",
                        "outstanding_amount": 51.779999999999916,
                        "posted_on": "2014-07-04T16:34:04",
                        "udf_date_1": null,
                        "udf_date_2": null,
                        "udf_date_3": null,
                        "udf_date_4": null,
                        "vat_amount": 27.65,
                        "log_information":
                        {
                            "updated_date": "2014-08-01T17:17:55",
                            "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-04T16:34:01",
                            "updated_by_unit":
                            {
                                "community_name": "Main Community",
                                "group_name": "Main Group",
                                "name": "Admin Unit",
                                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                                "description": "r1",
                                "alternative_code": "MG"
                            },
                            "created_by_user":
                            {
                                "person_name": "MPAdministrator",
                                "username": "MPAdministrator",
                                "id": "1",
                                "email": "mp@ministrator.com"
                            },
                            "updated_by_user":
                            {
                                "person_name": "MPAdministrator",
                                "username": "MPAdministrator",
                                "id": "1",
                                "email": "mp@ministrator.com"
                            }
                        },
                        "issued_on": "2014-07-05T00:00:00",
                        "total_amount": 304.27,
                        "life_cycle_state": "POSTED",
                        "unsettled_amount": 51.779999999999916,
                        "rejection_reason": null,
                        "net_amount": 276.62,
                        "type":
                        {
                            "classification": "INVOICE",
                            "name": "Invoice 1",
                            "id": "D75737F9C4EDF822BBC1024ADE086695",
                            "description": "Invoice 1",
                            "alternative_code": "I1"
                        },
                        "reference_number": "310",
                        "category": null
                    }
                }
            ],
            "number_of_credit_notes": 0,
            "usage_data_records_set":
            [
            ],
            "normal_billing_run":
            {
                "log_information":
                {
                    "updated_date": "2014-07-04T16:34:07",
                    "created_by_unit":
                    {
                        "group_name": null,
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_date": "2014-07-04T16:30:36",
                    "updated_by_unit":
                    {
                        "group_name": null,
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    }
                },
                "bill_as_of_date": "2014-12-01T00:00:00",
                "life_cycle_state": "COMPLETED",
                "number": "154",
                "id": "846AC930A883298B1297B3A5FB1D64CA"
            },
            "total_credit_amount_posted_between_bills": 0,
            "log_information":
            {
                "updated_date": "2014-07-04T16:34:03",
                "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-04T16:34:02",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "status": "PARTIALLY_SETTLED",
            "to_date": null,
            "life_cycle_state": "POSTED",
            "unsettled_amount": 51.78,
            "type": "NORMAL"
        },
        {
            "udf_float_1": null,
            "udf_float_2": null,
            "udf_float_3": null,
            "number": "146",
            "udf_float_4": null,
            "udf_string_1": null,
            "udf_string_2": null,
            "udf_string_3": null,
            "previous_bill_total_due_amount": 52.90999999999992,
            "udf_string_4": null,
            "udf_string_5": null,
            "total_amount_to_be_paid": 273.9099999999999,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou22",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": null,
                    "type": "PERSON",
                    "first_name": "Marios",
                    "name": "Marios Ioannou22",
                    "id": "EE604F2A863168629720ED1AAAF4D282",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country": null,
                        "passport_number": "983649",
                        "social_security_number": "9302",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": 9,
                            "day": 9,
                            "year": 1995
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "9872632",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "182",
                "name": "mar22",
                "id": "CB0E67B80E7ED9D81455757807B191F0"
            },
            "total_billed_amount": 221,
            "number_of_invoices": 1,
            "due_date": "2014-08-16T13:17:26",
            "id": "29FE91F59FD0FFD6787A12AB2D3D970F",
            "outstanding_amount": 75.36,
            "total_credit_amount": 0,
            "from_date": null,
            "classification": "NORMAL",
            "total_debit_amount": 221,
            "udf_date_1": null,
            "udf_date_2": null,
            "udf_date_3": null,
            "udf_date_4": null,
            "bill_items_set":
            [
                {
                    "type": "NORMAL",
                    "id": "0A7FA8CB9BFF58317AC9268EB8DD3AC4",
                    "job": null,
                    "subscription":
                    {
                        "accounts_receivable":
                        {
                            "account_owner":
                            {
                                "last_name": "Ioannou22",
                                "life_cycle_state": "FINANCIAL",
                                "middle_name": null,
                                "company_profile": null,
                                "title": null,
                                "type": "PERSON",
                                "first_name": "Marios",
                                "name": "Marios Ioannou22",
                                "id": "EE604F2A863168629720ED1AAAF4D282",
                                "company_name": null,
                                "demographics":
                                {
                                    "gender": "MALE",
                                    "passport_issued_by_country": null,
                                    "passport_number": "983649",
                                    "social_security_number": "9302",
                                    "country_of_residence":
                                    {
                                        "name": "UNITED KINGDOM",
                                        "id": "126"
                                    },
                                    "industry_sector": null,
                                    "date_of_birth":
                                    {
                                        "month": 9,
                                        "day": 9,
                                        "year": 1995
                                    },
                                    "name_day":
                                    {
                                        "month": null,
                                        "day": null
                                    },
                                    "id_number": "9872632",
                                    "id_issued_by_country": null,
                                    "industry": null
                                }
                            },
                            "life_cycle_state": "ACTIVE",
                            "number": "182",
                            "name": "mar22",
                            "id": "CB0E67B80E7ED9D81455757807B191F0"
                        },
                        "life_cycle_state": null,
                        "number": "S60126",
                        "type":
                        {
                            "name": "London",
                            "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                            "description": "For Subscribers residing in London
",
                            "alternative_code": "LND"
                        },
                        "id": "ABF172A7F5654F4F3D404F544DE63170"
                    },
                    "invoice":
                    {
                        "notes": null,
                        "udf_float_1": null,
                        "udf_float_2": null,
                        "invoice_item_set":
                        [
                            {
                                "vat_percentage": 10,
                                "sub_total": 136,
                                "discount_amount": 0,
                                "vat_rate":
                                {
                                    "name": "Standard 10%",
                                    "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                    "description": null,
                                    "alternative_code": "S10"
                                },
                                "discount_percentage": 0,
                                "net_amount": 123.64,
                                "id": "F40F7325389C1298C107EC590B6F8931",
                                "quantity": 0,
                                "cost": 0,
                                "vat_amount": 12.36,
                                "product":
                                {
                                    "product_type":
                                    {
                                        "physical_good_type": null,
                                        "service_type": "TERMED",
                                        "used_for_provisioning": true,
                                        "composition_method": "FIXEDBUNDLE",
                                        "classification": "SERVICES",
                                        "name": "Subscription Packages",
                                        "id": "BC954969D3172372D498D3BB2BA590A0",
                                        "description": "Subscription main packages",
                                        "alternative_code": "SP"
                                    },
                                    "id": "CAD1E31269B76D7A65ACCE45B2E68DFD",
                                    "description": "Bronze Package",
                                    "code": "Bronze",
                                    "alternative_code": "BP"
                                }
                            },
                            {
                                "vat_percentage": 10,
                                "sub_total": 85,
                                "discount_amount": 0,
                                "vat_rate":
                                {
                                    "name": "Standard 10%",
                                    "id": "F170FB2FF32E8C4F5A569E8F3B461E1F",
                                    "description": null,
                                    "alternative_code": "S10"
                                },
                                "discount_percentage": 0,
                                "net_amount": 77.27,
                                "id": "0565A14BA3C4D410A3CD8846F46BDD82",
                                "quantity": 0,
                                "cost": 0,
                                "vat_amount": 7.73,
                                "product":
                                {
                                    "product_type":
                                    {
                                        "physical_good_type": null,
                                        "service_type": "TERMED",
                                        "used_for_provisioning": true,
                                        "composition_method": "FLAT",
                                        "classification": "SERVICES",
                                        "name": "Subscription services",
                                        "id": "600438B64B0F05AB3D020C902674949F",
                                        "description": "Subscription services",
                                        "alternative_code": "SS"
                                    },
                                    "id": "4D55A6EC2FF25A44B9945B88940AF1A0",
                                    "description": "Sports 2 Packages",
                                    "code": "Sports 2",
                                    "alternative_code": "S2"
                                }
                            }
                        ],
                        "udf_float_3": null,
                        "number": "I00000301",
                        "udf_float_4": null,
                        "due_on": "2014-08-16T13:17:26",
                        "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": "Ioannou22",
                                "life_cycle_state": "FINANCIAL",
                                "middle_name": null,
                                "company_profile": null,
                                "title": null,
                                "type": "PERSON",
                                "first_name": "Marios",
                                "name": "Marios Ioannou22",
                                "id": "EE604F2A863168629720ED1AAAF4D282",
                                "company_name": null,
                                "demographics":
                                {
                                    "gender": "MALE",
                                    "passport_issued_by_country": null,
                                    "passport_number": "983649",
                                    "social_security_number": "9302",
                                    "country_of_residence":
                                    {
                                        "name": "UNITED KINGDOM",
                                        "id": "126"
                                    },
                                    "industry_sector": null,
                                    "date_of_birth":
                                    {
                                        "month": 9,
                                        "day": 9,
                                        "year": 1995
                                    },
                                    "name_day":
                                    {
                                        "month": null,
                                        "day": null
                                    },
                                    "id_number": "9872632",
                                    "id_issued_by_country": null,
                                    "industry": null
                                }
                            },
                            "life_cycle_state": "ACTIVE",
                            "number": "182",
                            "name": "mar22",
                            "id": "CB0E67B80E7ED9D81455757807B191F0"
                        },
                        "discount_amount": 0,
                        "id": "4DEFEB09AE0B51C5EB792BC168817F4E",
                        "outstanding_amount": 75.35999999999999,
                        "posted_on": "2014-07-16T13:17:26",
                        "udf_date_1": null,
                        "udf_date_2": null,
                        "udf_date_3": null,
                        "udf_date_4": null,
                        "vat_amount": 20.09,
                        "log_information":
                        {
                            "updated_date": "2014-08-01T17:17:55",
                            "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-16T13:17:25",
                            "updated_by_unit":
                            {
                                "community_name": "Main Community",
                                "group_name": "Main Group",
                                "name": "Admin Unit",
                                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                                "description": "r1",
                                "alternative_code": "MG"
                            },
                            "created_by_user":
                            {
                                "person_name": "JackH",
                                "username": "JackH",
                                "id": "B8650C555C4EA8C741103961276E7773",
                                "email": "j_hadjicosti@crm.com"
                            },
                            "updated_by_user":
                            {
                                "person_name": "MPAdministrator",
                                "username": "MPAdministrator",
                                "id": "1",
                                "email": "mp@ministrator.com"
                            }
                        },
                        "issued_on": "2014-07-17T00:00:00",
                        "total_amount": 221,
                        "life_cycle_state": "POSTED",
                        "unsettled_amount": 75.35999999999999,
                        "rejection_reason": null,
                        "net_amount": 200.91,
                        "type":
                        {
                            "classification": "INVOICE",
                            "name": "Invoice 1",
                            "id": "D75737F9C4EDF822BBC1024ADE086695",
                            "description": "Invoice 1",
                            "alternative_code": "I1"
                        },
                        "reference_number": "331",
                        "category": null
                    }
                }
            ],
            "number_of_credit_notes": 0,
            "usage_data_records_set":
            [
            ],
            "normal_billing_run":
            {
                "log_information":
                {
                    "updated_date": "2014-07-30T17:02:21",
                    "created_by_unit":
                    {
                        "group_name": null,
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_date": "2014-07-16T13:17:21",
                    "updated_by_unit":
                    {
                        "group_name": null,
                        "name": "Admin Unit",
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "description": "r1",
                        "alternative_code": "MG"
                    },
                    "created_by_user":
                    {
                        "person_name": "JackH",
                        "username": "JackH",
                        "id": "B8650C555C4EA8C741103961276E7773",
                        "email": null
                    },
                    "updated_by_user":
                    {
                        "person_name": "MPAdministrator",
                        "username": "MPAdministrator",
                        "id": "1",
                        "email": null
                    }
                },
                "bill_as_of_date": "2015-12-31T00:00:00",
                "life_cycle_state": "COMPLETED",
                "number": "194",
                "id": "B7FD5E0A61AC70B6490E835A11FED1D7"
            },
            "total_credit_amount_posted_between_bills": 0,
            "log_information":
            {
                "updated_date": "2014-07-30T17:02:21",
                "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-16T13:17:25",
                "updated_by_unit":
                {
                    "community_name": "Main Community",
                    "group_name": "Main Group",
                    "name": "Admin Unit",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "description": "r1",
                    "alternative_code": "MG"
                },
                "created_by_user":
                {
                    "person_name": "JackH",
                    "username": "JackH",
                    "id": "B8650C555C4EA8C741103961276E7773",
                    "email": "j_hadjicosti@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "mp@ministrator.com"
                }
            },
            "status": "PARTIALLY_SETTLED",
            "to_date": null,
            "life_cycle_state": "PRESENTED",
            "unsettled_amount": 75.36,
            "type": "NORMAL"
        }
    ]
}

GET bills/get_settled

This method is used to get the settled bills allocated against a specific accounts receivable

Resource URL

http://host_name/crmapi/rest/$version/bills/get_settled

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts receivable identifier  

The identifier of the accounts receivable in which the bills that should be returned as a result should be allocated. The allowed accounts receivable 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

Response Data

Examples

 

HTTP Method: GET

 

Request:

http://host_name/crmapi/rest/v2/bills/get_settled?token=21B932089D63DBB4D90B4DBF4817AC68&accounts_receivable_identifier=number=182&fields_set=id,number,status

Response:

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    [
        {
            "status": "SETTLED",
            "number": "100",
            "id": "34490C34216FFDB1CF563C106449A817"
        },
        {
            "status": "SETTLED",
            "number": "101",
            "id": "66DBA3EE93EA9EBABDC7722A8400A001"
        },
        {
            "status": "SETTLED",
            "number": "111",
            "id": "B8B6983CEAC192F3B992E0AA032D0BB1"
        }
    ]
}

POST bills/present

This method is used to set the life cycle state of a bill to presented

Resource URL

http://host_name/crmapi/rest/$version/bills/present

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Restrictions

Response Data

Examples

HTTP Method: POST

 

Request:

http://host_name/crmapi/rest/v2/bills/present

Body:

{
    "token": "D0B5DB906B4C1B56FFEFCE634435A4D5",
    "bill_identifier":{"number":"10"},
}


Response:

{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount_to_be_paid": 160.97,
        "bill_status": "SETTLED",
        "to_date": null,
        "from_date": null,
        "life_cycle_state": "PRESENTED",
        "total_billed_amount": 160.97,
        "number": "10",
        "id": "A3887F949F688206F424A5E3001E9153"
    }
}

POST bill/present_and_confirm

This method is used to set the life cycle state of a bill to presented and confirmed

Resource URL

http://host_name/crmapi/rest/$version/bills/present_and_confirm

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Restrictions

Response Data

Examples

HTTP Method: POST

 

Request:

 http://host_name/crmapi/rest/v2/bills/present_and_confirm

Body:

{
    "token": "D0B5DB906B4C1B56FFEFCE634435A4D5",
    "bill_identifier":{"number":"100"},
}


Response:

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount_to_be_paid": 49.5,
        "bill_status": "SETTLED",
        "to_date": null,
        "from_date": null,
        "life_cycle_state": "PRESENTED_AND_CONFIRMED",
        "total_billed_amount": 24.75,
        "number": "100",
        "id": "34490C34216FFDB1CF563C106449A817"
    }
}

POST bill/present_and_reject

This method is used to set the life cycle state of a bill to presented and rejected

Resource URL

http://host_name/crmapi/rest/$version/bills/present_and_reject

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

bill_identifier

(mandatory)

Bill identifier  

The identifier of the bill that should be updated.The allowed bill identifier fields are the following:

Restrictions

Response Data

Examples

HTTP Method: POST

 

Request:

 http://host_name/crmapi/rest/v2/bills/present_and_reject

Body:

{
    "token": "D0B5DB906B4C1B56FFEFCE634435A4D5",
    "bill_identifier":{"number":"100"},
}


Response:

 {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "total_amount_to_be_paid": 49.5,
        "bill_status": "SETTLED",
        "to_date": null,
        "from_date": null,
        "life_cycle_state": "PRESENTED_AND_REJECTED",
        "total_billed_amount": 24.75,
        "number": "100",
        "id": "34490C34216FFDB1CF563C106449A817"
    }
}