Skip to main content

Transaction object in Analytics

Zuora

Transaction object in Analytics

The Transaction object in Analytics provides a detailed record of every account receivable transaction that has an impact on the account balance in your Zuora tenant. You can use the data fields of the Transaction object with the Net Billing and Net Payments metrics.

The Transaction object consists of the following data fields.

Data fields

Description

Category

Indicates if the transaction corresponds to billing or payment activity in Zuora.

Values:

  • Payment
  • Billing

Document Number

The number of the document that the Transaction corresponds to. For example, the number of the Invoice that contains an Invoice Item.

Document Type

The type of document that the Document Number field corresponds to.

Status

The status of the transaction or the Transaction's document. For example, "Processed" for an Invoice Payment where the corresponding Payment has been processed.

ID

The unique identifier of the Transaction.

Transaction Type

The object name of the Transaction.

Values for Transaction Category = “Billing” include:

  • Credit Memo Item
  • Credit Taxation Item
  • Debit Memo Item
  • Debit Taxation Item
  • Invoice Item
  • Invoice Item Adjustment
  • Invoice Adjustment
  • Taxation Item

Values for Transaction Category = “Payment” include:

  • Invoice Payment
  • Payment Application
  • Refund Invoice Payment
  • Refund Application
  • Credit Balance Adjustment
Transaction Subtype

Provides additional categorical information about the transaction. The Transaction Subtype field is populated in the following manner depending on transaction types.

Values for each transaction type in the ‘Billing’ transaction category:

  • Invoice Items: This field is null
  • Invoice Item Adjustment: This field is populated from the Invoice Item Adjustment Type field. Possible values include:
    • Credit
    • Charge
  • Invoice Adjustment: This field is populated from the Invoice Adjustment Type field. Possible values include:
    • Credit
    • Charge
  • Credit Memo Item: This field is null
  • Credit Taxation Item: This field is null
  • Debit Memo Item: This field is null
  • Debit Taxation Item: This field is null
  • Taxation Item: This field is null

For payment transaction:

  • Payment. Type for Invoice Payment and Payment Application
  • Refund. Type for Refund Invoice Payment and Refund Application

Values for each transaction type in the ‘Payment’ transaction category:

  • Invoice Payment: Possible values include:
    • External
    • Electronic
  • Payment Application: Possible values include:
    • External
    • Electronic
  • Refund Invoice Payment: Possible values include:
    • External
    • Electronic
  • Refund Application: Possible values include:
    • External
    • Electronic
  • Credit Balance Adjustment: Possible values include:
    • Credit Balance Transfer to Invoice
    • Credit Balance Application to Invoice
    • Credit Balance Refund
    • Credit Balance Increase from Overpayment

Transferred To Accounting

Indicates if the Transaction was transferred to an external accounting system, such as NetSuite.

Possible values include:

  • Processing
  • Yes
  • Error
  • Ignore

 

Dates for Net Billing and Net Payments

 

The dates for Net Billing and Net Payments metrics are populated from the transaction type objects that are used for grouping the metrics data. 

Transaction Type

Net Billing - Metric Date

Net Payments - Metric Date

Invoice Item

Invoice.Invoice Date

N/A

Invoice Item Adjustment

InvoiceItemAdjustment.AdjustmentDate

N/A

Invoice Adjustment

InvoiceAdjustment.AdjustmentDate

N/A

Taxation Item

Invoice.InvoiceDate

N/A

Credit Memo Item

CreditMemo.MemoDate

n/a

Credit Taxation Item

CreditMemo.MemoDate

N/A

Debit Memo Item

DebitMemo.MemoDate

N/A

Debit Taxation Item

DebitMemo.MemoDate

N/A

Invoice Payment

N/A

Payment.EffectiveDate

Refund Invoice Payment

N/A

Refund.RefundDate

Credit Balance Adjustment

N/A

  • If CreditBalanceAdjustment.SourceTransactionType is "Invoice" and CreditBalanceAdjustment.Type is "Decrease" or "Increase", then CreditBalanceAdjustment.AdjustmentDate will be used.
  • If CreditBalanceAdjustment.SourceTransactionType is "Payment" and CreditBalanceAdjustment.Type is "Increase", then Payment.EffectiveDate will be used.
  • If CreditBalanceAdjustment.SourceTransactionType is "Refund" and CreditBalanceAdjustment.Type is "Decrease", then Refund.RefundDate will be used.

Payment Application

N/A

PaymentApplication.EffectiveDate

Refund Application

N/A

RefundApplication.EffectiveDate