RevenueAttribution.md

Bfwd::RevenueAttribution

Properties

Name	Type	Description	Notes
period_start	DateTime	{"description":"PeriodStart of the charge with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
period_end	DateTime	{"description":"PeriodEnd of the charge with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
id	String	{"description":"ID of the RevenueAttribution.","verbs":["POST","PUT","GET"]}	[optional]
organization_id	String	{"description":"ID of the organization associated with the RevenueAttribution.","verbs":["POST","PUT","GET"]}
invoice_id	String	{"description":"Consistent ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.","verbs":["POST","PUT","GET"]}
invoice_version_id	String	{"description":"Version ID of the invoice which is expected to be consulted when paying for the billed feature described in this RevenueAttribution. That is: the top parent of that billed feature.","verbs":["POST","PUT","GET"]}
aggregated_invoice_id	String	{"description":"ID of the invoice to which this RevenueAttribution's invoice line belongs.","verbs":["POST","PUT","GET"]}
aggregated_invoice_line_id	String	{"description":"ID of the invoice line whose debt this RevenueAttribution describes.","verbs":["POST","PUT","GET"]}
currency	String	{"description":"The currency of the Invoice from which this RevenueAttribution was raised — specified by a three-character ISO 4217 currency code.","verbs":["POST","PUT","GET"]}
nominal_amount	Float	{"description":"The amount paid — through credit or otherwise — toward this invoice line.","verbs":["POST","PUT","GET"]}
actual_amount	Float	{"description":"The amount paid — through real money — toward this invoice line.","verbs":["POST","PUT","GET"]}
pricing_component_id	String	{"description":"ID of the PricingComponent with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
pricing_component_name	String	{"description":"Name of the PricingComponent with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_id	String	{"description":"ID of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_name	String	{"description":"Internal name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_rate_plan_name_public	String	{"description":"Public name of the ProductRatePlan with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_id	String	{"description":"ID of the Product with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_name	String	{"description":"Internal name of the Product with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
product_name_public	String	{"description":"Public name of the Product with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
aggregated_subscription_id	String	{"description":"ID of the Subscription with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}
subscription_id	String	{"description":"Consistent ID of the Subscription which pays for this invoice line.","verbs":["POST","PUT","GET"]}
account_id	String	{"description":"ID of the Account with which this RevenueAttribution's invoice line is associated.","verbs":["POST","PUT","GET"]}