Versions Compared

Old Version 1

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Ekaterini Tzirtzipi

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R13.1.0

Excerpt

This method previews the bill for an Accounts Receivable's Bill. A single Accounts Receivable' Bill is previewed by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Account Receivable Identifier

The identifier of the account receivable. The allowed account receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier_post
V4:accounts_receivable_identifier_post

 

 

 

 

 

 

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned

...

  • It is mandatory to specify one of the semi-optional parameters. Both those parameters is allowed to be specified.

Response Data

Name

Type

Description

bill_previewBill Preview ObjectThe bill preview results

Anchor
accounts_receivable_preview_bill referred objects
accounts_receivable_preview_bill referred objects
Referred Objects Response Data

Include Page
V4:accountsbill_receivablepreview_completeshort
V4:accountsbill_receivablepreview_completeshort

Examples

 

Expand
titleExample 1

HTTP Method: GET

 

Request

Response

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "bill_preview": {
            "total_vat_amount": 0,
            "total_vat_amount_of_member": 0,
            "from_date": "2017-02-01T00:00:00",
            "to_date": "2017-09-01T00:00:00",
            "total_billed_amount_of_member": 1713.6,
            "total_amount_to_be_paid_by_member": 4087.67,
            "total_tax_amount": 0,
            "currency": {
                "suffix_symbol": null,
                "prefix_symbol": "£",
                "decimal_part_name": null,
                "code": "GBP",
                "integer_part_name": null,
                "id": "9"
            },
            "total_billed_amount": 1713.6,
            "total_amount_to_be_paid": 4087.67,
            "product_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": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
                    },
                    "from_date": "2017-02-01T00:00:00",
                    "to_date": "2017-09-01T00:00:00",
                    "total_amount": 294,
                    "applied_additive_discounts_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": "Gold",
                        "id": "D1EB074DFD904E54A0C67CAB9DC7E010"
                    },
                    "from_date": "2017-02-01T00:00:00",
                    "to_date": "2017-09-01T00:00:00",
                    "total_amount": 294,
                    "applied_additive_discounts_set": []
                },
                {
                    "product": {
                        "code": "VOD & PPV Base",
                        "product_type": {
                            "service_type": "TERMED",
                            "used_for_provisioning": false,
                            "alternative_code": "V&P",
                            "composition_method": "FLAT",
                            "name": "VOD & PPV",
                            "description": "To be used for termed non provisioning services as a base for ordering VOD and PPV",
                            "id": "CE2024C589D34244A1D29CDDE3B88127",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "V&PB",
                        "description": "VOD & PPV Base",
                        "id": "F7286EF7D017405E8357FF8614A3EA24"
                    },
                    "from_date": "2017-02-01T00:00:00",
                    "to_date": "2017-09-01T00:00:00",
                    "total_amount": 890.4,
                    "applied_additive_discounts_set": []
                },
                {
                    "product": {
                        "code": "Bronze",
                        "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": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55"
                    },
                    "from_date": "2017-02-01T00:00:00",
                    "to_date": "2017-09-01T00:00:00",
                    "total_amount": 235.2,
                    "applied_additive_discounts_set": []
                }
            ]
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}