# Node.js client library reference

The latest Node client library version is **3.17.0**.

## Requirements

- **NPM**: 10.8.2
- **Node**: 20.16.0


## Installation

See [Zuora Client Libraries](/docs/guides/libraries/).

## Classes and methods

The following table summarizes all available classes and methods for the Zuora Node.js client library.

table
thead
tr
th
Class
th
Method
th
HTTP request
th
Description
tbody
tr
td
em
ZuoraSdkJs.APIHealthApi
td
strong
getSystemHealthApiVolumeSummary
td
strong
GET
 /system-health/api-requests/volume-summary
td
List API volume summary records
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
activateAccountingCode
td
strong
PUT
 /v1/accounting-codes/{ac-id}/activate
td
Activate an accounting code
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
createAccountingCode
td
strong
POST
 /v1/accounting-codes
td
Create an accounting code
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
deactivateAccountingCode
td
strong
PUT
 /v1/accounting-codes/{ac-id}/deactivate
td
Deactivate an accounting code
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
deleteAccountingCode
td
strong
DELETE
 /v1/accounting-codes/{ac-id}
td
Delete an accounting code
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
getAccountingCode
td
strong
GET
 /v1/accounting-codes/{ac-id}
td
Retrieve an accounting code
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
getAllAccountingCodes
td
strong
GET
 /v1/accounting-codes
td
List all accounting codes
tr
td
em
ZuoraSdkJs.AccountingCodesApi
td
strong
updateAccountingCode
td
strong
PUT
 /v1/accounting-codes/{ac-id}
td
Update an accounting code
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
closeAccountingPeriod
td
strong
PUT
 /v1/accounting-periods/{ap-id}/close
td
Close an accounting period
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
createAccountingPeriod
td
strong
POST
 /v1/accounting-periods
td
Create an accounting period
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
deleteAccountingPeriod
td
strong
DELETE
 /v1/accounting-periods/{ap-id}
td
Delete an accounting period
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
getAccountingPeriod
td
strong
GET
 /v1/accounting-periods/{ap-id}
td
Retrieve an accounting period
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
getAllAccountingPeriods
td
strong
GET
 /v1/accounting-periods
td
List all accounting periods
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
pendingCloseAccountingPeriod
td
strong
PUT
 /v1/accounting-periods/{ap-id}/pending-close
td
Set an accounting period to pending close
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
reopenAccountingPeriod
td
strong
PUT
 /v1/accounting-periods/{ap-id}/reopen
td
Reopen an accounting period
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
runTrialBalance
td
strong
PUT
 /v1/accounting-periods/{ap-id}/run-trial-balance
td
Run trial balance
tr
td
em
ZuoraSdkJs.AccountingPeriodsApi
td
strong
updateAccountingPeriod
td
strong
PUT
 /v1/accounting-periods/{ap-id}
td
Update an accounting period
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
createAccount
td
strong
POST
 /v1/accounts
td
Create an account
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
deleteAccount
td
strong
DELETE
 /v1/accounts/{account-key}
td
Delete an account
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
getAccount
td
strong
GET
 /v1/accounts/{account-key}
td
Retrieve an account
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
getAccountDefaultPaymentMethod
td
strong
GET
 /v1/accounts/{account-key}/payment-methods/default
td
Retrieve the default payment method of an account
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
getAccountPaymentMethods
td
strong
GET
 /v1/accounts/{account-key}/payment-methods
td
List payment methods of an account
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
getAccountSummary
td
strong
GET
 /v1/accounts/{account-key}/summary
td
Retrieve an account summary
tr
td
em
ZuoraSdkJs.AccountsApi
td
strong
updateAccount
td
strong
PUT
 /v1/accounts/{account-key}
td
Update an account
tr
td
em
ZuoraSdkJs.ActionsApi
td
strong
actionPostCreate
td
strong
POST
 /v1/action/create
td
Create
tr
td
em
ZuoraSdkJs.ActionsApi
td
strong
actionPostDelete
td
strong
POST
 /v1/action/delete
td
Delete
tr
td
em
ZuoraSdkJs.ActionsApi
td
strong
actionPostQuery
td
strong
POST
 /v1/action/query
td
Query
tr
td
em
ZuoraSdkJs.ActionsApi
td
strong
actionPostqueryMore
td
strong
POST
 /v1/action/queryMore
td
QueryMore
tr
td
em
ZuoraSdkJs.ActionsApi
td
strong
actionPostupdate
td
strong
POST
 /v1/action/update
td
Update
tr
td
em
ZuoraSdkJs.AdjustmentsApi
td
strong
cancelBillingAdjustment
td
strong
PUT
 /v1/adjustments/{adjustmentId}/cancel
td
Cancel an adjustment
tr
td
em
ZuoraSdkJs.AdjustmentsApi
td
strong
createBillingAdjustment
td
strong
POST
 /v1/adjustments
td
Create an adjustment
tr
td
em
ZuoraSdkJs.AdjustmentsApi
td
strong
getBillingAdjustment
td
strong
GET
 /v1/adjustments/{adjustment-key}
td
Retrieve an adjustment
tr
td
em
ZuoraSdkJs.AdjustmentsApi
td
strong
getSubscriptionAdjustments
td
strong
GET
 /v1/adjustments
td
List all adjustments of the latest version subscription
tr
td
em
ZuoraSdkJs.AdjustmentsApi
td
strong
previewBillingAdjustment
td
strong
POST
 /v1/adjustments/preview
td
Preview an adjustment
tr
td
em
ZuoraSdkJs.AggregateQueriesApi
td
strong
createBatchQuery
td
strong
POST
 /v1/batch-query/
td
Submit an aggregate query job
tr
td
em
ZuoraSdkJs.AggregateQueriesApi
td
strong
deleteBatchQueryJob
td
strong
DELETE
 /v1/batch-query/jobs/{jobid}
td
Cancel a running aggregate query job
tr
td
em
ZuoraSdkJs.AggregateQueriesApi
td
strong
getBatchQueryJob
td
strong
GET
 /v1/batch-query/jobs/{jobid}
td
Retrieve an aggregate query job
tr
td
em
ZuoraSdkJs.AttachmentsApi
td
strong
deleteAttachments
td
strong
DELETE
 /v1/attachments/{attachment-id}
td
Delete an attachment
tr
td
em
ZuoraSdkJs.AttachmentsApi
td
strong
getAttachments
td
strong
GET
 /v1/attachments/{attachment-id}
td
Retrieve an attachment
tr
td
em
ZuoraSdkJs.AttachmentsApi
td
strong
getAttachmentsList
td
strong
GET
 /v1/attachments/{object-type}/{object-key}
td
List attachments by object type and key
tr
td
em
ZuoraSdkJs.AttachmentsApi
td
strong
postAttachments
td
strong
POST
 /v1/attachments
td
Create an attachment
tr
td
em
ZuoraSdkJs.AttachmentsApi
td
strong
putAttachments
td
strong
PUT
 /v1/attachments/{attachment-id}
td
Update an attachment
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
cancelBillRun
td
strong
PUT
 /v1/bill-runs/{billRunId}/cancel
td
Cancel a bill run
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
createBillRun
td
strong
POST
 /v1/bill-runs
td
Create a bill run
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
deleteBillRun
td
strong
DELETE
 /v1/bill-runs/{billRunId}
td
Delete a bill run
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
emailBillRun
td
strong
POST
 /v1/bill-runs/{billRunKey}/emails
td
Email billing documents generated from a bill run
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
getBillRun
td
strong
GET
 /v1/bill-runs/{billRunId}
td
Retrieve a bill run
tr
td
em
ZuoraSdkJs.BillRunApi
td
strong
postBillRun
td
strong
PUT
 /v1/bill-runs/{billRunId}/post
td
Post a bill run
tr
td
em
ZuoraSdkJs.BillRunHealthApi
td
strong
getSystemHealthBillingDocVolumeSummary
td
strong
GET
 /system-health/billing-documents/volume-summary
td
List billing document volume summary records
tr
td
em
ZuoraSdkJs.BillingDocumentsApi
td
strong
createBillingDocumentFilesDeletionJob
td
strong
POST
 /v1/accounts/billing-documents/files/deletion-jobs
td
Create a job to hard delete billing document files
tr
td
em
ZuoraSdkJs.BillingDocumentsApi
td
strong
generateBillingDocuments
td
strong
POST
 /v1/accounts/{key}/billing-documents/generate
td
Generate billing documents by account ID
tr
td
em
ZuoraSdkJs.BillingDocumentsApi
td
strong
getBillingDocumentFilesDeletionJob
td
strong
GET
 /v1/accounts/billing-documents/files/deletion-jobs/{jobId}
td
Retrieve a job of hard deleting billing document files
tr
td
em
ZuoraSdkJs.BillingDocumentsApi
td
strong
getBillingDocuments
td
strong
GET
 /v1/billing-documents
td
List billing documents for an account
tr
td
em
ZuoraSdkJs.BillingPreviewRunApi
td
strong
createBillingPreviewRun
td
strong
POST
 /v1/billing-preview-runs
td
Create a billing preview run
tr
td
em
ZuoraSdkJs.BillingPreviewRunApi
td
strong
getBillingPreviewRun
td
strong
GET
 /v1/billing-preview-runs/{billingPreviewRunId}
td
Retrieve a billing preview run
tr
td
em
ZuoraSdkJs.BookingDateBackfillJobApi
td
strong
gETBookingDateBackfillJobById
td
strong
GET
 /v1/uno/data-backfill/bookingdate/jobs/{jobId}
td
Find BookingDate Backfill job by ID
tr
td
em
ZuoraSdkJs.BookingDateBackfillJobApi
td
strong
gETListBookingDateBackfillJobs
td
strong
GET
 /v1/uno/data-backfill/bookingdate/jobs
td
Query all Booking Date Backfill Jobs
tr
td
em
ZuoraSdkJs.BookingDateBackfillJobApi
td
strong
pOSTCreateBookingDateBackfillJob
td
strong
POST
 /v1/uno/data-backfill/bookingdate/jobs
td
Create a new BookingDate Backfil job
tr
td
em
ZuoraSdkJs.BookingDateBackfillJobApi
td
strong
pUTStopBookingDateBackfillJobById
td
strong
PUT
 /v1/uno/data-backfill/bookingdate/jobs/{jobId}
td
Stop BookingDate Backfill job by ID
tr
td
em
ZuoraSdkJs.CatalogGroupsApi
td
strong
createCatalogGroup
td
strong
POST
 /v1/catalog-groups
td
Create a catalog group
tr
td
em
ZuoraSdkJs.CatalogGroupsApi
td
strong
deleteCatalogGroup
td
strong
DELETE
 /v1/catalog-groups/{catalog-group-key}
td
Delete a catalog group
tr
td
em
ZuoraSdkJs.CatalogGroupsApi
td
strong
getCatalogGroup
td
strong
GET
 /v1/catalog-groups/{catalog-group-key}
td
Retrieve a catalog group
tr
td
em
ZuoraSdkJs.CatalogGroupsApi
td
strong
getCatalogGroups
td
strong
GET
 /v1/catalog-groups
td
List all catalog groups
tr
td
em
ZuoraSdkJs.CatalogGroupsApi
td
strong
updateCatalogGroup
td
strong
PUT
 /v1/catalog-groups/{catalog-group-key}
td
Update a catalog group
tr
td
em
ZuoraSdkJs.ContactSnapshotsApi
td
strong
getContactSnapshot
td
strong
GET
 /v1/contact-snapshots/{contact-snapshot-id}
td
Retrieve a contact snapshot
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
createContact
td
strong
POST
 /v1/contacts
td
Create a contact
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
deleteContact
td
strong
DELETE
 /v1/contacts/{contactId}
td
Delete a contact
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
getContact
td
strong
GET
 /v1/contacts/{contactId}
td
Retrieve a contact
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
scrubContact
td
strong
PUT
 /v1/contacts/{contactId}/scrub
td
Scrub a contact
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
transferContact
td
strong
PUT
 /v1/contacts/{contactId}/transfer
td
Transfer a contact
tr
td
em
ZuoraSdkJs.ContactsApi
td
strong
updateContact
td
strong
PUT
 /v1/contacts/{contactId}
td
Update a contact
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
applyCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/apply
td
Apply a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
applyCreditMemoAsync
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/apply-async
td
Async Apply a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
bulkCreateCreditMemos
td
strong
POST
 /v1/credit-memos/bulk
td
Create credit memos
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
bulkUpdateCreditMemos
td
strong
PUT
 /v1/credit-memos/bulk
td
Update credit memos
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
cancelAsyncCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/cancel-async
td
Cancel a Credit Memo in async
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
cancelCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/cancel
td
Cancel a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
createCreditMemoFromCharge
td
strong
POST
 /v1/credit-memos
td
Create a credit memo from a charge
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
createCreditMemoFromInvoice
td
strong
POST
 /v1/credit-memos/invoice/{invoiceKey}
td
Create a credit memo from an invoice
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
createCreditMemoTaxationItems
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/taxation-items
td
Create taxation items for a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
deleteCreditMemo
td
strong
DELETE
 /v1/credit-memos/{creditMemoKey}
td
Delete a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
emailCreditMemo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/emails
td
Email a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
generateCreditMemoPdf
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/pdfs
td
Generate a credit memo PDF file
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getApplyCreditMemoAsyncJob
td
strong
GET
 /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}
td
Get Async Apply Credit Memo Job by Id
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemo
td
strong
GET
 /v1/credit-memos/{creditMemoKey}
td
Retrieve a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoItem
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId}
td
Retrieve a credit memo item
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoItemPart
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts/{itemPartId}
td
Retrieve a credit memo part item
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoItemParts
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}/item-parts
td
List all credit memo part items
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoItems
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items
td
List credit memo items
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoPart
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts/{partId}
td
Retrieve a credit memo part
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoParts
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/parts
td
List all parts of a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemoPdfStatus
td
strong
GET
 /v1/credit-memos/pdf-status
td
Retrieve PDF status of credit memos in a batch.
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getCreditMemos
td
strong
GET
 /v1/credit-memos
td
List credit memos
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getTaxationItemsOfCreditMemoItem
td
strong
GET
 /v1/credit-memos/{creditMemoKey}/items/{creditMemoItemId}/taxation-items
td
List all taxation items of a credit memo item
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
getUnapplyCreditMemoAsyncJob
td
strong
GET
 /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}
td
Get Async Unapply Credit Memo Job by Id
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
postAsyncCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/post-async
td
Post a Credit Memo in async
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
postCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/post
td
Post a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
refundCreditMemo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/refund
td
Refund a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
reverseCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/reverse
td
Reverse a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
unapplyCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unapply
td
Unapply a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
unapplyCreditMemoAsync
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unapply-async
td
Async Unapply a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
unpostCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/unpost
td
Unpost a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
updateCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}
td
Update a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
uploadFileForCreditMemo
td
strong
POST
 /v1/credit-memos/{creditMemoKey}/files
td
Upload a file for a credit memo
tr
td
em
ZuoraSdkJs.CreditMemosApi
td
strong
writeOffCreditMemo
td
strong
PUT
 /v1/credit-memos/{creditMemoKey}/write-off
td
Write off a credit memo
tr
td
em
ZuoraSdkJs.CustomEventTriggersApi
td
strong
deleteEventTrigger
td
strong
DELETE
 /events/event-triggers/{id}
td
Delete an event trigger
tr
td
em
ZuoraSdkJs.CustomEventTriggersApi
td
strong
getEventTrigger
td
strong
GET
 /events/event-triggers/{id}
td
Retrieve an event trigger
tr
td
em
ZuoraSdkJs.CustomEventTriggersApi
td
strong
getEventTriggers
td
strong
GET
 /events/event-triggers
td
List event triggers
tr
td
em
ZuoraSdkJs.CustomEventTriggersApi
td
strong
postEventTrigger
td
strong
POST
 /events/event-triggers
td
Create an event trigger
tr
td
em
ZuoraSdkJs.CustomEventTriggersApi
td
strong
putEventTrigger
td
strong
PUT
 /events/event-triggers/{id}
td
Update an event trigger
tr
td
em
ZuoraSdkJs.CustomExchangeRatesApi
td
strong
getCustomExchangeRates
td
strong
GET
 /v1/custom-exchange-rates/{currency}
td
List custom exchange rates by currency
tr
td
em
ZuoraSdkJs.CustomObjectDefinitionsApi
td
strong
deleteCustomObjectDefinitionByType
td
strong
DELETE
 /objects/definitions/default/{object}
td
Delete a custom object definition
tr
td
em
ZuoraSdkJs.CustomObjectDefinitionsApi
td
strong
getAllCustomObjectDefinitionsInNamespace
td
strong
GET
 /objects/definitions/default
td
List custom object definitions
tr
td
em
ZuoraSdkJs.CustomObjectDefinitionsApi
td
strong
getCustomObjectDefinitionByType
td
strong
GET
 /objects/definitions/default/{object}
td
Retrieve a custom object definition
tr
td
em
ZuoraSdkJs.CustomObjectDefinitionsApi
td
strong
postCustomObjectDefinitions
td
strong
POST
 /objects/definitions/default
td
Create custom object definitions
tr
td
em
ZuoraSdkJs.CustomObjectDefinitionsApi
td
strong
postUpdateCustomObjectDefinition
td
strong
POST
 /objects/migrations
td
Update a custom object definition
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
getAllCustomObjectBulkJobs
td
strong
GET
 /objects/jobs
td
List all custom object bulk jobs
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
getCustomObjectBulkJob
td
strong
GET
 /objects/jobs/{id}
td
Retrieve a custom object bulk job
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
getCustomObjectBulkJobErrors
td
strong
GET
 /objects/jobs/{id}/errors
td
List all errors for a custom object bulk job
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
pATCHCustomObjectBulkJob
td
strong
PATCH
 /objects/jobs/{id}/cancel
td
Cancel a custom object bulk job
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
postCustomObjectBulkJob
td
strong
POST
 /objects/jobs
td
Submit a custom object bulk job
tr
td
em
ZuoraSdkJs.CustomObjectJobsApi
td
strong
postUploadFileForCustomObjectBulkJob
td
strong
POST
 /objects/jobs/{id}/files
td
Upload a file for a custom object bulk job
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
deleteCustomObjectRecordByID
td
strong
DELETE
 /objects/records/default/{object}/{id}
td
Delete a custom object record
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
getAllRecordsForCustomObjectType
td
strong
GET
 /objects/records/default/{object}
td
List records for a custom object
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
getCustomObjectRecordByID
td
strong
GET
 /objects/records/default/{object}/{id}
td
Retrieve a custom object record
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
patchPartialUpdateCustomObjectRecord
td
strong
PATCH
 /objects/records/default/{object}/{id}
td
Partially update a custom object record
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
postCustomObjectRecords
td
strong
POST
 /objects/records/default/{object}
td
Create custom object records
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
postCustomObjectRecordsBatchUpdateOrDelete
td
strong
POST
 /objects/batch/default/{object}
td
Update or delete custom object records
tr
td
em
ZuoraSdkJs.CustomObjectRecordsApi
td
strong
putCustomObjectRecord
td
strong
PUT
 /objects/records/default/{object}/{id}
td
Update a custom object record
tr
td
em
ZuoraSdkJs.CustomPaymentMethodTypesApi
td
strong
createOpenPaymentMethodType
td
strong
POST
 /open-payment-method-types
td
Create a draft custom payment method type
tr
td
em
ZuoraSdkJs.CustomPaymentMethodTypesApi
td
strong
getOpenPaymentMethodTypeRevision
td
strong
GET
 /open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}
td
Retrieve a specific draft revision of a custom payment method type
tr
td
em
ZuoraSdkJs.CustomPaymentMethodTypesApi
td
strong
getPublishedOpenPaymentMethodType
td
strong
GET
 /open-payment-method-types/{paymentMethodTypeName}/published
td
Retrieve a published custom payment method type
tr
td
em
ZuoraSdkJs.CustomPaymentMethodTypesApi
td
strong
publishOpenPaymentMethodType
td
strong
PUT
 /open-payment-method-types/publish/{paymentMethodTypeName}
td
Publish a custom payment method type
tr
td
em
ZuoraSdkJs.CustomPaymentMethodTypesApi
td
strong
updateOpenPaymentMethodType
td
strong
PUT
 /open-payment-method-types/{paymentMethodTypeName}
td
Update a custom payment method type
tr
td
em
ZuoraSdkJs.CustomScheduledEventsApi
td
strong
deleteScheduledEventByID
td
strong
DELETE
 /events/scheduled-events/{id}
td
Delete a scheduled event by ID
tr
td
em
ZuoraSdkJs.CustomScheduledEventsApi
td
strong
getScheduledEventByID
td
strong
GET
 /events/scheduled-events/{id}
td
Retrieve a scheduled event by ID
tr
td
em
ZuoraSdkJs.CustomScheduledEventsApi
td
strong
getScheduledEvents
td
strong
GET
 /events/scheduled-events
td
List all scheduled events
tr
td
em
ZuoraSdkJs.CustomScheduledEventsApi
td
strong
postScheduledEvent
td
strong
POST
 /events/scheduled-events
td
Create a scheduled event
tr
td
em
ZuoraSdkJs.CustomScheduledEventsApi
td
strong
updateScheduledEventByID
td
strong
PUT
 /events/scheduled-events/{id}
td
Update a scheduled event by ID
tr
td
em
ZuoraSdkJs.DataBackfillJobApi
td
strong
gETDataBackfillJobById
td
strong
GET
 /v1/uno/data-backfill/jobs/{jobId}
td
Find Data Backfill job by ID
tr
td
em
ZuoraSdkJs.DataBackfillJobApi
td
strong
gETDataBackfillTemplate
td
strong
GET
 /v1/uno/data-backfill/jobs/{type}/template
td
Download a Data Backfill template file
tr
td
em
ZuoraSdkJs.DataBackfillJobApi
td
strong
gETListDataBackfillJobs
td
strong
GET
 /v1/uno/date-backfill/listjobs
td
Query all data backfill jobs
tr
td
em
ZuoraSdkJs.DataBackfillJobApi
td
strong
pOSTCreateDataBackfillJob
td
strong
POST
 /v1/uno/data-backfill/jobs
td
Create a new Data Backfil job
tr
td
em
ZuoraSdkJs.DataBackfillJobApi
td
strong
pUTStopDataBackfillJobById
td
strong
PUT
 /v1/uno/data-backfill/jobs/{jobId}
td
Stop Data Backfill job by ID
tr
td
em
ZuoraSdkJs.DataLabelingApi
td
strong
getDataLabelingJob
td
strong
GET
 /v1/multi-organizations/data-labeling-job/{job-id}
td
Retrieve a data labeling job
tr
td
em
ZuoraSdkJs.DataLabelingApi
td
strong
submitDataLabelingJob
td
strong
POST
 /v1/multi-organizations/data-labeling-job
td
Submit a data labeling job
tr
td
em
ZuoraSdkJs.DataQueriesApi
td
strong
deleteDataQueryJob
td
strong
DELETE
 /query/jobs/{job-id}
td
Cancel a data query job
tr
td
em
ZuoraSdkJs.DataQueriesApi
td
strong
getDataQueryJob
td
strong
GET
 /query/jobs/{job-id}
td
Retrieve a data query job
tr
td
em
ZuoraSdkJs.DataQueriesApi
td
strong
getDataQueryJobs
td
strong
GET
 /query/jobs
td
List data query jobs
tr
td
em
ZuoraSdkJs.DataQueriesApi
td
strong
postDataQueryJob
td
strong
POST
 /query/jobs
td
Submit a data query
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
bulkCreateDebitMemos
td
strong
POST
 /v1/debit-memos/bulk
td
Create debit memos
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
bulkUpdateDebitMemos
td
strong
PUT
 /v1/debit-memos/bulk
td
Update debit memos
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
cancelAsyncDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/cancel-async
td
Cancel a Debit Memo in async
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
cancelDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/cancel
td
Cancel a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
collectDebitMemo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/collect
td
Collect a posted debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
createDebitMemoFromCharge
td
strong
POST
 /v1/debit-memos
td
Create a debit memo from a charge
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
createDebitMemoFromInvoice
td
strong
POST
 /v1/debit-memos/invoice/{invoiceKey}
td
Create a debit memo from an invoice
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
createTaxationItemsForDebitMemo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/taxation-items
td
Create taxation items for a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
deleteDebitMemo
td
strong
DELETE
 /v1/debit-memos/{debitMemoKey}
td
Delete a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
emailDebitMemo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/emails
td
Email a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
generateDebitMemoPdf
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/pdfs
td
Generate a debit memo PDF file
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemo
td
strong
GET
 /v1/debit-memos/{debitMemoKey}
td
Retrieve a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemoApplicationParts
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/application-parts
td
List all application parts of a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemoItem
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId}
td
Retrieve a debit memo item
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemoItems
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items
td
List debit memo items
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemoPdfStatus
td
strong
GET
 /v1/debit-memos/pdf-status
td
Retrieve PDF status of debit memos in a batch.
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getDebitMemos
td
strong
GET
 /v1/debit-memos
td
List debit memos
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
getTaxationItemsOfDebitMemoItem
td
strong
GET
 /v1/debit-memos/{debitMemoKey}/items/{debitMemoItemId}/taxation-items
td
List all taxation items of a debit memo item
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
postAsyncDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/post-async
td
Post a Debit Memo in async
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
postDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/post
td
Post a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
unpostDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}/unpost
td
Unpost a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
updateDebitMemo
td
strong
PUT
 /v1/debit-memos/{debitMemoKey}
td
Update a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
updateDebitMemosDueDates
td
strong
PUT
 /v1/debit-memos
td
Update due dates for debit memos
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
uploadFileForDebitMemo
td
strong
POST
 /v1/debit-memos/{debitMemoKey}/files
td
Upload a file for a debit memo
tr
td
em
ZuoraSdkJs.DebitMemosApi
td
strong
writeOffDebitMemo
td
strong
PUT
 /v1/debitmemos/{debitMemoKey}/write-off
td
Write off an debit memo
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
compareAndDeployProductCatalogTemplate
td
strong
POST
 /deployment-manager/deployments/template/product_catalog
td
Compare and Deploy a template for product catalog to a target tenant
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
compareAndDeployProductCatalogTenant
td
strong
POST
 /deployment-manager/deployments/tenant/product_catalog
td
Compare and Deploy product catalog between a source tenant and a target tenant
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
compareAndDeployTemplate
td
strong
POST
 /deployment-manager/deployments/templates
td
Compare and Deploy settings from a template to a target tenant
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
compareAndDeployTenant
td
strong
POST
 /deployment-manager/deployments/tenants
td
Compare and Deploy settings between a source tenant and a target tenant
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
retrieveDeployment
td
strong
GET
 /deployment-manager/deployments/{migrationId}
td
Retrieves a deployment log.
tr
td
em
ZuoraSdkJs.DeploymentApi
td
strong
revertDeployment
td
strong
POST
 /deployment-manager/deployments/{migrationId}/revert
td
Reverts the deployment.
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
compareTemplate
td
strong
POST
 /deployment-manager/deployment_artifacts/compare
td
Compare settings between a source tenant and a target tenant
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
createDeploymentTemplate
td
strong
POST
 /deployment-manager/deployment_templates
td
Create a deployment template
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
deleteDeploymentTemplate
td
strong
DELETE
 /deployment-manager/deployment_templates/{id}
td
Delete a template
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
downloadDeploymentTemplate
td
strong
GET
 /deployment-manager/deployment_artifacts
td
Download a template
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
getDeploymentTemplateDetail
td
strong
GET
 /deployment-manager/deployment_templates/{id}
td
List all details of a template
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
getDeploymentTemplates
td
strong
GET
 /deployment-manager/deployment_templates
td
List all templates
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
getSourceComponentDetails
td
strong
GET
 /deployment-manager/deployment_artifacts/retrieve-settings
td
List all details of source components
tr
td
em
ZuoraSdkJs.DeploymentConfigurationTemplatesApi
td
strong
migrateTenantSettings
td
strong
POST
 /deployment-manager/deployment_artifacts/deploy
td
Migrate settings from source tenant to target tenant
tr
td
em
ZuoraSdkJs.DescribeApi
td
strong
getDescribe
td
strong
GET
 /v1/describe/{object}
td
Describe an object
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
deleteBusinessRegion
td
strong
DELETE
 /v1/e-invoice/business-regions/{key}
td
Delete a Business Region
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
deleteServiceProvider
td
strong
DELETE
 /v1/e-invoice/service-providers/{key}
td
Delete a Service Provider
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
getBusinessRegion
td
strong
GET
 /v1/e-invoice/business-regions/{key}
td
Retrieve a Business Region
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
getBusinessRegions
td
strong
GET
 /v1/e-invoice/business-regions
td
List business region
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
getServiceProvider
td
strong
GET
 /v1/e-invoice/service-providers/{key}
td
Retrieve a Service Provider
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
getServiceProviders
td
strong
GET
 /v1/e-invoice/service-providers
td
List Service Provider
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
postBusinessRegion
td
strong
POST
 /v1/e-invoice/business-regions
td
Post a Business Region
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
postServiceProvider
td
strong
POST
 /v1/e-invoice/service-providers
td
Post a Service Provider
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
updateBusinessRegion
td
strong
PUT
 /v1/e-invoice/business-regions/{key}
td
Update a Business Region
tr
td
em
ZuoraSdkJs.EInvoicingApi
td
strong
updateServiceProvider
td
strong
PUT
 /v1/e-invoice/service-providers/{key}
td
Update a Service Provider
tr
td
em
ZuoraSdkJs.ElectronicPaymentsHealthApi
td
strong
getSystemHealthPaymentVolumeSummary
td
strong
GET
 /system-health/payments/volume-summary
td
List payment volume summary records
tr
td
em
ZuoraSdkJs.FilesApi
td
strong
getFiles
td
strong
GET
 /v1/files/{file-id}
td
Retrieve a file
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
createFulfillment
td
strong
POST
 /v1/fulfillments
td
Create fulfillments
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
createFulfillmentItem
td
strong
POST
 /v1/fulfillment-items
td
Create fulfillment items
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
deleteFulfillment
td
strong
DELETE
 /v1/fulfillments/{key}
td
Delete a fulfillment
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
deleteFulfillmentItem
td
strong
DELETE
 /v1/fulfillment-items/{id}
td
Delete a fulfillment item
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
getFulfillment
td
strong
GET
 /v1/fulfillments/{key}
td
Retrieve a fulfillment
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
getFulfillmentItem
td
strong
GET
 /v1/fulfillment-items/{id}
td
Retrieve a fulfillment item
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
updateFulfillment
td
strong
PUT
 /v1/fulfillments/{key}
td
Update a fulfillment
tr
td
em
ZuoraSdkJs.FulfillmentsApi
td
strong
updateFulfillmentItem
td
strong
PUT
 /v1/fulfillment-items/{id}
td
Update a fulfillment item
tr
td
em
ZuoraSdkJs.HostedPagesApi
td
strong
getHostedPages
td
strong
GET
 /v1/hostedpages
td
List hosted pages
tr
td
em
ZuoraSdkJs.ImportsApi
td
strong
objectGetImport
td
strong
GET
 /v1/object/import/{id}
td
CRUD: Retrieve an import
tr
td
em
ZuoraSdkJs.ImportsApi
td
strong
objectPostImport
td
strong
POST
 /v1/object/import
td
CRUD: Create an import
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
attachInvoiceSchedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/attach
td
Attach an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
createInvoiceSchedule
td
strong
POST
 /v1/invoice-schedules
td
Create an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
deleteInvoiceSchedule
td
strong
DELETE
 /v1/invoice-schedules/{scheduleKey}
td
Delete an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
detachInvoiceSchedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/detach
td
Detach an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
executeInvoiceSchedule
td
strong
POST
 /v1/invoice-schedules/{scheduleKey}/execute
td
Execute an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
getInvoiceSchedule
td
strong
GET
 /v1/invoice-schedules/{scheduleKey}
td
Retrieve an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
pauseInvoiceSchedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/pause
td
Pause an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
resumeInvoiceSchedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}/resume
td
Resume an invoice schedule
tr
td
em
ZuoraSdkJs.InvoiceSchedulesApi
td
strong
updateInvoiceSchedule
td
strong
PUT
 /v1/invoice-schedules/{scheduleKey}
td
Update an invoice schedule
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
bulkCreateStandaloneInvoices
td
strong
POST
 /v1/invoices/batch
td
Create standalone invoices
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
bulkPostInvoices
td
strong
POST
 /v1/invoices/bulk-post
td
Post invoices
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
bulkUpdateInvoices
td
strong
PUT
 /v1/invoices
td
Update invoices
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
cancelInvoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/cancel
td
Cancel an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
createInvoiceTaxationItems
td
strong
POST
 /v1/invoices/{invoiceKey}/taxation-items
td
Create taxation items for an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
createStandaloneInvoice
td
strong
POST
 /v1/invoices
td
Create a standalone invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
deleteInvoice
td
strong
DELETE
 /v1/invoices/{invoiceKey}
td
Delete an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
emailInvoice
td
strong
POST
 /v1/invoices/{invoiceKey}/emails
td
Email an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getInvoice
td
strong
GET
 /v1/invoices/{invoiceKey}
td
Retrieve an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getInvoiceApplicationParts
td
strong
GET
 /v1/invoices/{invoiceKey}/application-parts
td
List all application parts of an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getInvoiceFiles
td
strong
GET
 /v1/invoices/{invoiceKey}/files
td
List all files of an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getInvoiceItems
td
strong
GET
 /v1/invoices/{invoiceKey}/items
td
List all items of an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getInvoicePdfStatus
td
strong
GET
 /v1/invoices/pdf-status
td
Retrieve PDF status of invoices in a batch.
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
getTaxationItemsOfInvoiceItem
td
strong
GET
 /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items
td
List all taxation items of an invoice item
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
postInvoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/post
td
Cancel an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
reverseInvoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/reverse
td
Reverse an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
updateInvoice
td
strong
PUT
 /v1/invoices/{invoiceKey}
td
Update an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
uploadFileForInvoice
td
strong
POST
 /v1/invoices/{invoiceKey}/files
td
Upload a file for an invoice
tr
td
em
ZuoraSdkJs.InvoicesApi
td
strong
writeOffInvoice
td
strong
PUT
 /v1/invoices/{invoiceKey}/write-off
td
Write off an invoice
tr
td
em
ZuoraSdkJs.JournalRunsApi
td
strong
cancelJournalRun
td
strong
PUT
 /v1/journal-runs/{jr-number}/cancel
td
Cancel a journal run
tr
td
em
ZuoraSdkJs.JournalRunsApi
td
strong
createJournalRun
td
strong
POST
 /v1/journal-runs
td
Create a journal run
tr
td
em
ZuoraSdkJs.JournalRunsApi
td
strong
deleteJournalRun
td
strong
DELETE
 /v1/journal-runs/{jr-number}
td
Delete a journal run
tr
td
em
ZuoraSdkJs.JournalRunsApi
td
strong
getJournalRun
td
strong
GET
 /v1/journal-runs/{jr-number}
td
Retrieve a journal run
tr
td
em
ZuoraSdkJs.MassUpdaterApi
td
strong
createMassUpdater
td
strong
POST
 /v1/bulk
td
Perform a mass action
tr
td
em
ZuoraSdkJs.MassUpdaterApi
td
strong
getMassUpdater
td
strong
GET
 /v1/bulk/{bulk-key}
td
List all results of a mass action
tr
td
em
ZuoraSdkJs.MassUpdaterApi
td
strong
stopMassUpdater
td
strong
PUT
 /v1/bulk/{bulk-key}/stop
td
Stop a mass action
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
createNotificationDefinition
td
strong
POST
 /notifications/notification-definitions
td
Create a notification definition
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
createOrUpdateEmailTemplates
td
strong
POST
 /notifications/email-templates/import
td
Create or update email templates
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
deleteEmailTemplate
td
strong
DELETE
 /notifications/email-templates/{id}
td
Delete an email template
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
deleteNotificationDefinition
td
strong
DELETE
 /notifications/notification-definitions/{id}
td
Delete a notification definition
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
deleteNotificationHistoryForAccount
td
strong
DELETE
 /notifications/history
td
Delete notification histories for an account
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
getCalloutHistory
td
strong
GET
 /v1/notification-history/callout
td
List callout notification histories
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
getEmailHistory
td
strong
GET
 /v1/notification-history/email
td
List email notification histories
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
getEmailTemplate
td
strong
GET
 /notifications/email-templates/{id}
td
Retrieve an email template
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
getNotificationDefinition
td
strong
GET
 /notifications/notification-definitions/{id}
td
Retrieve a notification definition
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
getNotificationHistoryDeletionTask
td
strong
GET
 /notifications/history/tasks/{id}
td
Retrieve a notification history deletion task
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
postCreateEmailTemplate
td
strong
POST
 /notifications/email-templates
td
Create an email template
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
queryEmailTemplates
td
strong
GET
 /notifications/email-templates
td
List email templates
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
queryNotificationDefinitions
td
strong
GET
 /notifications/notification-definitions
td
List notification definitions
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
resendCalloutNotifications
td
strong
POST
 /notifications/callout-histories/resend
td
Resend callout notifications
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
resendEmailNotifications
td
strong
POST
 /notifications/email-histories/resend
td
Resend email notifications
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
updateEmailTemplate
td
strong
PUT
 /notifications/email-templates/{id}
td
Update an email template
tr
td
em
ZuoraSdkJs.NotificationsApi
td
strong
updateNotificationDefinition
td
strong
PUT
 /notifications/notification-definitions/{id}
td
Update a notification definition
tr
td
em
ZuoraSdkJs.OAuthApi
td
strong
createToken
td
strong
POST
 /oauth/token
td
Create an OAuth token
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryAccountByKey
td
strong
GET
 /object-query/accounts/{key}
td
Retrieve an account
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryAccounts
td
strong
GET
 /object-query/accounts
td
List accounts
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryAmendmentByKey
td
strong
GET
 /object-query/amendments/{key}
td
Retrieve an amendment
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryAmendments
td
strong
GET
 /object-query/amendments
td
List amendments
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryBillingRunByKey
td
strong
GET
 /object-query/billing-runs/{key}
td
Retrieve a bill run
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryBillingRuns
td
strong
GET
 /object-query/billing-runs
td
List bill runs
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryContactByKey
td
strong
GET
 /object-query/contacts/{key}
td
Retrieve a contact
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryContacts
td
strong
GET
 /object-query/contacts
td
List contacts
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemoApplicationByKey
td
strong
GET
 /object-query/credit-memo-applications/{key}
td
Retrieve a credit memo application
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemoApplications
td
strong
GET
 /object-query/credit-memo-applications
td
List credit memo applications
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemoByKey
td
strong
GET
 /object-query/credit-memos/{key}
td
Retrieve a credit memo
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemoItemByKey
td
strong
GET
 /object-query/credit-memo-items/{key}
td
Retrieve a credit memo item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemoItems
td
strong
GET
 /object-query/credit-memo-items
td
List credit memo items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCreditMemos
td
strong
GET
 /object-query/credit-memos
td
List credit memos
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCustomObjectBykey
td
strong
GET
 /object-query/{custom-object-name}/{key}
td
Retrieve a custom object
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryCustomObjects
td
strong
GET
 /object-query/{custom-object-name}
td
List custom objects
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDailyConsumptionSummaryByKey
td
strong
GET
 /object-query/daily-consumption-summaries/{key}
td
Retrieve a daily consumption summary
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDailyConsumptionSummarys
td
strong
GET
 /object-query/daily-consumption-summaries
td
List daily consumption summaries
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDebitMemoByKey
td
strong
GET
 /object-query/debit-memos/{key}
td
Retrieve a debit memo
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDebitMemoItemByKey
td
strong
GET
 /object-query/debit-memo-items/{key}
td
Retrieve a debit memo item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDebitMemoItems
td
strong
GET
 /object-query/debit-memo-items
td
List debit memo items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryDebitMemos
td
strong
GET
 /object-query/debit-memos
td
List debit memos
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryInvoiceByKey
td
strong
GET
 /object-query/invoices/{key}
td
Retrieve an invoice
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryInvoiceItemByKey
td
strong
GET
 /object-query/invoice-items/{key}
td
Retrieve an invoice item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryInvoiceItems
td
strong
GET
 /object-query/invoice-items
td
List invoice items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryInvoices
td
strong
GET
 /object-query/invoices
td
List invoices
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
strong
queryInvoiceScheduleByKey
td
strong
GET
 /object-query/invoice-schedules/{key}
td
Retrieve an invoice schedule
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
strong
queryInvoiceSchedules
td
strong
GET
 /object-query/invoice-schedules
td
List invoice schedules
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrderActionByKey
td
strong
GET
 /object-query/order-actions/{key}
td
Retrieve an order action
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrderActions
td
strong
GET
 /object-query/order-actions
td
List order actions
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrderLineItemByKey
td
strong
GET
 /object-query/order-line-items/{key}
td
Retrieve an order line item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrderLineItems
td
strong
GET
 /object-query/order-line-items
td
List order line items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrdersByKey
td
strong
GET
 /object-query/orders/{key}
td
Retrieve an order
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryOrderss
td
strong
GET
 /object-query/orders
td
List orders
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentApplicationByKey
td
strong
GET
 /object-query/payment-applications/{key}
td
Retrieve a payment application
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentApplications
td
strong
GET
 /object-query/payment-applications
td
List payment applications
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentByKey
td
strong
GET
 /object-query/payments/{key}
td
Retrieve a payment
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentMethodByKey
td
strong
GET
 /object-query/payment-methods/{key}
td
Retrieve a payment method
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentMethodSnapshotByKey
td
strong
GET
 /object-query/payment-method-snapshots/{key}
td
Retrieve a payment method snapshot
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentMethodSnapshots
td
strong
GET
 /object-query/payment-method-snapshots
td
List payment method snapshots
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentMethods
td
strong
GET
 /object-query/payment-methods
td
List payment methods
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentRunByKey
td
strong
GET
 /object-query/payment-runs/{key}
td
Retrieve a payment run
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentRuns
td
strong
GET
 /object-query/payment-runs
td
List payment runs
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentScheduleByKey
td
strong
GET
 /object-query/payment-schedules/{key}
td
Retrieve a payment schedule
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentScheduleItemByKey
td
strong
GET
 /object-query/payment-schedule-items/{key}
td
Retrieve a payment schedule item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentScheduleItems
td
strong
GET
 /object-query/payment-schedule-items
td
List payment schedule items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPaymentSchedules
td
strong
GET
 /object-query/payment-schedules
td
List payment schedules
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPayments
td
strong
GET
 /object-query/payments
td
List payments
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalanceByKey
td
strong
GET
 /object-query/prepaid-balances/{key}
td
Retrieve a prepaid balance
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalanceFundByKey
td
strong
GET
 /object-query/prepaid-balance-funds/{key}
td
Retrieve a prepaid balance fund
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalanceFunds
td
strong
GET
 /object-query/prepaid-balance-funds
td
List prepaid balance funds
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalanceTransactionByKey
td
strong
GET
 /object-query/prepaid-balance-transactions/{key}
td
Retrieve a prepaid balance transaction
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalanceTransactions
td
strong
GET
 /object-query/prepaid-balance-transactions
td
List prepaid balance transactions
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryPrepaidBalances
td
strong
GET
 /object-query/prepaid-balances
td
List prepaid balances
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProcessedUsageByKey
td
strong
GET
 /object-query/processed-usages/{key}
td
Retrieve a processed usage record
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProcessedUsages
td
strong
GET
 /object-query/processed-usages
td
List processed usage records
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductByKey
td
strong
GET
 /object-query/products/{key}
td
Retrieve a product
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlanByKey
td
strong
GET
 /object-query/product-rate-plans/{key}
td
Retrieve a product rate plan
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlanChargeByKey
td
strong
GET
 /object-query/product-rate-plan-charges/{key}
td
Retrieve a product rate plan charge
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlanChargeTierByKey
td
strong
GET
 /object-query/product-rate-plan-charge-tiers/{key}
td
Retrieve a product rate plan charge tier
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlanChargeTiers
td
strong
GET
 /object-query/product-rate-plan-charge-tiers
td
List product rate plan charge tiers
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlanCharges
td
strong
GET
 /object-query/product-rate-plan-charges
td
List product rate plan charges
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProductRatePlans
td
strong
GET
 /object-query/product-rate-plans
td
List product rate plans
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryProducts
td
strong
GET
 /object-query/products
td
List products
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlanByKey
td
strong
GET
 /object-query/rate-plans/{key}
td
Retrieve a rate plan
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlanChargeByKey
td
strong
GET
 /object-query/rate-plan-charges/{key}
td
Retrieve a rate plan charge
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlanChargeTierByKey
td
strong
GET
 /object-query/rate-plan-charge-tiers/{key}
td
Retrieve a rate plan charge tier
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlanChargeTiers
td
strong
GET
 /object-query/rate-plan-charge-tiers
td
List rate plan charge tiers
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlanCharges
td
strong
GET
 /object-query/rate-plan-charges
td
List rate plan charges
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatePlans
td
strong
GET
 /object-query/rate-plans
td
List rate plans
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
strong
queryRatingDetailByKey
td
strong
GET
 /object-query/rating-details/{key}
td
Retrieve a rating detail
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
strong
queryRatingDetails
td
strong
GET
 /object-query/rating-details
td
List rating details
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatingResultByKey
td
strong
GET
 /object-query/rating-results/{key}
td
Retrieve a rating result
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRatingResults
td
strong
GET
 /object-query/rating-results
td
List rating results
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefundApplicationByKey
td
strong
GET
 /object-query/refund-applications/{key}
td
Retrieve a refund application
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefundApplicationItemByKey
td
strong
GET
 /object-query/refund-application-items/{key}
td
Retrieve a refund application item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefundApplicationItems
td
strong
GET
 /object-query/refund-application-items
td
List refund application items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefundApplications
td
strong
GET
 /object-query/refund-applications
td
List refund applications
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefundByKey
td
strong
GET
 /object-query/refunds/{key}
td
Retrieve a refund
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryRefunds
td
strong
GET
 /object-query/refunds
td
List refunds
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySubscriptionByKey
td
strong
GET
 /object-query/subscriptions/{key}
td
Retrieve a subscription
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySubscriptions
td
strong
GET
 /object-query/subscriptions
td
List subscriptions
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySummaryStatementByKey
td
strong
GET
 /object-query/summarystatements/{key}
td
Retrieve a summary statement
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySummaryStatementRunByKey
td
strong
GET
 /object-query/summarystatementruns/{key}
td
Retrieve a summary statement run
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySummaryStatementRuns
td
strong
GET
 /object-query/summarystatementruns
td
List summary statement runs
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
querySummaryStatements
td
strong
GET
 /object-query/summarystatements
td
List summary statements
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryTaxationItemByKey
td
strong
GET
 /object-query/taxation-items/{key}
td
Retrieve a taxation item
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryTaxationItems
td
strong
GET
 /object-query/taxation-items
td
List taxation items
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryUsageByKey
td
strong
GET
 /object-query/usages/{key}
td
Retrieve a usage record
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryUsages
td
strong
GET
 /object-query/usages
td
List usage records
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryValidityPeriodSummaryByKey
td
strong
GET
 /object-query/validity-period-summaries/{key}
td
Retrieve a validity period summary
tr
td
em
ZuoraSdkJs.ObjectQueriesApi
td
queryValidityPeriodSummarys
td
strong
GET
 /object-query/validity-period-summaries
td
List validity period summaries
tr
td
em
ZuoraSdkJs.OmniChannelSubscriptionsApi
td
strong
createOmniChannelSubscription
td
strong
POST
 /v1/omni-channel-subscriptions
td
Create an omnichannel subscription
tr
td
em
ZuoraSdkJs.OmniChannelSubscriptionsApi
td
strong
deleteOmniChannelSubscription
td
strong
DELETE
 /v1/omni-channel-subscriptions/{subscriptionKey}
td
Delete an omnichannel subscription
tr
td
em
ZuoraSdkJs.OmniChannelSubscriptionsApi
td
strong
getOmniChannelSubscription
td
strong
GET
 /v1/omni-channel-subscriptions/{subscriptionKey}
td
Retrieve an omnichannel subscription
tr
td
em
ZuoraSdkJs.OperationsApi
td
strong
createBillingPreview
td
strong
POST
 /v1/operations/billing-preview
td
Generate a billing preview
tr
td
em
ZuoraSdkJs.OperationsApi
td
strong
createBulkPDFToZIPGeneration
td
strong
POST
 /v1/operations/bulk-pdf
td
Export bulk PDF files
tr
td
em
ZuoraSdkJs.OperationsApi
td
strong
createInvoiceCollect
td
strong
POST
 /v1/operations/invoice-collect
td
Invoice and collect
tr
td
em
ZuoraSdkJs.OperationsApi
td
strong
getBulkPDFToZIPGeneration
td
strong
GET
 /v1/operations/bulk-pdf/{jobId}
td
Retrieve information of a bulk PDF file generation job
tr
td
em
ZuoraSdkJs.OperationsApi
td
strong
getOperationJob
td
strong
GET
 /v1/operations/jobs/{jobId}
td
Retrieve an operation job
tr
td
em
ZuoraSdkJs.OrderActionsApi
td
strong
updateOrderAction
td
strong
PUT
 /v1/orderActions/{id}
td
Update an order action
tr
td
em
ZuoraSdkJs.OrderLineItemsApi
td
strong
getOrderLineItem
td
strong
GET
 /v1/order-line-items/{itemId}
td
Retrieve an order line item
tr
td
em
ZuoraSdkJs.OrderLineItemsApi
td
strong
updateOrderLineItem
td
strong
PUT
 /v1/order-line-items/{itemId}
td
Update an order line item
tr
td
em
ZuoraSdkJs.OrderLineItemsApi
td
strong
updateOrderLineItems
td
strong
POST
 /v1/order-line-items/bulk
td
Update order line items
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
activateOrder
td
strong
PUT
 /v1/orders/{orderNumber}/activate
td
Activate an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
cancelOrder
td
strong
PUT
 /v1/orders/{orderNumber}/cancel
td
Cancel an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
createOrder
td
strong
POST
 /v1/orders
td
Create an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
createOrderAsynchronously
td
strong
POST
 /v1/async/orders
td
Create an order asynchronously
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
deleteOrder
td
strong
DELETE
 /v1/orders/{orderNumber}
td
Delete an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
deleteOrderAsynchronously
td
strong
DELETE
 /v1/async/orders/{orderNumber}
td
Async Delete an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getJobStatusAndResponse
td
strong
GET
 /v1/async-jobs/{jobId}
td
Retrieve the status and response of a job
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getOrder
td
strong
GET
 /v1/orders/{orderNumber}
td
Retrieve an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getOrders
td
strong
GET
 /v1/orders
td
List orders
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getOrdersByInvoiceOwner
td
strong
GET
 /v1/orders/invoiceOwner/{accountNumber}
td
List orders of an invoice owner
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getOrdersBySubscriptionNumber
td
strong
GET
 /v1/orders/subscription/{subscriptionNumber}
td
List orders by subscription number
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getOrdersBySubscriptionOwner
td
strong
GET
 /v1/orders/subscriptionOwner/{accountNumber}
td
List orders of a subscription owner
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
getPendingOrdersBySubscriptionNumber
td
strong
GET
 /v1/orders/subscription/{subscription-key}/pending
td
List pending orders by subscription number
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
previewOrder
td
strong
POST
 /v1/orders/preview
td
Preview an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
previewOrderAsynchronously
td
strong
POST
 /v1/async/orders/preview
td
Preview an order asynchronously
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
revertOrder
td
strong
POST
 /v1/orders/{orderNumber}/revert
td
Revert an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
updateOrder
td
strong
PUT
 /v1/orders/{orderNumber}
td
Update an order
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
updateOrderCustomFields
td
strong
PUT
 /v1/orders/{orderNumber}/customFields
td
Update order custom fields
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
updateOrderTriggerDates
td
strong
PUT
 /v1/orders/{orderNumber}/triggerDates
td
Update order action trigger dates
tr
td
em
ZuoraSdkJs.OrdersApi
td
strong
updateSubscriptionCustomFields
td
strong
PUT
 /v1/subscriptions/{subscriptionNumber}/customFields
td
Update subscription custom fields
tr
td
em
ZuoraSdkJs.PaymentAuthorizationApi
td
strong
cancelAuthorization
td
strong
POST
 /v1/payment-methods/{payment-method-id}/voidAuthorize
td
Cancel authorization
tr
td
em
ZuoraSdkJs.PaymentAuthorizationApi
td
strong
createAuthorization
td
strong
POST
 /v1/payment-methods/{payment-method-id}/authorize
td
Create authorization
tr
td
em
ZuoraSdkJs.PaymentGatewayReconciliationApi
td
strong
reconcileRefund
td
strong
POST
 /v1/refunds/{refund-key}/reconcile
td
Reconcile a refund
tr
td
em
ZuoraSdkJs.PaymentGatewayReconciliationApi
td
strong
rejectPayment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/reject
td
Reject a payment
tr
td
em
ZuoraSdkJs.PaymentGatewayReconciliationApi
td
strong
reversePayment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/chargeback
td
Reverse a payment
tr
td
em
ZuoraSdkJs.PaymentGatewayReconciliationApi
td
strong
settlePayment
td
strong
POST
 /v1/gateway-settlement/payments/{payment-key}/settle
td
Settle a payment
tr
td
em
ZuoraSdkJs.PaymentGatewaysApi
td
strong
createPredebitNotification
td
strong
POST
 /v1/payment-gateways/pre-debit-notification
td
Trigger a pre-debit notification
tr
td
em
ZuoraSdkJs.PaymentGatewaysApi
td
strong
getPaymentGateways
td
strong
GET
 /v1/payment-gateways
td
List all payment gateways
tr
td
em
ZuoraSdkJs.PaymentMethodSnapshotsApi
td
strong
getPaymentMethodSnapshot
td
strong
GET
 /v1/object/payment-method-snapshot/{id}
td
CRUD: Retrieve a payment method snapshot
tr
td
em
ZuoraSdkJs.PaymentMethodTransactionLogsApi
td
strong
getPaymentMethodTransactionLog
td
strong
GET
 /v1/object/payment-method-transaction-log/{id}
td
CRUD: Retrieve a payment method transaction log
tr
td
em
ZuoraSdkJs.PaymentMethodUpdaterApi
td
strong
createPaymentMethodUpdaterBatch
td
strong
POST
 /v1/payment-method-updaters/batches
td
Create a Payment Method Updater batch asynchronously
tr
td
em
ZuoraSdkJs.PaymentMethodUpdaterApi
td
strong
getPaymentMethodUpdaterInstances
td
strong
GET
 /v1/payment-method-updaters
td
List Payment Method Updater instances
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
cancelStoredCredentialProfile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel
td
Cancel a stored credential profile
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
createPaymentMethod
td
strong
POST
 /v1/payment-methods
td
Create a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
createPaymentSession
td
strong
POST
 /web-payments/sessions
td
Create a payment session
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
createStoredCredentialProfile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles
td
Create a stored credential profile
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
decryptPaymentMethod
td
strong
POST
 /v1/payment-methods/decryption
td
Create an Apple Pay payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
deletePaymentMethod
td
strong
DELETE
 /v1/payment-methods/{payment-method-id}
td
Delete a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
expireStoredCredentialProfile
td
strong
POST
 /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire
td
Expire a stored credential profile
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
getPaymentMethod
td
strong
GET
 /v1/payment-methods/{payment-method-id}
td
Retrieve a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
getStoredCredentialProfiles
td
strong
GET
 /v1/payment-methods/{payment-method-id}/profiles
td
List stored credential profiles of a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
scrubPaymentMethod
td
strong
PUT
 /v1/payment-methods/{payment-method-id}/scrub
td
Scrub a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
updatePaymentMethod
td
strong
PUT
 /v1/payment-methods/{payment-method-id}
td
Update a payment method
tr
td
em
ZuoraSdkJs.PaymentMethodsApi
td
strong
verifyPaymentMethod
td
strong
PUT
 /v1/payment-methods/{payment-method-id}/verify
td
Verify a payment method
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
createPaymentRun
td
strong
POST
 /v1/payment-runs
td
Create a payment run
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
deletePaymentRun
td
strong
DELETE
 /v1/payment-runs/{paymentRunKey}
td
Delete a payment run
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
getPaymentRun
td
strong
GET
 /v1/payment-runs/{paymentRunKey}
td
Retrieve a payment run
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
getPaymentRunData
td
strong
GET
 /v1/payment-runs/{paymentRunKey}/data
td
Retrieve payment run data
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
getPaymentRunSummary
td
strong
GET
 /v1/payment-runs/{paymentRunKey}/summary
td
Retrieve a payment run summary
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
getPaymentRuns
td
strong
GET
 /v1/payment-runs
td
List payment runs
tr
td
em
ZuoraSdkJs.PaymentRunsApi
td
strong
updatePaymentRun
td
strong
PUT
 /v1/payment-runs/{paymentRunKey}
td
Update a payment run
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
addItemsToCustomPaymentSchedule
td
strong
POST
 /v1/payment-schedules/{paymentScheduleKey}/items
td
Add payment schedule items to a custom payment schedule
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
cancelPaymentSchedule
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}/cancel
td
Cancel a payment schedule
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
cancelPaymentScheduleItem
td
strong
PUT
 /v1/payment-schedule-items/{item-id}/cancel
td
Cancel a payment schedule item
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
createPaymentSchedule
td
strong
POST
 /v1/payment-schedules
td
Create a payment schedule
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
createPaymentSchedules
td
strong
POST
 /v1/payment-schedules/batch
td
Create multiple payment schedules at once
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
getPaymentSchedule
td
strong
GET
 /v1/payment-schedules/{paymentScheduleKey}
td
Retrieve a payment schedule
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
getPaymentScheduleItem
td
strong
GET
 /v1/payment-schedule-items/{item-id}
td
Retrieve a payment schedule item
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
getPaymentScheduleStatistic
td
strong
GET
 /v1/payment-schedules/statistics/{yyyy-mm-dd}
td
Retrieve payment schedule statistic of a date
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
getPaymentSchedules
td
strong
GET
 /v1/payment-schedules
td
List payment schedules by customer account
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
retryPaymentScheduleItem
td
strong
POST
 /v1/payment-schedule-items/retry-payment
td
Retry failed payment schedule items
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
skipPaymentScheduleItem
td
strong
PUT
 /v1/payment-schedule-items/{item-id}/skip
td
Skip a payment schedule item
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
updatePaymentSchedule
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}
td
Update a payment schedule
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
updatePaymentScheduleItem
td
strong
PUT
 /v1/payment-schedule-items/{item-id}
td
Update a payment schedule item
tr
td
em
ZuoraSdkJs.PaymentSchedulesApi
td
strong
updatePaymentSchedulePreview
td
strong
PUT
 /v1/payment-schedules/{paymentScheduleKey}/preview
td
Preview the result of payment schedule updates
tr
td
em
ZuoraSdkJs.PaymentTransactionLogsApi
td
strong
getPaymentTransactionLog
td
strong
GET
 /v1/object/payment-transaction-log/{id}
td
CRUD: Retrieve a payment transaction log
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
applyPayment
td
strong
PUT
 /v1/payments/{paymentKey}/apply
td
Apply a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
cancelPayment
td
strong
PUT
 /v1/payments/{paymentKey}/cancel
td
Cancel a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
createPayment
td
strong
POST
 /v1/payments
td
Create a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
createRefundPayment
td
strong
POST
 /v1/payments/{paymentKey}/refunds
td
Refund a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
deletePayment
td
strong
DELETE
 /v1/payments/{paymentKey}
td
Delete a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getPayment
td
strong
GET
 /v1/payments/{paymentKey}
td
Retrieve a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getPaymentItemPart
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}/item-parts/{itemPartId}
td
Retrieve a payment part item
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getPaymentItemParts
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}/item-parts
td
List all payment part items
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getPaymentPart
td
strong
GET
 /v1/payments/{paymentKey}/parts/{partId}
td
Retrieve a payment part
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getPaymentParts
td
strong
GET
 /v1/payments/{paymentKey}/parts
td
List all parts of a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
getRetrieveAllPayments
td
strong
GET
 /v1/payments
td
List payments
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
refundPaymentwithAutoUnapply
td
strong
POST
 /v1/payments/{paymentKey}/refunds/unapply
td
Refund a payment with auto-unapplying
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
transferPayment
td
strong
PUT
 /v1/payments/{paymentKey}/transfer
td
Transfer a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
unapplyPayment
td
strong
PUT
 /v1/payments/{paymentKey}/unapply
td
Unapply a payment
tr
td
em
ZuoraSdkJs.PaymentsApi
td
strong
updatePayment
td
strong
PUT
 /v1/payments/{paymentId}
td
Update a payment
tr
td
em
ZuoraSdkJs.ProductRatePlanChargeTiersApi
td
strong
getProductRatePlanChargeTier
td
strong
GET
 /v1/object/product-rate-plan-charge-tier/{id}
td
CRUD: Retrieve a product rate plan charge tier
tr
td
em
ZuoraSdkJs.ProductRatePlanChargeTiersApi
td
strong
updateProductRatePlanChargeTier
td
strong
PUT
 /v1/object/product-rate-plan-charge-tier/{id}
td
CRUD: Update a product rate plan charge tier
tr
td
em
ZuoraSdkJs.ProductRatePlanChargesApi
td
strong
createProductRatePlanCharge
td
strong
POST
 /v1/object/product-rate-plan-charge
td
CRUD: Create a product rate plan charge
tr
td
em
ZuoraSdkJs.ProductRatePlanChargesApi
td
strong
deleteProductRatePlanCharge
td
strong
DELETE
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Delete a product rate plan charge
tr
td
em
ZuoraSdkJs.ProductRatePlanChargesApi
td
strong
getProductRatePlanCharge
td
strong
GET
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Retrieve a product rate plan charge
tr
td
em
ZuoraSdkJs.ProductRatePlanChargesApi
td
strong
updateProductRatePlanCharge
td
strong
PUT
 /v1/object/product-rate-plan-charge/{id}
td
CRUD: Update a product rate plan charge
tr
td
em
ZuoraSdkJs.ProductRatePlanChargesApi
td
strong
updateProductRatePlanChargeFinanceInformation
td
strong
PUT
 /v1/product-rate-plan-charges/{product-rate-plan-charge-key}/finance-information
td
Update a Zuora Revenue accounting code
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
createProductRatePlan
td
strong
POST
 /v1/object/product-rate-plan
td
CRUD: Create a product rate plan
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
deleteProductRatePlan
td
strong
DELETE
 /v1/object/product-rate-plan/{id}
td
CRUD: Delete a product rate plan
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
getProductRatePlan
td
strong
GET
 /v1/product-rate-plans/{id}
td
Retrieve a product rate plan by ID
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
getProductRatePlansByExternalID
td
strong
GET
 /v1/product-rate-plans/external-id/{externalId}
td
List product rate plans by external ID
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
getRatePlansByProduct
td
strong
GET
 /v1/rateplan/{product-key}/productRatePlan
td
List all product rate plans of a product
tr
td
em
ZuoraSdkJs.ProductRatePlansApi
td
strong
updateProductRatePlan
td
strong
PUT
 /v1/object/product-rate-plan/{id}
td
CRUD: Update a product rate plan
tr
td
em
ZuoraSdkJs.ProductsApi
td
strong
createProduct
td
strong
POST
 /v1/object/product
td
Create a product
tr
td
em
ZuoraSdkJs.ProductsApi
td
strong
deleteProduct
td
strong
DELETE
 /v1/object/product/{id}
td
CRUD: Delete a product
tr
td
em
ZuoraSdkJs.ProductsApi
td
strong
getProduct
td
strong
GET
 /v1/catalog/product/{product-key}
td
Retrieve a product
tr
td
em
ZuoraSdkJs.ProductsApi
td
strong
getProducts
td
strong
GET
 /v1/catalog/products
td
Get all products
tr
td
em
ZuoraSdkJs.ProductsApi
td
strong
updateProduct
td
strong
PUT
 /v1/object/product/{id}
td
CRUD: Update a product
tr
td
em
ZuoraSdkJs.RSASignaturesApi
td
strong
createRSASignature
td
strong
POST
 /v1/rsa-signatures
td
Generate an RSA signature
tr
td
em
ZuoraSdkJs.RSASignaturesApi
td
strong
decryptRSASignature
td
strong
POST
 /v1/rsa-signatures/decrypt
td
Decrypt an RSA signature
tr
td
em
ZuoraSdkJs.RampsApi
td
strong
getRampByNumber
td
strong
GET
 /v1/ramps/{rampNumber}
td
Retrieve a ramp
tr
td
em
ZuoraSdkJs.RampsApi
td
strong
getRampMetricsByNumber
td
strong
GET
 /v1/ramps/{rampNumber}/ramp-metrics
td
List all ramp metrics of a ramp
tr
td
em
ZuoraSdkJs.RampsApi
td
strong
getRampMetricsByOrderNumber
td
strong
GET
 /v1/orders/{orderNumber}/ramp-metrics
td
List ramp metrics by order number
tr
td
em
ZuoraSdkJs.RampsApi
td
strong
getRampMetricsBySubscriptionKey
td
strong
GET
 /v1/subscriptions/{subscriptionKey}/ramp-metrics
td
List ramp metrics by subscription key
tr
td
em
ZuoraSdkJs.RampsApi
td
strong
getRampsBySubscriptionKey
td
strong
GET
 /v1/subscriptions/{subscriptionKey}/ramps
td
Retrieve a ramp by subscription key
tr
td
em
ZuoraSdkJs.RatePlansApi
td
strong
getRatePlan
td
strong
GET
 /v1/rateplans/{ratePlanId}
td
Retrieve a rate plan
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
cancelRefund
td
strong
PUT
 /v1/refunds/{refundKey}/cancel
td
Cancel a refund
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
deleteRefund
td
strong
DELETE
 /v1/refunds/{refundKey}
td
Delete a refund
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefund
td
strong
GET
 /v1/refunds/{refundKey}
td
Retrieve a refund
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefundItemPart
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}/item-parts/{itemPartId}
td
Retrieve a refund part item
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefundItemParts
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}/item-parts
td
List all refund part items
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefundPart
td
strong
GET
 /v1/refunds/{refundKey}/parts/{refundPartId}
td
Retrieve a refund part
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefundParts
td
strong
GET
 /v1/refunds/{refundKey}/parts
td
List all parts of a refund
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
getRefunds
td
strong
GET
 /v1/refunds
td
List refunds
tr
td
em
ZuoraSdkJs.RefundsApi
td
strong
updateRefund
td
strong
PUT
 /v1/refunds/{refundId}
td
Update a refund
tr
td
em
ZuoraSdkJs.RegenerateApi
td
strong
pOSTCreateRevRecEvents
td
strong
POST
 /v1/uno-regenerate/rev-rec-events
td
Regenerate Rev Rec Event
tr
td
em
ZuoraSdkJs.RegenerateApi
td
strong
pOSTGenerateRevRecEventsForDailyConsumption
td
strong
POST
 /v1/uno-regenerate/rev-rec-events/daily-consumption
td
Regenerate Rev Rec Event
tr
td
em
ZuoraSdkJs.RegenerateApi
td
strong
pOSTRegenerateBillingTransaction
td
strong
POST
 /v1/uno-regenerate/billing-transaction
td
Regenerate Billing Transaction
tr
td
em
ZuoraSdkJs.RegenerateApi
td
strong
pOSTRegenerateBookingTransaction
td
strong
POST
 /v1/uno-regenerate/booking-transaction
td
Regenerate Booking Transaction
tr
td
em
ZuoraSdkJs.RevenueAccountingCodesApi
td
strong
putRevProAccountingCodes
td
strong
PUT
 /v1/revpro-accounting-codes
td
Update a Zuora Revenue accounting code
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
describeViewColumns
td
strong
GET
 /integration/v2/biviews/{view_name}/describe-columns
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
downloadReport
td
strong
GET
 /integration/v1/reports/download/{filename}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
generateJWTToken
td
strong
POST
 /integration/v1/authenticate
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getBIViewCount
td
strong
GET
 /integration/v2/biviews/count/{view_name}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getBIViewStatus
td
strong
GET
 /integration/v2/biviews-status
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getBIViewTaskDetails
td
strong
GET
 /integration/v2/biviews-status/{task_id}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getBIViews
td
strong
GET
 /integration/v1/biviews/{view_name}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getBIViewsV2
td
strong
GET
 /integration/v2/biviews/{view_name}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getCsvUploadStatus
td
strong
GET
 /integration/v1/csv/upload/status
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getFileUploadStatusByRequestId
td
strong
GET
 /integration/v1/fileupload/status/{file_request_id}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getReportsById
td
strong
GET
 /integration/v1/reports/{report_id}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
getStageError
td
strong
GET
 /integration/v1/stage/error/{errortype}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
integrationV2ReportsSignedurlReportIdGet
td
strong
GET
 /integration/v2/reports/signedurl/{report_id}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
listReports
td
strong
GET
 /integration/v1/reports/list
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
selectBIView
td
strong
POST
 /integration/v1/biviews/{view_name}
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
uploadCsv
td
strong
POST
 /integration/v1/csv/upload
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
uploadFile
td
strong
POST
 /integration/v1/upload/file
td
tr
td
em
ZuoraSdkJs.RevenueIntegrationApi
td
strong
uploadMapping
td
strong
POST
 /integration/v1/upload/mapping
td
tr
td
em
ZuoraSdkJs.SequenceSetsApi
td
strong
createSequenceSets
td
strong
POST
 /v1/sequence-sets
td
Create sequence sets
tr
td
em
ZuoraSdkJs.SequenceSetsApi
td
strong
deleteSequenceSet
td
strong
DELETE
 /v1/sequence-sets/{id}
td
Delete a sequence set
tr
td
em
ZuoraSdkJs.SequenceSetsApi
td
strong
getSequenceSet
td
strong
GET
 /v1/sequence-sets/{id}
td
Retrieve a sequence set
tr
td
em
ZuoraSdkJs.SequenceSetsApi
td
strong
getSequenceSets
td
strong
GET
 /v1/sequence-sets
td
List sequence sets
tr
td
em
ZuoraSdkJs.SequenceSetsApi
td
strong
updateSequenceSet
td
strong
PUT
 /v1/sequence-sets/{id}
td
Update a sequence set
tr
td
em
ZuoraSdkJs.SettingsApi
td
strong
getListAllSettings
td
strong
GET
 /settings/listing
td
List all settings
tr
td
em
ZuoraSdkJs.SettingsApi
td
strong
postProcessSettingsBatchRequest
td
strong
POST
 /settings/batch-requests
td
Submit settings requests
tr
td
em
ZuoraSdkJs.SignUpApi
td
strong
postSignUp
td
strong
POST
 /v1/sign-up
td
Sign up
tr
td
em
ZuoraSdkJs.SubscriptionChangeLogsApi
td
strong
getSubscriptionChangeLogsByOrderNumber
td
strong
GET
 /subscription-change-logs/orders/{orderNumber}
td
Retrieve change logs for a subscription
tr
td
em
ZuoraSdkJs.SubscriptionChangeLogsApi
td
strong
getSubscriptionChangeLogsBySubscriptionNumber
td
strong
GET
 /subscription-change-logs/{subscriptionNumber}
td
Retrieve change logs for a subscription
tr
td
em
ZuoraSdkJs.SubscriptionChangeLogsApi
td
strong
getSubscriptionChangeLogsBySubscriptionNumberAndVersion
td
strong
GET
 /subscription-change-logs/{subscriptionNumber}/versions/{version}
td
Retrieve change logs for a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
cancelSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/cancel
td
Cancel a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
createSubscription
td
strong
POST
 /v1/subscriptions
td
Create a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
deleteSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/delete
td
Delete a subscription by number
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
getMetricsBySubscriptionNumbers
td
strong
GET
 /v1/subscriptions/subscription-metrics
td
List subscriptions metrics by subscription numbers
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
getSubscriptionByKey
td
strong
GET
 /v1/subscriptions/{subscription-key}
td
Retrieve a subscription by key
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
getSubscriptionByKeyAndVersion
td
strong
GET
 /v1/subscriptions/{subscription-key}/versions/{version}
td
Retrieve a subscription by key and version
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
getSubscriptionsByAccount
td
strong
GET
 /v1/subscriptions/accounts/{account-key}
td
List subscriptions by account key
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
previewExistingSubscription
td
strong
POST
 /v1/subscriptions/{subscription-key}/preview
td
Preview a subscription by key
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
previewSubscription
td
strong
POST
 /v1/subscriptions/preview
td
Preview a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
renewSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/renew
td
Renew a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
resumeSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/resume
td
Resume a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
suspendSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}/suspend
td
Suspend a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
updateSubscription
td
strong
PUT
 /v1/subscriptions/{subscription-key}
td
Update a subscription
tr
td
em
ZuoraSdkJs.SubscriptionsApi
td
strong
updateSubscriptionCustomFieldsOfASpecifiedVersion
td
strong
PUT
 /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields
td
Update subscription custom fields of a subscription version
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
cancelSummaryJournalEntry
td
strong
PUT
 /v1/journal-entries/{je-number}/cancel
td
Cancel a summary journal entry
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
createSummaryJournalEntry
td
strong
POST
 /v1/journal-entries
td
Create a summary journal entry
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
deleteSummaryJournalEntry
td
strong
DELETE
 /v1/journal-entries/{je-number}
td
Delete a summary journal entry
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
getAllSummaryJournalEntries
td
strong
GET
 /v1/journal-entries/journal-runs/{jr-number}
td
List all summary journal entries in a journal run
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
getSummaryJournalEntry
td
strong
GET
 /v1/journal-entries/{je-number}
td
Retrieve a summary journal entry
tr
td
em
ZuoraSdkJs.SummaryJournalEntriesApi
td
strong
updateBasicSummaryJournalEntry
td
strong
PUT
 /v1/journal-entries/{je-number}/basic-information
td
Update a summary journal entry
tr
td
em
ZuoraSdkJs.TaxationItemsApi
td
strong
createTaxationItem
td
strong
POST
 /v1/object/taxation-item
td
CRUD: Create a taxation item
tr
td
em
ZuoraSdkJs.TaxationItemsApi
td
strong
deleteTaxationItem
td
strong
DELETE
 /v1/taxation-items/{id}
td
Delete a taxation item
tr
td
em
ZuoraSdkJs.TaxationItemsApi
td
strong
getTaxationItem
td
strong
GET
 /v1/taxation-items/{id}
td
Retrieve a taxation item 
tr
td
em
ZuoraSdkJs.TaxationItemsApi
td
strong
putTaxationItem
td
strong
PUT
 /v1/taxation-items/{id}
td
Update a taxation item
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
createUsage
td
strong
POST
 /v1/object/usage
td
CRUD: Create a usage record
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
deleteUsage
td
strong
DELETE
 /v1/object/usage/{id}
td
CRUD: Delete a usage record
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
getUsage
td
strong
GET
 /v1/object/usage/{id}
td
CRUD: Retrieve a usage record
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
getUsageRateDetailByInvoiceItem
td
strong
GET
 /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail
td
Retrieve usage rate detail for an invoice item
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
getUsagesByAccount
td
strong
GET
 /v1/usage/accounts/{account-key}
td
Retrieve usage records by account
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
updateUsage
td
strong
PUT
 /v1/object/usage/{id}
td
CRUD: Update a usage record
tr
td
em
ZuoraSdkJs.UsageApi
td
strong
uploadUsageFile
td
strong
POST
 /v1/usage
td
Upload a usage file
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
deleteWorkflow
td
strong
DELETE
 /workflows/{workflow_id}
td
Delete a workflow
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
deleteWorkflowVersion
td
strong
DELETE
 /workflows/versions/{version_id}
td
Delete a workflow version
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflow
td
strong
GET
 /workflows/{workflow_id}
td
Retrieve a workflow
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowExport
td
strong
GET
 /workflows/{workflow_id}/export
td
Export a workflow version
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowRun
td
strong
GET
 /workflows/workflow_runs/{workflow_run_id}
td
Retrieve a workflow run
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowVersions
td
strong
GET
 /workflows/{workflow_id}/versions
td
List all versions of a workflow definition
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflows
td
strong
GET
 /workflows
td
List workflows
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowsTask
td
strong
GET
 /workflows/tasks/{task_id}
td
Retrieve a workflow task
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowsTasks
td
strong
GET
 /workflows/tasks
td
List workflow tasks
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
getWorkflowsUsages
td
strong
GET
 /workflows/metrics.json
td
Retrieve workflow task usage
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
pATCHUpdateWorkflow
td
strong
PATCH
 /workflows/{workflow_id}
td
Update a workflow
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
postRunWorkflow
td
strong
POST
 /workflows/{workflow_id}/run
td
Run a workflow
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
postWorkflowImport
td
strong
POST
 /workflows/import
td
Import a workflow
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
postWorkflowVersionsImport
td
strong
POST
 /workflows/{workflow_id}/versions/import
td
Import a workflow version
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
postWorkflowsTaskRerun
td
strong
POST
 /workflows/tasks/{task_id}/rerun
td
Rerun a workflow task
tr
td
em
ZuoraSdkJs.WorkflowsApi
td
strong
putWorkflowsTasksUpdate
td
strong
PUT
 /workflows/tasks/batch_update
td
Update workflow tasks