BillingDocument.md

Zuora.Model.BillingDocument

Properties

Name	Type	Description	Notes
id	string	Unique identifier for the object.	[optional] [readonly]
updated_by_id	string	Unique identifier of the Zuora user who last updated the object	[optional] [readonly]
updated_time	DateTime	The date and time when the object was last updated in ISO 8601 UTC format.	[optional] [readonly]
created_by_id	string	Unique identifier of the Zuora user who created the object	[optional] [readonly]
created_time	DateTime	The date and time when the object was created in ISO 8601 UTC format.	[optional] [readonly]
custom_fields	Dictionary<string, Object>	Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.	[optional]
custom_objects	Dictionary<string, Object>	The custom fields associated with an object. For more information about custom fields, see Manage custom fields.	[optional] [readonly]
account_id	string	Identifier of the account that owns the billing document.	[optional]
account_number	string	Human-readable identifier of the account that owns the billing document.	[optional]
description	string	An arbitrary string associated with the object. Often useful for displaying to users.	[optional]
due_date	DateTime	The date on which payment for the billing document is due.	[optional]
document_date	DateTime	The date when the billing document takes effect.	[optional]
reason_code	string	Reason for issuing this billing document. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`.	[optional]
invoice_id	string	The identifier of the invoice billing document from which this credit memo or debit memo billing document is created. This field is applicable only if the `type` field is set to `credit_memo` or `debit_memo`.	[optional]
transfer_to_accounting	bool	Whether to transfer to an external accounting system.	[optional]
exclude_from_auto_apply_rules	bool	Indicates whether to exclude this credit memo billing document from the rule of automatically applying it to invoices. This field is applicable only if the `type` field is set to `credit_memo`.	[optional]
pay	bool	Indicates whether the billing document is automatically picked up for processing in the corresponding payment run.	[optional]
type	string	The type of billing document. Can be one of the credit memo, debit memo, or invoice.	[optional]
billing_document_number	string	A human-readable identifier for the billing document; may be user-supplied.	[optional] [readonly]
amount_refunded	decimal	The amount of this billing document item refunded.	[optional]
state_transitions	Object		[optional]
posted_by_id	string	Identifier of the Zuora user who posted the billing document.	[optional] [readonly]
state	string	The status of the billing document.	[optional]
account	Account	The account that owns the billing document. EXPANDABLE	[optional]
items	BillingDocumentItemListResponse	List of billing document items.	[optional] [readonly]
total	decimal	The total amount.	[optional] [readonly]
subtotal	decimal	The total amount exclusive of tax.	[optional] [readonly]
tax	decimal	The total tax amount.	[optional] [readonly]
balance	decimal	The total balance remaining. This field is deprecated. Use `remaining_balance` field.	[optional] [readonly]
remaining_balance	decimal	The total balance remaining.	[optional] [readonly]
amount_paid	decimal	The total amount paid.	[optional] [readonly]
paid	bool	Whether payment was successfully collected for this invoice. An invoice can be paid with a payment or a credit memo.	[optional] [readonly]
past_due	bool	Whether payment is past due.	[optional] [readonly]

[Back to Model list] [Back to API list] [Back to README]