InvoiceRecalculationAmendment.md

Bfwd::InvoiceRecalculationAmendment

Properties

Name	Type	Description	Notes
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]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
type	String	{ "description" : "", "default" : "", "verbs":["POST","GET"] }
id	String	{ "description" : "", "verbs":["GET"] }	[optional]
organization_id	String	{ "description" : "", "verbs":[""] }	[optional]
subscription_id	String	{ "description" : "", "verbs":["POST","PUT","GET"] }
amendment_type	String	{ "description" : "Type of amendment", "verbs":["POST","GET"] }
actioning_time	DateTime	{ "description" : "When the amendment will run", "verbs":["POST","PUT","GET"] }	[optional]
actioned_time	DateTime	{ "description" : "The time the amendment completed.", "verbs":["GET"] }	[optional]
state	String	Whether the subscription-amendment is: pending (to be actioned in the future), succeeded (actioning completed), failed (actioning was attempted but no effect was made) or discarded (the amendment had been cancelled before being actioned). Default: Pending
deleted	BOOLEAN	{ "description" : "Is the amendment deleted.", "verbs":["GET"] }	[default to false]
invoice_id	String	{ "description" : "Identifier of the invoice to recalcaulte", "verbs":["POST","GET"] }
recalculation_behaviour	String	{ "description" : "The recalculation behaviour of the invoice", "default" : "RecalculateAsLatestSubscriptionVersion", "verbs":["POST","GET"] }
new_invoice_state	String	{ "description" : "State of invoice once recalculated", "default" : "Pending", "verbs":["POST","GET"] }
include_invoiced_charges_only	BOOLEAN	{ "description" : "Only include charges which are already linked to the invoice being recalculated", "default" : "Pending", "verbs":["POST","GET"] }	[default to false]