Zuora Alumni

Re: API Changelog

 

2017-10-15

 

API Updates

 

This section lists API operations and fields that were added, changed, or removed. The following API updates are available as of the October 2017 release, R217.

 

  • Accounts - Added the parentId and salesRep fields to the request body of the "Create account" and "Update account" operations and the response of the "Get account" operation.

The following items are API updates specific to the refactor of Advanced AR Settlement REST APIs.

 

  • Credit Memos - Made the following updates:
    • Removed the “Query credit memos by account” operation.
    • Included the “Create taxation items for credit memo” operation, which was previously in Taxation Items. Now its URL is /v1/creditmemos/{creditMemoId}/taxationitems.
    • Excluded the “Create credit memo from invoice” operation. Now it is located in Invoices.
    • In the “Refund credit memo” operation, changed the URL to /v1/creditmemos/{creditMemoId}/refunds.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Post credit memo
      • Apply credit memo 
      • Unapply credit memo 
      • Cancel credit memo
  • Debit Memos - Made the following updates:
    • Included the “Create taxation items for debit memo” operation, which was previously in Taxation Items. Now its URL is /v1/debitmemos/{debitMemoId}/taxationitems.
    • Excluded the “Create debit memo from invoice” operation. Now it is located in Invoices.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Post debit memo
      • Cancel debit memo 
  • Invoices - Made the following updates:
    • Included the “Create credit memo from invoice” operation, which was previously in Credit Memos. Now its URL is /v1/invoices/{invoiceId}/creditmemos.
    • Included the “Create debit memo from invoice” operation, which was previously in Debit Memos. Now its URL is /v1/invoices/{invoiceId}/debitmemos.
  • Payments - Made the following updates:
    • In the “Transfer payment” operation, changed the HTTP method to PUT and URL to /v1/payments/{paymentId}/transfer, and updated the operationId property in the source YAML file accordingly.
    • In the “Refund payment” operation, changed the URL to /v1/payments/{paymentId}/refunds.
    • Changed the HTTP method of the following operations to PUT. Also changed the operationId property in the source YAML file accordingly.
      • Apply payment
      • Unapply payment
      • Cancel payment
  • Refunds - Changed the HTTP method to PUT for the “Cancel refund” operation, and updated the operationId property in the source YAML file accordingly.
  • Taxation Items - Made the following updates:
    • Excluded the “Create taxation items for credit memo” operation. Now it is located in Credit Memos.
    • Excluded the“Create taxation items for debit memo” operation. Now it is located in Debit Memos.

 

Doc Updates

 

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

 

  • Added user permission reminder and links to Knowledge Center to the description of “Create credit memo from charge”, “Create debit memo from charge”, "Create credit memo from invoice", "Create debit memo from invoice", “Cancel credit memo”, “Cancel debit memo”, “Delete credit memo”, “Delete debit memo”, “Apply credit memo”, “Unapply credit memo”, “Refund credit memo”, “Update credit memo”, and “Update debit memo” operations.
  • In the “Invoice and collect” operation, added the gateway response reason code and error message examples in the operation description.
  • In the “Verify payment method” operation, corrected the URL, updated the operation description, and added the missing data type to the PUTVerifyPaymentMethodResponseType reference object in the source YAML file.
  • In the "Create billing preview" operation, corrected the description of the taxAmount field.
  • Updated descriptions of the "Get breakdown of credit memo by order" operation, the "Get breakdown of invoice by order" operation, and all the operations in the "Orders" resource.
  • Updated the description of the orderNumber field in the “Get subscription by key”, “Get subscriptions by account”, and “Get subscriptions by key and version” operations.
  • Added the Discount Applied Metrics and Taxable Item Snapshot objects to the listing of API names in the Zuora Object Model section.
  • Added descriptions of the "CRUD: Create Export" and "CRUD: Retrieve Export" operations.
  • In the "CRUD: Create Export" operation, added information about data source support in the description of the Query field.
  • In the "Get custom foreign currency exchange rates" operation, updated the description of the currency request parameter.
  • In the source YAML file, corrected the operationId property for the following operations:
    • Create revenue schedule for credit memo item (manual distribution)
    • Create revenue schedule on subscription charge
    • Update payment
    • Get payment part items