New and Changed Objects for Billing

New Objects

Get details about how a transaction’s billing amount is allocated to one or more accounts

Use the new BillingArrangement object.

Get details about the billing account, billing profile, and the percentage of the billing amount assigned to that account

Use the new BillingArrangementLine object.

Get details about how a transaction’s billing amount is allocated to one or more accounts

Use the new Dispute object.

Get details about the billing account, billing profile, and the percentage of the billing amount assigned to that account

Use the new DisputeItem object.

Get tax information associated with a debit memo line

Use the new DebitMemoLineTax object.

Get information about an expression set

Use the new ExpressionSet object.

Get information about the payment retry rule applied when a payment schedule item fails

Use the new PaymentRetryRule object.

Get information about the payment retry policy that defines how failed payments are retried based on error codes across different retry categories

Use the new PaymentRetryRuleSet object.

Get information about the tax rate applied to a transaction, determined by the applicable tax code and country

Use the new TaxRate object.

Get tax code information used by a specific tax engine to calculate tax for a product

Use the new TaxTreatmentItem object.

Changed Objects

Specify additional tax identification details

Use the new AdditionalTaxIdentificationDetails field on the existing BillingAccount object.

Specify the standard code in internal trades that’s used to define shipping responsibilities

Use the new DeliveryTerms field on the existing BillingAccount object.

Specify the document template that’s used to generate the invoice PDF documents

Use the new InvoiceDocumentTemplate field on the existing BillingAccount object.

Specify the date until which the tax exemption is valid

Use the new TaxExemptionExpirationDate field on the existing BillingAccount object.

Specify the identifier that’s used to indicate that a transaction is tax exempt

Use the new TaxExemptionNumber field on the existing BillingAccount object.

Specify the status of the tax exemption

Use the new TaxExemptionStatus field on the existing BillingAccount object.

Stores the tax identification number

Use the new TaxIdentificationNumber field on the existing BillingAccount object.

Stores the unit of time for which the pricing of the product applies

Use the new PricingTermUnit field on the existing BillingSchedule object.

Stores the ID of the billing arrangement record that’s related to the billing schedule group

Use the new BillingArrangement field on the existing BillingScheduleGroup object.

Stores the usage type of the billing schedule group

Use the new UsageType field on the existing BillingScheduleGroup object.

Specify whether the billing frequency can be changed for the billing treatment

Use the new CanChangeBillingFrequency field on the existing BillingTreatment object.

Configure the credit memo’s source action based on resolving incorrect invoice charges

Use the new supported value DisputeManagement in the existing Category field on the CreditMemo object.

Stores a credit memo’s sum of the total amount with tax in functional currency

Use the new FuncCrcyCnvTotAmtWithTax field on the existing CreditMemo object.

Stores the date on which a credit memo’s total amount with tax is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing CreditMemo object.

Specify the exchange rate that’s used to convert a credit memo’s total amount with tax into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing CreditMemo object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing CreditMemo object.

Specify whether the credit memo is currently in a void in progress state

Use the new supported value VoidInProgress in the existing Status field on the CreditMemo object.

Stores the total tax amount for the credit memo, calculated at the header level by the tax engine

Use the new TotalTaxesCapturedAtHeader field on the existing CreditMemo object.

Stores a credit memo line’s charge amount in functional currency

Use the new FuncCurrencyCnvChargeAmt field on the existing CreditMemoLine object.

Stores a credit memo line’s total tax amount in functional currency

Use the new FuncCrcyCnvTotalTaxAmount field on the existing CreditMemoLine object.

Stores the date on which a credit memo line’s amounts are converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing CreditMemoLine object.

Specify the exchange rate that’s used to convert a credit memo line's amounts into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing CreditMemoLine object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing CreditMemoLine object.

Stores a credit memo line tax’s tax amount in functional currency

Use the new FuncCrcyConvertedTaxAmount field on the existing CreditMemoLineTax object.

Stores the date on which a credit memo line tax’s tax amount is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing CreditMemoLineTax object.

Specify the exchange rate that’s used to convert credit memo line tax’s tax amount into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing CreditMemoLineTax object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing CreditMemoLineTax object.

Stores a debit memo’s sum of the total charge amount in functional currency

Use the new FuncCrcyCnvTotalChargeAmt field on the existing DebitMemo object.

Stores the date on which a debit memo’s total charge amount is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing DebitMemo object.

Specify the exchange rate that’s used to convert a debit memo’s total charge amount into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing DebitMemo object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing DebitMemo object.

Specify whether invoice generation isn't applicable to the debit memo

Use the new supported value NotApplicable in the existing InvoiceGenerationStatus field on the DebitMemo object.

Stores the credit memo record ID associated with the debit memo record

Use the new ReferenceRecord field on the existing DebitMemo object.

Specify whether the debit memo is currently in a void in progress state

Use the new supported value VoidInProgress in the existing Status field on the DebitMemo object.

Stores the sum of the debit memo’s total line amount and total adjustment amount

Use the new TotalAmount field on the existing DebitMemo object.

Stores the sum of the total amount values for the debit memo’s tax lines

Use the new TotalTaxAmount field on the existing DebitMemo object.

Stores the sum of the total amount with the tax on the debit memo line in corporate currency

Use the new CorpCurrCnvTotTaxAmt field on the existing DebitMemoLine object.

Stores a debit memo line’s charge amount in functional currency

Use the new FuncCrcyCnvChargeAmount field on the existing DebitMemoLine object.

Stores the date on which a debit memo line’s amounts are converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing DebitMemoLine object.

Specify the exchange rate that’s used to convert a debit memo line's amounts into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing DebitMemoLine object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing DebitMemoLine object.

Stores total tax amount value in functional currency

Use the new FuncCrcyCnvTotalTaxAmt field on the existing DebitMemoLine object.

Stores the amount of the debit memo line

Use the new LineAmount field on the existing DebitMemoLine object.

Stores the credit memo line record ID associated with the debit memo line record

Use the new supported value CreditMemoLine in the existing ReferenceRecord field on the DebitMemoLine object.

Stores the ship from address specified in the parent debit line

Use the new ShipFromAddress field on the existing DebitMemoLine object.

Stores the tax amount of the debit memo line

Use the new TaxAmount field on the existing DebitMemoLine object.

Specify the status of the tax calculation

Use the new TaxCalculationStatus field on the existing DebitMemoLine object.

Stores the document number of the latest record in the external tax engine where the parent debit line is included

Use the new TaxDocumentNumber field on the existing DebitMemoLine object.

Specify the date that’s used to calculate the tax amount

Use the new TaxEffectiveDate field on the existing DebitMemoLine object.

Stores a debit memo line tax’s charge amount in functional currency

Use the new FuncCrcyCnvChargeAmount field on the existing DebitMemoLineTax object.

Stores the date on which a debit memo line’s amounts are converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing DebitMemoLineTax object.

Specify the exchange rate that’s used to convert a debit memo line's amounts into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing DebitMemoLineTax object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing DebitMemoLineTax object.

Stores the ID of the billing arrangement record that’s related to the invoice

Use the new BillingArrangement field on the existing Invoice object.

Stores the version number of the billing arrangement record that’s used to generate the invoice

Use the new BillingArrangementVerNumber field on the existing Invoice object.

Stores the identifier that’s used to associate and track invoices that are generated based on the same billing arrangement

Use the new CorrelationIdentifier field on the existing Invoice object.

Stores the date on which an invoice’s total amount with tax is converted into functional currency

Use the new FuncCrcyCnvTotAmtWithTax field on the existing Invoice object.

Stores the date on which an invoice’s total amount with tax is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing Invoice object.

Specify the exchange rate that’s used to convert an invoice’s total amount with tax into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing Invoice object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing Invoice object.

Stores the total tax amount for the invoice, calculated at the header level by the tax engine

Use the new TotalTaxesCapturedAtHeader field on the existing Invoice object.

Stores an invoice line’s charge amount in functional currency

Use the new FuncCurrencyCnvChargeAmt field on the existing InvoiceLine object.

Stores an invoice line’s total tax amount in functional currency

Use the new FuncCrcyCnvTotalTaxAmt field on the existing InvoiceLine object.

Stores the date on which an invoice line’s amounts are converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing InvoiceLine object.

Specify the exchange rate that’s used to convert an invoice line’s amounts into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing InvoiceLine object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing InvoiceLine object.

Stores the tax amount of an invoice line tax in functional currency

Use the new FuncCrcyCnvTaxAmount field on the existing InvoiceLineTax object.

Stores the date on which an invoice line tax’s tax amount is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the existing InvoiceLineTax object.

Specify the exchange rate that’s used to convert an invoice line tax’s tax amount into functional currency

Use the new FunctionalCurrencyCvsnRate field on the existing InvoiceLineTax object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the existing InvoiceLineTax object.

Stores a payment’s amount in functional currency

Use the new FunctionalCurrencyCnvAmount field on the Payment object.

Stores the date on which a payment’s amount is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the Payment object.

Specify the exchange rate that’s used to convert a payment’s amount into functional currency

Use the new FunctionalCurrencyCvsnRate field on the Payment object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the Payment object.

Specify whether the payment batch run is used for retrying a failed payment

Use the new IsPaymentRetry field on the PaymentBatchRun object.

Specify the slated time of the next payment retry for the payment schedule item

Use the new NextPaymentRetryTime field on the existing PaymentScheduleItem object.

Stores the category of payment gateway errors for the payment schedule item

Use the new PaymentGatewayErrorCategory field on the existing PaymentScheduleItem object.

Stores the raw error code from the payment gateway for the payment schedule item

Use the new PaymentGatewayErrorCode field on the existing PaymentScheduleItem object.

Stores the number of payment retries that were attempted on the payment schedule item

Use the new PaymentRetryCount field on the existing PaymentScheduleItem object.

Stores a refund’s amount in functional currency

Use the new FunctionalCurrencyCnvAmount field on the Refund object.

Stores the date on which a refund’s amount is converted into functional currency

Use the new FunctionalCurrencyCvsnDate field on the Refund object.

Specify the exchange rate that’s used to convert a refund's amount into functional currency

Use the new FunctionalCurrencyCvsnRate field on the Refund object.

Stores the currency ISO code of the functional currency

Use the new FunctionalCurrencyIsoCode field on the Refund object.

Specify whether an error occurred while processing a void credit memo or an invoice batch run rule-based credit and payment application request

Use the new supported values VoidCreditMemo and InvoiceBatchRunRuleBasedCreditandPaymentApplication in the existing Category field on the RevenueTransactionErrorLog object.

Specify whether the sequence policy is applied to a credit memo record

Use the new supported valueCreditMemo in the existing TargetObject field on the SequencePolicy object.

Specify whether taxes are captured at the header level

Use the new ShouldCaptureTaxesAtHeader field on the existing TaxEngine object.

Specify whether Revenue Standard Tax Engine is used to calculate tax

Use the new supported value RevenueStandardTaxEngine in the existing Type field on the TaxEngine object.

Specify whether the tax codes and product codes of the related tax treatment items must be used when requesting tax calculations

Use the new ShouldUseTaxTreatmentItems field on the existing TaxTreatment object.

REMOVED: The TaxCode field on the DebitMemoLineTax object is removed

The TaxCode field on the DebitMemoLineTax object is removed from API version 66.0 and later. Instead, use the JurisdictionTaxCode field on the existing DebitMemoLineTax object.