GETCreditMemoType.md

GETCreditMemoType

Properties

Name	Type	Description	Notes
integration_id__ns	str	ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.	[optional]
integration_status__ns	str	Status of the credit memo's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.	[optional]
origin__ns	str	Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.	[optional]
sync_date__ns	str	Date when the credit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.	[optional]
transaction__ns	str	Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.	[optional]
account_id	str	The ID of the customer account associated with the credit memo.	[optional]
amount	float	The total amount of the credit memo.	[optional]
applied_amount	float	The applied amount of the credit memo.	[optional]
auto_apply_upon_posting	bool	Whether the credit memo automatically applies to the invoice upon posting.	[optional]
cancelled_by_id	str	The ID of the Zuora user who cancelled the credit memo.	[optional]
cancelled_on	datetime	The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.	[optional]
comment	str	Comments about the credit memo.	[optional]
created_by_id	str	The ID of the Zuora user who created the credit memo.	[optional]
created_date	datetime	The date and time when the credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.	[optional]
credit_memo_date	date	The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.	[optional]
currency	str	A currency defined in the web-based UI administrative settings.	[optional]
exclude_from_auto_apply_rules	bool	Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.	[optional]
id	str	The unique ID of the credit memo.	[optional]
latest_pdf_file_id	str	The ID of the latest PDF file generated for the credit memo.	[optional]
number	str	The unique identification number of the credit memo.	[optional]
posted_by_id	str	The ID of the Zuora user who posted the credit memo.	[optional]
posted_on	datetime	The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.	[optional]
reason_code	str	A code identifying the reason for the transaction. The value must be an existing reason code or empty.	[optional]
referred_invoice_id	str	The ID of a referred invoice.	[optional]
refund_amount	float	The amount of the refund on the credit memo.	[optional]
source	str	The source of the credit memo. Possible values: - `BillRun`: The credit memo is generated by a bill run. - `API`: The credit memo is created by calling the Invoice and collect operation. - `ApiSubscribe`: The credit memo is created by calling the Create subscription and Create account operation. - `ApiAmend`: The credit memo is created by calling the Update subscription operation. - `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the Create credit memo from charge operation. - `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the Create credit memo from invoice operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the Reverse invoice operation.	[optional]
source_id	str	The ID of the credit memo source. If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`.	[optional]
status	str	The status of the credit memo.	[optional]
success	bool	Returns `true` if the request was processed successfully.	[optional]
target_date	date	The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.	[optional]
tax_amount	float	The amount of taxation.	[optional]
total_tax_exempt_amount	float	The total amount of taxes or VAT for which the customer has an exemption.	[optional]
transferred_to_accounting	str	Whether the credit memo was transferred to an external accounting system.	[optional]
unapplied_amount	float	The unapplied amount of the credit memo.	[optional]
updated_by_id	str	The ID of the Zuora user who last updated the credit memo.	[optional]
updated_date	datetime	The date and time when the credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:36:10.	[optional]

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