ProFormaInvoiceRequest.md

ProFormaInvoiceRequest

Properties

Name	Type	Description	Notes
transaction_ids	List[int]	List of pending transaction IDs to include in the pro forma invoice (deprecated, use `includeTransactionIds` instead)
transaction_id_to_amount	Dict[str, float]	Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion	[optional]
payment_ids	List[int]	List of payment IDs associated with the pending transactions	[optional]
source_id	int
sequence_id	int		[optional]
source_kind	SourceKind
user_id	int		[optional]
recipient	RecipientRequest
invoice_date	date	Date for the pro forma invoice (defaults to current date if not provided)	[optional]
folio_ids	List[int]	Include all transactions from the specified folio IDs	[optional]
exclude_transaction_ids	List[int]	Exclude transactions with the specified IDs	[optional]
include_transaction_ids	List[int]	Include transactions with the specified IDs	[optional]
emails	List[str]	Optional list of email addresses to send the document to once it is ready	[optional]
subject	str	Optional per-send override for the email subject. When omitted or blank, the subject is resolved from the property's email template, falling back to the service default. Supports the same [Placeholder] tokens as template subjects.	[optional]
package_breakdown	bool	Per-document override for package breakdown. Null means use property default.	[optional]
line_grouping_selection	LineGroupingSelectionRequest		[optional]

Example

from cloudbeds_fiscal_document.models.pro_forma_invoice_request import ProFormaInvoiceRequest

# TODO update the JSON string below
json = "{}"
# create an instance of ProFormaInvoiceRequest from a JSON string
pro_forma_invoice_request_instance = ProFormaInvoiceRequest.from_json(json)
# print the JSON string representation of the object
print(ProFormaInvoiceRequest.to_json())

# convert the object into a dict
pro_forma_invoice_request_dict = pro_forma_invoice_request_instance.to_dict()
# create an instance of ProFormaInvoiceRequest from a dict
pro_forma_invoice_request_from_dict = ProFormaInvoiceRequest.from_dict(pro_forma_invoice_request_dict)

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