Zuora Documentation

Re: API Changelog

This changelog outlines the latest REST API updates and documentation updates in the API Reference. The changelog is a work in progress and we would love to hear your feedback on how we can improve it.

 

For convenience, we have disabled direct comments on this post. If you have any comments on the API Changelog, please go to the API Changelog Discussion post. Thank you! 

 

2018-10-15

 

API Updates

 

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 233, October 2018.

 

  • Payments - In the request body of the “Create payment” operation, changed the paymentMethodId field from required to optional. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically.

 

2018-10-11

 

API Updates

 

This section lists operations and fields that were added, changed, or removed. The following API updates are available as of Zuora Release 233, October 2018.

 

  • Orders - Made the following updates:

    • Added a new operation “Request breakdown of invoice items by order”.
    • In the “Create order” operation, added the creditMemoTemplateId and debitMemoTemplateId fields to the following fields in the request body:
      • newAccount
      • subscription > orderActions > createSubscription > newSubscriptionOwnerAccount
  • Credit Memos - Added a new operation “Request breakdown of credit memo items by order”.

 

Doc Updates

 

This section lists the documentation updates that were made in this version of the API Reference.

 

  • In the following operations, updated the notes to clarify that migration to full Orders is in Limited Availability:

    • Preview order
    • Create order
    • Delete order
    • Update subscription custom fields
    • Update order action trigger dates
  • In all operations relevant to the Invoice Settlement feature, added the missing No enum value to the transferredToAccounting field.

  • In the “Get credit memos” operation, removed the fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters:

    • accountId
    • amount
    • appliedAmount
    • autoApplyUponPostingbalance
    • beAppliedAmount
    • createdById
    • createdDate
    • creditMemoDate
    • currency
    • excludeFromAutoApplyRulesurrency
    • debitMemoDate
    • dueDate
    • number
    • referredInvoiceId
    • refundAmount
    • status
    • targetDate
    • taxAmount
    • totalTaxExemptAmount
    • transferredToAccounting
    • unappliedAmount
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get credit memo items” operation, removed the fieldsFilterablequery parameter. This query parameter was a placeholder for the following query parameters:

    • amount
    • appliedAmount
    • createdById
    • createdDate
    • id
    • refundAmount
    • serviceEndDate
    • serviceStartDate
    • sku
    • skuName
    • sourceItemId
    • subscriptionId
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get debit memos” operation, removed the fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters:

    • accountId
    • amount
    • balance
    • beAppliedAmount
    • createdById
    • createdDate
    • currency
    • debitMemoDate
    • dueDate
    • number
    • referredInvoiceId
    • status
    • targetDate
    • taxAmount
    • totalTaxExemptAmount
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get debit memo items” operation, removed the fieldsFilterablequery parameter. This query parameter was a placeholder for the following query parameters:

    • amount
    • beAppliedAmount
    • createdById
    • createdDate
    • id
    • serviceEndDate
    • serviceStartDate
    • sku
    • skuName
    • sourceItemId
    • subscriptionId
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get payment runs” operation, removed the fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters:

    • createdById
    • createdDate
    • status
    • targetDate
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get all payments” operation, removed the fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters:

    • accountId
    • amount
    • appliedAmount
    • createdById
    • createdDate
    • creditBalanceAmount
    • currency
    • effectiveDate
    • number
    • refundAmount
    • status
    • type
    • unappliedAmount
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the “Get all refunds” operation, removed the fieldsFilterable query parameter. This query parameter was a placeholder for the following query parameters:

    • accountId
    • amount
    • createdById
    • createdDate
    • methodType
    • number
    • paymentId
    • refundDate
    • status
    • type
    • updatedById
    • updatedDate

    These query parameters are now individually listed in the QUERY PARAMETERS section, and a new section called Filtering explains how to use these query parameters.

  • In the following operations, added /v1 to the examples in description of the sort query parameter:

    • Get all payments
    • Get all refunds
  • Corrected the 200 responses of the following actions:

    • Create
    • Execute
    • Generate
    • Subscribe
    • Update

    Previously, each 200 response was documented as an object containing a field called result.

  • In the request body of the “CRUD: Create payment method” operation, and in the subscribes > PaymentMethod object in the request body of the “Subscribe” operation, made the following updates:

    • Updated the description of the TokenId field to clarify that the value must be AmazonBillingAgreementId to create an Amazon Pay payment method.
    • Updated the description of the Type field to clarify that the value must be CreditCardReferenceTransaction to create an Amazon Pay payment method.
  • In the source YAML file, changed the OrderMetricsForEvergreen reference object from an array to an object.

  • In the source YAML file, removed the following reference objects:

    • ProxyActiondeleteResponse
    • BaseObject
    • TriggerCondition