Open APIs

 View Only
  • 1.  TMF678 amountDue vs remainingAmount

    TM Forum Member
    Posted Nov 16, 2023 13:04

    Hi TM forum members!

    Could you please help me to clarify  the difference between amountDue and remainingAmount properties of the CustomerBill resource model?



    ------------------------------
    Vladyslav Syzov
    Telenor Denmark
    ------------------------------


  • 2.  RE: TMF678 amountDue vs remainingAmount

    TM Forum Member
    Posted Nov 17, 2023 09:34

    Vladislav, I'm not sure what is the nature of the confusion, because those 2 attributes are representing 2 different business entities. amountDue is the amount required to be paid in the given billing cycle on the paymentDueDate, while remainingAmount represents the amount of outstanding debt for the given account. 



    ------------------------------
    PAVEL DMITRIYEV
    AT&T Inc.
    ------------------------------



  • 3.  RE: TMF678 amountDue vs remainingAmount

    TM Forum Member
    Posted Nov 17, 2023 13:42

    Thanks for your answer Pavel, (actually I have created a duplicated thread of this question by mistake https://engage.tmforum.org/discussion/tmf678-amountdue-vs-remainingamount?ReturnUrl=%2fcommunities%2fcommunity-home%2fdigestviewer%3fcommunitykey%3dd543b8ba-9d3a-4121-85ce-5b68e6c31ce5)

    I was confused because of CustomerBill model already has fields taxIncludedAmount and taxExcludedAmount so I decided that these are that fields that show the amount to be paid by paymentDueDate. Or they have different meaning?



    ------------------------------
    Vladyslav Syzov
    Telenor Denmark
    ------------------------------



  • 4.  RE: TMF678 amountDue vs remainingAmount

    TM Forum Member
    Posted Nov 17, 2023 14:22

    My interpretation would be that taxes included/excluded are for the original invoice and don't have direct correlation to the amountDue and remainingAmount. Here is excerpt from the example in TMF678 user guide to illustrate the point:

    {
    	"id": "CB-123",
    	"href": "https://server:port/tmf-api/Customer_Bill_Management/v5/customerBill/CB-123",
    	"billNo": "780123456",
    	"amountDue": {
    		"unit": "EUR",
    		"value": 0.0
    	},
    	"appliedPayment": [
    		{
    			"appliedAmount": {
    				"unit": "EUR",
    				"value": 50.0
    			},
    			"payment": {
    				"id": "PAY-9876",
    				"href": "https://server:port/tmf-api/Payment_Management/v5/payment/PAY-9876",
    				"name": "csp-bill",
    				"@referredtype": "Payment",
    				"@type": "PaymentRef"
    			},
    			"@type": "AppliedPayment"
    		}
    	],
    	"taxExcludedAmount": {
    		"unit": "EUR",
    		"value": 40.0
    	},
    	"taxIncludedAmount": {
    		"unit": "EUR",
    		"value": 50.0
    	},
    	"taxItem": [
    		{
    			"taxAmount": {
    				"unit": "EUR",
    				"value": 10.0
    			},
    			"taxCategory": "VAT",
    			"taxRate": 0.25,
    			"@type": "TaxItem"
    		}
    	]
    }


    ------------------------------
    PAVEL DMITRIYEV
    AT&T Inc.
    ------------------------------



  • 5.  RE: TMF678 amountDue vs remainingAmount

    TM Forum Member
    Posted Nov 20, 2023 01:47

    Yes, I've seen this example and it confused me a bit because I expected to see

    "amountDue": { "value": 50.0} - what is required to pay by invoice

    "remainingAmount": {"value": 0.0} - what is left to pay.

    but in this example "amountDue" is 0.0 - ?



    ------------------------------
    Vladyslav Syzov
    Telenor Denmark
    ------------------------------



  • 6.  RE: TMF678 amountDue vs remainingAmount

    Posted Nov 22, 2023 04:12

    I imagine the amountDue is used for countries like Hong Kong where there is no VAT/GST.  The example is probably misleading/incorrect.



    ------------------------------
    Dan d'Albuquerque
    Individual
    ------------------------------